v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

BillPayment

Retrieves the collection of BillPayment resources.

get/bill_payments

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

BillPayment collection

idstring

integrationstring

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

srcIdstring

the unique identifier of the source 3rd party integration e.g. "460000000053219"

billIdstring

The source ID of the bill being paid

vendorPaymentIdstring nullable

The Boss Insights identifier for the Vendor Payment that this Bill Payment belongs to (if it belongs to one) Note that no particular pattern in this field is guaranteed, only that this field is unique

vendorIdstring nullable

Unique identifier for the vendor of the bill e.g. "460000000026049"

vendorNamestring nullable

Name of the vendor of the bill e.g. "Bowman and Co"

paymentModestring nullable

Mode of payment e.g. "Stripe"

txnDatestring date-time nullable

Date the payment is made e.g. "2013-10-07"

referenceNumberstring nullable

Reference number for the payment recorded e.g. REF#912300

amountinteger

Total amount of the payment in cents e.g. 12500

currencystring nullable

Currency code e.g. "USD"

createdstring date-time nullable

Creation time of the payment e.g. 2016-12-16T00:18:42-0500

modifiedstring date-time nullable

Last modified time of the payment e.g. 2016-12-16T00:18:42-0500

Example response

[
  {
    "id": "quickbooks-321",
    "integration": "quickbooks",
    "srcId": "460000000053219",
    "billId": "34",
    "vendorPaymentId": "quickbooks-34",
    "vendorId": "460000000026049",
    "vendorName": "Bowman and Co",
    "paymentMode": "Stripe",
    "txnDate": "2013-10-07",
    "referenceNumber": "REF#912300",
    "amount": 12500,
    "currency": "USD",
    "created": "2016-12-16T00:18:42-0500",
    "modified": "2016-12-16T00:18:42-0500"
  }
]