Credit 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.

post/payable_credit_notes/upload_from_file

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payable_credit_notes/upload_from_file
  • Auth: HTTP bearer

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

idstring uuid required

The unique identifier of the credit note

created_atstring date-time required

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

updated_atstring date-time required

Date and time of the last update to the credit note

based_onstring uuid

ID of the payable this credit note is based on

based_on_document_idstring

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

counterpart_address_idstring uuid

ID of the counterpart's address

counterpart_bank_account_idstring uuid

ID of the counterpart's bank account

counterpart_idstring uuid

ID of the counterpart

counterpart_vat_id_idstring uuid

ID of the counterpart's VAT registration

created_by_external_user_idstring

External system's user ID for the creator

created_by_external_user_namestring

Name of the external user who created the credit note

created_by_user_idstring uuid

ID of the user who created the credit note

currencystring

The currency code

descriptionstring

Description of the credit note

document_idstring

The credit note's unique document number

entity_idstring uuid required

The ID of the entity to which the credit note belongs

file_idstring 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_atstring date

Date when the credit note was issued

ocr_request_idstring uuid

ID of the OCR processing request

ocr_statusstring

Status of OCR processing

originstring required

The origin or source system of the credit note

project_idstring uuid

ID of the associated project

senderstring

Email address of the sender

source_of_datastring required

How the data was input (ocr/user_specified)

statusstring required

The current status of the credit note in its lifecycle

subtotalinteger

The subtotal amount before taxes

taxinteger

The tax percentage

tax_amountinteger

The calculated tax amount

total_amountinteger

The total amount including taxes

Changes

No recorded changes to this operation across all 1 revision of this API.