Finance

Create a Credit note

Creates a new Credit note.

post/admin/finance/credit-notes

Request

Base URL: https://demo.splynx.com/api/2.0
URL: https://demo.splynx.com/api/2.0/admin/finance/credit-notes
Auth: HTTP basic

Request body

customer_idnumber required

Customer ID

date_createdstring

Create date. Format: YYYY-MM-DD

date_updatedstring

Update date. Format: YYYY-MM-DD

date_paymentstring

Payment date. Format: YYYY-MM-DD

statusstring required

Status. Values: 'not_refunded' for "Not refunded", 'refunded' for "Refunded" and 'deleted' for "Deleted"

numberstring required

Number

payment_idnumber

Payment ID.

resetPeriodForServiceboolean

Resets the 'invoiced until' date on an invoice item. Default: false

notestring

Note

is_sent'0' | '1'

Is sent

Example request

{
  "customer_id": 1,
  "date_created": "2016-01-01",
  "status": "not_refunded",
  "number": "201601010003",
  "resetPeriodForService": true,
  "is_sent": "0",
  "items": [
    {
      "description": "Desc of item",
      "quantity": 1,
      "price": 123
    }
  ]
}

Response

idnumber

Credit note ID

Example response

{
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.