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 ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
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
This represents the date when the payment was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the payment was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.