latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Bill Payment Requests

List Bill Payment Requests

Supported for:

sageIntacct

get/v2/accounting/bills/paymentRequests

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": {
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "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",
      "batchId": "1",
      "vendorRef": {
        "id": "1",
        "name": "Home Depot"
      },
      "bankAccountRef": {
        "id": "145",
        "name": "Example account"
      },
      "paymentNumber": "1",
      "paymentCode": "1",
      "paymentDate": "2021-03-09T10:18:29.985Z",
      "postedDate": "2021-03-09T10:18:29.985Z",
      "currency": "1",
      "paymentAmount": 301.5,
      "totalAmount": 20.5,
      "totalPaid": 322,
      "amountDue": 322,
      "state": "approved",
      "links": [
        {
          "id": "123"
        }
      ],
      "paymentMethodRef": {
        "id": "1",
        "name": "Harmonized sales tax",
        "type": "creditCard"
      },
      "memo": "Example bill memo.",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}