Appearance

List Payments ​

Endpoint ​

http
GET /unified/accounting/payments
Integrations supported
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Zoho Books

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
contact
object

The contact of the payment

Supported in
  • QuickBooks
id
string

The ID of the contact

type
string

The type of the contact. Can be customer or vendor.

All possible enum values:
  • customer
  • vendor
payment_for
string

What entity was the payment for. Can be invoice or bill.

Integration specific notes
  • QuickBooksThe type of payment
  • Microsoft Dynamics 365 Business CentralWhat entity was the payment for.
  • Zoho BooksWhat entity was the payment for.
All possible enum values:
  • bill
  • invoice
Required in
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Zoho Books
created_at
string · date-time

This represents the date when the payment was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the payment was updated

Supported in
  • QuickBooks
  • Xero
  • Zoho Books
sort_by
string

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • total_amount
  • transaction_date
Supported in
  • Zoho Books

Response Body ​

result
object[]

List of Payments

id
string
REQUIRED · 

The unique identifier for payments

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
payment_for
string

What entity was the payment for. Can be invoice or bill.

References: Invoices → id
All possible enum values:
  • invoice
  • bill
Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
status
string

The status of the payment.

Supported in
  • Brightpearl
  • Sage Intacct
  • Zoho Books
transaction_date
string · date-time

The transaction date of the payment

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
contact
object

The contact of the payment

References: Contacts → id
Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
id
string

The ID of the contact

type
string

The type of the contact. Can be customer or vendor.

All possible enum values:
  • customer
  • vendor
account
string

The ID of the account for the payment

References: Accounts → id
Supported in
  • Brightpearl
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
invoice
object

The invoice associated with the payment

References: Invoices → id
Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Xero
id
string

The ID of the invoice

type
string

The type of the invoice

All possible enum values:
  • invoice
  • bill
currency
string

The currency of the payment

Supported in
  • Brightpearl
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
exchange_rate
number

The exchange rate of the payment

Supported in
  • Brightpearl
  • Xero
  • Zoho Books
company
string

The ID of the company the payment belongs to

References: CompanyInfo → id
Supported in
  • Brightpearl
  • Zoho Books
total_amount
number

The total amount of the payment

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
created_at
string · date-time

This represents the date when the payment was created

Supported in
  • Brightpearl
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
updated_at
string · date-time

This represents the date when the payment was updated

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
  • Zoho Books
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.