Common ModelsCredit Notes

/credit-notes/{id}/application

Creates a new CreditNoteApplyLine to apply a credit note to an invoice

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.
invoicestring or nullRequiredformat: "uuid"
The invoice to apply the credit note to.
applied_datedatetimeRequired
Date that the credit note is applied to the invoice.
applied_amountstringRequiredformat: "decimal"
The amount of credit applied to the invoice.

Response

modelobject
# The CreditNote Object ### Description 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. ### Usage Example Fetch from the `LIST CreditNotes` endpoint and view a company's credit notes.
warningslist of objects
errorslist of objects
logslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="POST" data="H4sIAAAAAAAAA9VVbW/bNhD+KwU/GnqZ47pBDAyDE2etA1heE6doUATEmTzLjClSIU+O4yL/faDk1faWoNngbtgXgTzePce75znqKxNAmFv3yHoMhLCVIWVyFrHCStSsx84cSkWZJWQRg1JlUOCeL18esYj5qiytI5S/KtTSf3A4Yz2WFuhyjCujZgplug1KlSHMHZCyxqffguNZHc0ippVZoOw3Ad+Ha9zjjeVPW59q5YlFrATvae5slc8v8b5C/wrkcDeNBRoCHUsgSHdQYtfAPGcLVUjUSCgHQDBAQhHK3WScE5W+l6Zz1GVSZ08kLlM0KThSQqNPu52To+OTbrxBqbP/wnP9c7t1dz+10+MWz4XmULVGE7HKJsOH7C5/m529XWXr6262Xqyzu8VPLZ5DazQZdceTm8540G+Pn3HgV+8+n3w6HZxeZC2xPu9kdzcP2US0RxOxmK6HnYv34uHiw8dVtr45Gg2uO9nkvHvx3rbHZ5d+dHZpR/0kYRHbZZX1vnzdNWyEkyFdVapW087hsIAcd7rS0AGlistqqpVIfCeBAtbWwINPhC3SAqWCNEPyAY37+wocJmWt3bphyppvPQ95+5Php/N9EfSXoDRMNbIeuQr/omLW+7Ir9BKdsrIeg1IrlJws18pgYFrYogTzWK8MgQhyE5VzaEQw4krMweTIHWxKF7ryaonczjjBqlE8ckVYBDgTmhUxUxVTdCxiDgtQJlxC1PPYmCxh2AOh5LBjU3K7rkq5PfcEVAV8sgSaQxFKC1sHYlGjN6+BqmsiB8ZD3UAeQNhtQL2vlEP5GzgokNDVTdq7+3aThC+7fYqeE8LHSonFqbUL/2ZsQsxhFLGFjRtN8OvZ0bvT4/aP0MZzOngF+/tUH5jjA1P7R0EvsHgFOb4ZBpe66AMQGBD5BpFfNRQulyrzx/BvUfg/H+W/yewea7wMPj4p4TH883iBNLfyJfY/o7OHYT0gxT/uEf+Hg/pdbv8rUiNGj+WruH3paW4y1IZNmtun26ffAWqv8QEQCgAA" />