v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Payment

Retrieves the collection of Payment resources.

get/payments

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Payment collection

idstring

integrationstring

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

srcIdstring

The unique identifier of the source 3rd party integration

paymentDatestring date-time

Date of the payment

totalAmountstring nullable

Total amount listed in the payment in cents

statusstring nullable

Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED

modifiedstring date-time nullable

Date entry was last modified

accountIdstring nullable

Account Id the payment was made from

customerIdstring nullable

Customer Id

customerNamestring nullable

Customer name

linkedTxnIdstring nullable

Transaction Id

linkedTxnTypestring nullable

Transaction type e.g. Deposit, Invoice

createdstring date-time nullable

Date entry was created

invoiceIdstring nullable

Invoice Id

currencyCodestring nullable

Currency code

paymentTypestring nullable

Payment type e.g. CreditCard

Example response

[
  {
    "id": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
    "integration": "quickbooks",
    "srcId": "706f68c5-46b2-43d8-9aa8-41d1cc2a317f",
    "paymentDate": "2020-10-22T19:30:17.697Z",
    "totalAmount": "8750",
    "status": "PAID",
    "modified": "2020-10-09T14:52:50.550Z",
    "accountId": "562555f2-8cde-4ce9-8203-0363922537a4",
    "customerId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
    "customerName": "Gateway Motors",
    "linkedTxnId": "361a4980-7f53-4b68-820c-f6487f613284",
    "linkedTxnType": "Deposit",
    "created": "2021-10-22T19:30:17.697Z",
    "invoiceId": "129",
    "currencyCode": "USD",
    "paymentType": "PayPal"
  }
]