For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The CreditNote object
          • GET/credit-notes
          • POST/credit-notes
          • GET/credit-notes/{id}
          • PATCH/credit-notes/{id}
          • POST/credit-notes/{id}/application
          • GET/credit-notes/meta/patch/{id}
          • GET/credit-notes/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsCredit Notes

The CreditNote object

The CreditNote Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "transaction_date": "2023-01-01T00:00:00Z",
7  "status": "SUBMITTED",
8  "number": "string",
9  "contact": "string",
10  "company": "string",
11  "exchange_rate": "string",
12  "total_amount": 1,
13  "remaining_credit": 1,
14  "inclusive_of_tax": true,
15  "line_items": [
16    {
17      "id": "string",
18      "remote_id": "string",
19      "created_at": "2023-01-01T00:00:00Z",
20      "modified_at": "2023-01-01T00:00:00Z",
21      "item": "string",
22      "name": "string",
23      "description": "string",
24      "quantity": "string",
25      "memo": "string",
26      "unit_price": "string",
27      "tax_rate": "string",
28      "total_line_amount": "string",
29      "tracking_category": "string",
30      "tracking_categories": [
31        "string"
32      ],
33      "account": "string",
34      "company": "string",
35      "contact": "string",
36      "project": "string",
37      "remote_was_deleted": true
38    }
39  ],
40  "tracking_categories": [
41    "string"
42  ],
43  "currency": "XUA",
44  "remote_created_at": "2023-01-01T00:00:00Z",
45  "remote_updated_at": "2023-01-01T00:00:00Z",
46  "payments": [
47    "string"
48  ],
49  "applied_payments": [
50    "string"
51  ],
52  "accounting_period": "string",
53  "applied_to_lines": [
54    {
55      "remote_id": "string",
56      "created_at": "2023-01-01T00:00:00Z",
57      "modified_at": "2023-01-01T00:00:00Z",
58      "invoice": "string",
59      "applied_date": "2023-01-01T00:00:00Z",
60      "applied_amount": "string",
61      "remote_was_deleted": true
62    }
63  ],
64  "remote_was_deleted": true,
65  "field_mappings": {},
66  "remote_data": [
67    {
68      "path": "string",
69      "data": {}
70    }
71  ]
72}
Was this page helpful?
Previous

/contacts/remote-field-classes

Next

/credit-notes

Built with

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