v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
payment
payment

List all payments

get/payment/{connection_id}/payment

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

invoice_idstring

The invoice ID to filter by (reference to AccountingInvoice)

contact_idstring

The contact ID to filter by (reference to AccountingContact)

link_idstring

The link ID to filter by

bill_idstring

The bill ID to filter by

typestring

The type to filter by

org_idstring

The org ID to filter by (reference to AccountingOrganization)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
total_amountnumber
contact_idstring
payment_methodstring
type'INVOICE' | 'BILL'
currencystring
notesstring
invoice_idstring
bill_idstring
link_idstring
account_idstring
referencestring
organization_idstring
rawobject