Request
This endpoint expects a multipart form containing a file.
Response
Successful Response
idstringformat: "uuid"
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
entity_idstringformat: "uuid"
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
based_onstringformat: "uuid"
ID of the payable this credit note is based on
based_on_document_idstring<=255 characters
The document ID of the original payable that this credit note refers to
counterpartobject
Object representing de-normalized counterpart data
counterpart_address_idstringformat: "uuid"
ID of the counterpart's address
counterpart_bank_account_idstringformat: "uuid"
ID of the counterpart's bank account
counterpart_idstringformat: "uuid"
ID of the counterpart
counterpart_rawobject
Object representing counterpart data which was extracted by OCR. Used for informational purposes.
counterpart_vat_id_idstringformat: "uuid"
ID of the counterpart's VAT registration
created_by_external_user_idstring<=255 characters
External system's user ID for the creator
created_by_external_user_namestring<=255 characters
Name of the external user who created the credit note
created_by_user_idstringformat: "uuid"
ID of the user who created the credit note
currencystring<=5 characters
The currency code
descriptionstring<=255 characters
Description of the credit note
document_idstring<=255 characters
The credit note's unique document number
file_idstringformat: "uuid"
The id of the credit note file stored in the file saver.
file_urlstring
The URL of the credit note file stored in the file saver.
issued_atstringformat: "date"
Date when the credit note was issued
ocr_request_idstringformat: "uuid"
ID of the OCR processing request
ocr_statusstring<=10 characters
Status of OCR processing
project_idstringformat: "uuid"
ID of the associated project
senderstring<=255 characters
Email address of the sender
subtotalinteger
The subtotal amount before taxes
tagslist of objects
List of tags associated with this credit note
taxinteger
The tax percentage
tax_amountinteger
The calculated tax amount
total_amountinteger
The total amount including taxes
