Cancel a credit note

POST
/payable_credit_notes/:credit_note_id/cancel

Cancel the credit note that was not confirmed during the review.

Path parameters

credit_note_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

idstring

The unique identifier of the credit note

created_atdatetime

Date and time when the credit note was created in the system

updated_atdatetime

Date and time of the last update to the credit note

based_onstring

ID of the payable this credit note is based on

entity_idstring

The ID of the entity to which the credit note belongs

originstring<=128 characters

The origin or source system of the credit note

source_of_datastring<=128 characters

How the data was input (ocr/user_specified)

statusstring<=30 characters

The current status of the credit note in its lifecycle

amountintegerOptional

The total amount including taxes

based_on_document_idstringOptional<=255 characters

The document ID of the original payable that this credit note refers to

counterpart_address_idstringOptional

ID of the counterpart’s address

counterpart_bank_account_idstringOptional

ID of the counterpart’s bank account

counterpart_idstringOptional

ID of the counterpart

counterpart_vat_id_idstringOptional

ID of the counterpart’s VAT registration

created_by_external_user_idstringOptional<=255 characters

External system’s user ID for the creator

created_by_external_user_namestringOptional<=255 characters

Name of the external user who created the credit note

created_by_user_idstringOptional

ID of the user who created the credit note

currencystringOptional<=5 characters

The currency code

currency_exchangeobjectOptional
descriptionstringOptional<=255 characters

Description of the credit note

document_idstringOptional<=255 characters

The credit note’s unique document number

issued_atstringOptional

Date when the credit note was issued

ocr_request_idstringOptional

ID of the OCR processing request

ocr_statusstringOptional<=10 characters

Status of OCR processing

project_idstringOptional

ID of the associated project

senderstringOptional<=255 characters

Email address of the sender

subtotalintegerOptional

The subtotal amount before taxes

tagslist of objectsOptional

List of tags associated with this credit note

taxintegerOptional

The tax percentage

tax_amountintegerOptional

The calculated tax amount

Errors