Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Invoice Credit Notes

List Invoice Credit Notes

Supported for:

freshbooks quickbooks quickbooksDesktop xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral zohoBooks

get/v2/accounting/invoices/creditNotes

Query parameters

connectionUuidstring required

Unique connection identifier.

startDatestring

Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.

endDatestring

Transaction date less than or equal to parameter in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

This is the size of the results set you would like (default: 100).

orderBystring
totalAmountnumber float

Total amount of a credit note.

remainingCreditnumber float

Remaining credit on a credit note.

status'open' | 'paid' | 'partiallyPaid' | 'void' | 'unknown' | 'draft'

Response

Example response

{
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "passThrough": {
        "CustomField": [
          {
            "DefinitionId": "1",
            "StringValue": "my custom value",
            "Name": "Field One"
          }
        ]
      },
      "id": "1",
      "postedDate": "2021-03-09T10:18:29.985Z",
      "allocatedOnDate": "2021-03-09T10:18:29.985Z",
      "currency": "USD",
      "currencyRate": 1.13,
      "totalDiscount": 322,
      "discountPercentage": 322,
      "subTotal": 301.5,
      "taxAmount": 20.5,
      "totalAmount": 322,
      "remainingCredit": 322,
      "memo": "Example bill memo.",
      "payments": [
        {
          "amount": 50.5,
          "paymentId": "50",
          "date": "2021-03-09T10:18:29.985Z"
        }
      ],
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "locationRef": {
        "id": "52",
        "name": "United States"
      },
      "customerRef": {
        "id": "1",
        "name": "Railz Financial"
      },
      "subsidiaryRefs": [
        {
          "id": "1",
          "name": "Railz Financial"
        }
      ],
      "lines": [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "taxAmount": 20.5,
          "taxRateRef": {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "inventoryRef": {
            "id": "1",
            "name": "Digital Services"
          },
          "discountPercentage": 10.5,
          "accountRef": {
            "id": "145",
            "name": "Example account"
          },
          "amount": 10.5,
          "trackingCategoryRefs": [
            {
              "id": "4040",
              "name": "Region",
              "type": "class"
            }
          ]
        }
      ]
    }
  ]
}