Skip to content

Payments Object

Relationships

Schema relationships 
graph LR
    Payments -->|"payment_for"| Invoices
    Payments -->|"contact"| Contacts
    Payments -->|"account"| Accounts
    Payments -->|"invoice"| Invoices
    Payments -->|"company"| CompanyInfo

Properties

idstring
required·

The unique identifier for payments

accountstring

The ID of the account for the payment

References: Accounts → id
companystring

The ID of the company the payment belongs to

References: CompanyInfo → id
contactobject

The contact of the payment

References: Contacts → id
idstring

The ID of the contact

typestring

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

Possible values:
customervendor
created_atstring · date-time

This represents the date when the payment was created

currencystring

The currency of the payment

exchange_ratenumber

The exchange rate of the payment

invoiceobject

The invoice associated with the payment

References: Invoices → id
idstring

The ID of the invoice

typestring

The type of the invoice

Possible values:
invoicebill
payment_forstring

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

References: Invoices → id
Possible values:
invoicebill
remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the payment.

total_amountnumber

The total amount of the payment

transaction_datestring · date-time

The transaction date of the payment

updated_atstring · date-time

This represents the date when the payment was updated