Appearance

Create Payments ​

Endpoint ​

http
POST /unified/accounting/payments
Integrations supported
  • QuickBooks
  • Xero

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

Request Body ​

Refer Writing data using Unified APIs

contact
object
The contact of the payment
Required 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
total_amount
number
The total amount of the payment
Required in
  • QuickBooks
Supported in
  • Xero
pay_type
string
For Quickbooks. The type of the payment. You can find it in "Account" resource
All possible enum values:
  • Check
  • CreditCard
Enum support by integration
  • QuickBooks
    • Check
    • CreditCard
Supported in
  • QuickBooks
currency
string
The currency of the payment
Required in
  • QuickBooks
account
string
The ID of the account for the payment
Supported in
  • QuickBooks
  • Xero
invoice
object
The invoice associated with the payment
Required in
  • QuickBooks
Supported in
  • Xero
id
string
The ID of the invoice
type
string
The type of the invoice
All possible enum values:
  • invoice
  • bill
created_at
string
This represents the date when the payment was created
Supported in
  • Xero
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

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.