Appearance

Get Payments ​

Endpoint ​

http
GET /unified/accounting/payments/{id}
Integrations supported
  • QuickBooks
  • Xero

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
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
payment_for
string

What entity is the payment for

All possible enum values:
  • bill
  • invoice
Required in
  • QuickBooks

Response Body ​

id
string
REQUIRED · 

The unique identifier for payments

Supported in
  • QuickBooks
  • Xero
payment_for
string

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

All possible enum values:
  • invoice
  • bill
Supported in
  • QuickBooks
  • Xero
status
string

The status of the payment.

transaction_date
string · date-time

The transaction date of the payment

Supported in
  • QuickBooks
  • Xero
contact
object

The contact of the payment

Supported in
  • QuickBooks
  • Xero
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

Supported in
  • QuickBooks
  • Xero
invoice
object

The invoice associated with the payment

Supported in
  • 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
  • QuickBooks
  • Xero
exchange_rate
number

The exchange rate of the payment

Supported in
  • Xero
company
string

The ID of the company the payment belongs to

total_amount
number

The total amount of the payment

Supported in
  • QuickBooks
  • Xero
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
remote_data
object

Raw data returned from the remote API call.