/credit-notes/{id}
Updates a CreditNote object with the given id.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Path parameters
id
Headers
X-Account-Token
Token identifying the end user.
Query parameters
is_debug_mode
Whether to include debug fields (such as log file links) in the response.
run_async
Whether or not third-party updates should be run asynchronously.
Request
This endpoint expects an object.
model
# 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.
Response
model
# 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.
warnings
errors
logs
<MergeSupportedFieldsByIntegrationWidget requestType="PATCH" data="H4sIAAAAAAAAA8WTbU8aQRDHv0qzL8kdV0A0kjQND1Yl4aiKRmPMZtgbjpW93WMfADF+92YPVGittY2m73Zmd/6zM7+Ze8LAYqr0HWkQYEw5ablMSUAylaAgDdLWmHAbK4skIJDzGDLcektnVRIQ4/JcaYvJN44iMUcaR6RBogx1iqGTfMQxiZ6DIi4tphosV9JET8HhqIgmARFcTjBprgL+LLd6Hq49P5kmEtxYEpAcjLFjrVw6PsWpQ/MGZf83gRlKCyJMwEK0oRLqlcxLPl9FggItJh2w0EGLzJe7zji2NjeNKBqjyMtF9nKCswhlBNpyJtBE9dp+dW+/Hq5ViuxfaSq+VEq306Ea7pVoygQFV+oN2CIeHM/j23Qnbu8s4uV5PV5OlvHt5HOJplDqDXr1/uCq1u80K/0XHtCz3cv9i1an1Y1LbHlQi2+v5vGAVXoDNhkuj2vdQzbvHp0s4uVVtdc5r8WDg3r3UFX67VPTa5+qXrNcJgHZpEoa1/ebjvXgxGjPHC+maePyOIMUN7qywgE5D3M3FJyVTa0MGSyVhLkpM5VFGSYcohit8WrUTB1oLOfF7BYN40o+9dznbQ6OLw62h6A5Ay5gKJA0rHb4yxSTxvXmoOeouUpIQJjKcpB3xUlaYH62mNMaJfNOXLAxyBSphqJOwSVSbjEzj3tFneNeSPqeBES6bIiaBERjBlz6XKxYu5VLWfQ2WEwobPgKifXZ5cnzvbFgnU9mlQVBIfMVeFMDmxTqq6XnaFZeaaDoE/Ui5MarTh3XmHwHDRla1L4XNw/BS0RPHGeTllIT86kvfa3vg/ZZNlzBpeej6m5rr/IBkP8e4z8i8yu8bdEc7PgNTN8XJYE8F9xrPwpyOVOcIfkN5EvU6n24eqXww9b1TSS5ZMIZPkOqRtTC4r/DfWVht3kGxN7lr23ozcMPe9CRp9MHAAA=" />