Accounts payableCredit notes

Upload a credit note from a file

Upload an incoming credit note (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects a multipart form containing a file.
filefileRequired

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_onstringOptionalformat: "uuid"
ID of the payable this credit note is based on
based_on_document_idstringOptional<=255 characters
The document ID of the original payable that this credit note refers to
counterpartobjectOptional

Object representing de-normalized counterpart data

counterpart_address_idstringOptionalformat: "uuid"
ID of the counterpart's address
counterpart_bank_account_idstringOptionalformat: "uuid"
ID of the counterpart's bank account
counterpart_idstringOptionalformat: "uuid"
ID of the counterpart
counterpart_rawobjectOptional
Object representing counterpart data which was extracted by OCR. Used for informational purposes.
counterpart_vat_id_idstringOptionalformat: "uuid"
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_idstringOptionalformat: "uuid"
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
file_idstringOptionalformat: "uuid"
The id of the credit note file stored in the file saver.
file_urlstringOptional
The URL of the credit note file stored in the file saver.
issued_atstringOptionalformat: "date"
Date when the credit note was issued
ocr_request_idstringOptionalformat: "uuid"
ID of the OCR processing request
ocr_statusstringOptional<=10 characters
Status of OCR processing
project_idstringOptionalformat: "uuid"
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
total_amountintegerOptional
The total amount including taxes

Errors

400
Post Payable Credit Notes Upload from File Request Bad Request Error
401
Post Payable Credit Notes Upload from File Request Unauthorized Error
403
Post Payable Credit Notes Upload from File Request Forbidden Error
409
Post Payable Credit Notes Upload from File Request Conflict Error
422
Post Payable Credit Notes Upload from File Request Unprocessable Entity Error
500
Post Payable Credit Notes Upload from File Request Internal Server Error