v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

CreditNote

Retrieves the collection of CreditNote resources.

get/credit_notes

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

CreditNote collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring nullable

Unique identifier of the source 3rd party integration

creditnoteNumberstring nullable

Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29

datestring nullable

The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05"

statusstring nullable

Status of the credit note. This can be open, closed or void eg. "open"

customerIdstring nullable

Customer ID of the customer for whom the credit note is raised eg. 903000000000099

customerNamestring nullable

Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture"

referenceNumberstring nullable

Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384"

totalAmountstring nullable

Total of credit note eg. "400"

balanceinteger nullable

Unapplied credits eg. 10

currencystring nullable

Customers currency code eg. "USD"

notesstring nullable

Notes on the credit notes eg. "Offer for the referral"

createdstring date-time nullable

Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"

modifiedstring date-time nullable

Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z"

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcId": "90300000072369",
    "creditnoteNumber": "CN-29",
    "date": "2016-06-05",
    "status": "open",
    "customerId": "903000000000099",
    "customerName": "Bowman Furniture",
    "referenceNumber": "INV-384",
    "totalAmount": "400",
    "balance": 10,
    "currency": "USD",
    "notes": "Offer for the referral",
    "created": "2013-11-18T02:17:40.080Z",
    "modified": "2013-11-18T02:17:40.080Z"
  }
]