Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Invoice Payments

List Invoice Payments

Supported for:

freshbooks quickbooks quickbooksDesktop xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral dynamics365Finance myob zohoBooks

get/v2/accounting/invoices/payments

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

Response

Example response

{
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "id": "1",
      "customerRef": {
        "id": "1",
        "name": "Railz Financial"
      },
      "accountRef": {
        "id": "145",
        "name": "Example account"
      },
      "currencyRate": 1.13,
      "memo": "Invoice payment memo.",
      "subsidiaryRefs": [
        {
          "id": "1",
          "name": "Railz Financial"
        }
      ],
      "sourceModifiedDate": "2021-03-10T11:17:23.155Z",
      "date": "2021-03-10T11:17:23.155Z",
      "totalAmount": 200.5,
      "currency": "USD",
      "paymentMethod": "creditCard",
      "paymentMethodRef": {
        "id": "3",
        "name": "Harmonized sales tax",
        "type": "creditCard"
      },
      "lines": [
        {
          "allocatedOnDate": "2021-03-09T10:57:54.294Z",
          "amount": 200.5,
          "links": [
            {
              "id": "50"
            }
          ]
        }
      ]
    }
  ]
}