Common ModelsPayments

The Payment object

The Payment object represents general payments made towards a specific transaction.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or nullOptional
The payment's transaction date.
contactstring or nullOptionalformat: "uuid"
The supplier, or customer involved in the payment.
accountstring or nullOptionalformat: "uuid"

The supplier’s or customer’s account in which the payment is made.

payment_methodstring or nullOptionalformat: "uuid"
The method which this payment was made by.
currencyenum or nullOptional
The payment's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The payment's exchange rate.
companystring or nullOptionalformat: "uuid"
The company the payment belongs to.
total_amountdouble or nullOptional
The total amount of money being paid to the supplier, or customer, after taxes.
typeenum or nullOptional

The type of the invoice.

  • ACCOUNTS_PAYABLE - ACCOUNTS_PAYABLE
  • ACCOUNTS_RECEIVABLE - ACCOUNTS_RECEIVABLE
Allowed values:
tracking_categorieslist of stringsOptional
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the Payment was generated in.
applied_to_lineslist of objectsOptional

A list of “Payment Applied to Lines” objects.

remote_updated_atdatetime or nullOptional
When the third party's payment entry was updated.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only