Skip to content

Payments Object



id
string
REQUIRED · 

The unique identifier for payments

payment_for
string

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

All possible enum values:
  • invoice
  • bill
status
string

The status of the payment.

transaction_date
string · date-time

The transaction date of the payment

contact
object

The contact of the payment

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

invoice
object

The invoice associated with the payment

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

exchange_rate
number

The exchange rate of the payment

company
string

The ID of the company the payment belongs to

total_amount
number

The total amount of the payment

created_at
string · date-time

This represents the date when the payment was created

updated_at
string · date-time

This represents the date when the payment was updated

remote_data
object

Raw data returned from the remote API call.