Credit notes

Update a credit note

patch/payable_credit_notes/{credit_note_id}

Request

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

Path parameters

credit_note_idstring required

Headers

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

The ID of the entity that owns the requested resource.

Request body

based_onstring uuid

ID of the payable this credit note is based on. The credit note will be linked to this payable

based_on_document_idstring

The document ID of the original payable

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

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'
descriptionstring

An arbitrary description of this credit note

document_idstring

A unique credit note number assigned by the credit note issuer for tracking purposes

issued_atstring date

The date when the credit note was issued, in the YYYY-MM-DD format

project_idstring uuid

The ID of the project this credit note belongs to

senderstring

Email address of the sender

subtotalinteger

The subtotal amount before taxes

tag_idsstring[]

List of tag IDs associated with this credit note

taxinteger

The tax percentage applied to the subtotal

tax_amountinteger

The calculated tax amount

total_amountinteger

The total amount including taxes

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.