Common ModelsCredit Notes

The CreditNote object

A CreditNote is transaction issued to a customer, indicating a reduction or cancellation of the amount owed by the customer. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a sales transaction. A CreditNote can be applied to Accounts Receivable Invoices to decrease the overall amount of the Invoice.

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 credit note's transaction date.
statusenum or nullOptional

The credit note’s status.

  • SUBMITTED - SUBMITTED
  • AUTHORIZED - AUTHORIZED
  • PAID - PAID
Allowed values:
numberstring or nullOptional
The credit note's number.
contactstring or nullOptionalformat: "uuid"
The credit note's contact.
companystring or nullOptionalformat: "uuid"
The company the credit note belongs to.
exchange_ratestring or nullOptionalformat: "decimal"
The credit note's exchange rate.
total_amountdouble or nullOptional
The credit note's total amount.
remaining_creditdouble or nullOptional
The amount of value remaining in the credit note that the customer can use.
inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

line_itemslist of objectsOptionalRead-only
tracking_categorieslist of stringsOptional
currencyenum or nullOptional
The credit note's currency. The currency code in ISO 4217 format.
remote_created_atdatetime or nullOptional
When the third party's credit note was created.
remote_updated_atdatetime or nullOptional
When the third party's credit note was updated.
paymentslist of stringsOptional

Array of Payment object IDs

applied_paymentslist of stringsOptional
A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the CreditNote was generated in.
applied_to_lineslist of objectsOptional
A list of the CreditNote Applied to Lines common models related to a given Credit Note
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