Skip to main content
PATCH
/
payable_credit_notes
/
{credit_note_id}
Update a credit note
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/payable_credit_notes/{credit_note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "based_on": "123e4567-e89b-12d3-a456-426614174000",
  "based_on_document_id": "INV-2287",
  "counterpart_address_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "EUR",
  "description": "Credit note for returned items from invoice INV-2287",
  "document_id": "CN-2287",
  "issued_at": "2024-01-15",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "sender": "supplier@example.com",
  "subtotal": 1000,
  "tag_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "tax": 20,
  "tax_amount": 200,
  "total_amount": 1200
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-15T14:30:00Z",
  "updated_at": "2024-01-15T14:30:00Z",
  "entity_id": "123e4567-e89b-12d3-a456-426614174000",
  "origin": "SAP",
  "source_of_data": "user_specified",
  "status": "submitted_for_approval",
  "based_on": "123e4567-e89b-12d3-a456-426614174000",
  "based_on_document_id": "INV-2287",
  "counterpart": {
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "line2": "<string>",
      "postal_code": "10115",
      "state": "<string>"
    },
    "bank_account": {
      "account_holder_name": "<string>",
      "account_number": "123456789012",
      "bic": "DEUTDE2HXXX",
      "iban": "<string>",
      "routing_number": "<string>",
      "sort_code": "<string>"
    },
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "DE12345678",
    "vat_id": {
      "country": "AF",
      "type": "<string>",
      "value": "<string>"
    }
  },
  "counterpart_address_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
  "counterpart_raw": {
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line1": "Flughafenstrasse 52",
      "line2": "<string>",
      "postal_code": "10115",
      "state": "<string>"
    },
    "bank_account": {
      "account_holder_name": "<string>",
      "account_number": "123456789012",
      "bic": "DEUTDE2HXXX",
      "iban": "<string>",
      "routing_number": "<string>",
      "sort_code": "<string>"
    },
    "email": "acme@example.com",
    "name": "Acme Inc.",
    "phone": "5551231234",
    "tax_id": "DE12345678",
    "vat_id": {
      "country": "AF",
      "type": "<string>",
      "value": "<string>"
    }
  },
  "counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_by_external_user_id": "ext_user_123",
  "created_by_external_user_name": "John Doe",
  "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "EUR",
  "currency_exchange": {
    "default_currency_code": "<string>",
    "rate": 123,
    "total": 123
  },
  "description": "Credit note for returned items from invoice INV-2287",
  "document_id": "CN-2287",
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "file_url": "<string>",
  "issued_at": "2024-01-15",
  "ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
  "ocr_status": "completed",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "sender": "supplier@example.com",
  "subtotal": 1000,
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Department A",
      "category": "department"
    }
  ],
  "tax": 20,
  "tax_amount": 200,
  "total_amount": 1200
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
credit_note_id
string<uuid>
required

Body

application/json

Schema for updating an existing credit note. All fields are optional.

​
based_on
string<uuid>

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
based_on_document_id
string

The document ID of the original payable

Maximum string length: 255
Example:

"INV-2287"

​
counterpart_address_id
string<uuid>

ID of the counterpart's address

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_bank_account_id
string<uuid>

ID of the counterpart's bank account

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_id
string<uuid>

ID of the counterpart

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_vat_id_id
string<uuid>

ID of the counterpart's VAT registration

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
currency
enum<string>

The currency code of the credit note

Available options:
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
Example:

"EUR"

​
description
string

An arbitrary description of this credit note

Maximum string length: 255
Example:

"Credit note for returned items from invoice INV-2287"

​
document_id
string

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

Maximum string length: 255
Example:

"CN-2287"

​
issued_at
string<date>

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

Example:

"2024-01-15"

​
project_id
string<uuid>

The ID of the project this credit note belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
sender
string

Email address of the sender

Maximum string length: 255
Example:

"supplier@example.com"

​
subtotal
integer

The subtotal amount before taxes

Required range: x >= 0
Example:

1000

​
tag_ids
string<uuid>[]

List of tag IDs associated with this credit note

Example:
["123e4567-e89b-12d3-a456-426614174000"]
​
tax
integer

The tax percentage applied to the subtotal

Required range: 0 <= x <= 10000
Example:

20

​
tax_amount
integer

The calculated tax amount

Required range: x >= 0
Example:

200

​
total_amount
integer

The total amount including taxes

Required range: x >= 0
Example:

1200

Response

Successful Response

Schema for credit note response. Includes all fields that can be returned from the API.

​
id
string<uuid>
required

The unique identifier of the credit note

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
created_at
string<date-time>
required

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

Example:

"2024-01-15T14:30:00Z"

​
updated_at
string<date-time>
required

Date and time of the last update to the credit note

Example:

"2024-01-15T14:30:00Z"

​
entity_id
string<uuid>
required

The ID of the entity to which the credit note belongs

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
origin
string
required

The origin or source system of the credit note

Maximum string length: 128
Example:

"SAP"

​
source_of_data
string
required

How the data was input (ocr/user_specified)

Maximum string length: 128
Example:

"user_specified"

​
status
string
required

The current status of the credit note in its lifecycle

Maximum string length: 30
Example:

"submitted_for_approval"

​
based_on
string<uuid>

ID of the payable this credit note is based on

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
based_on_document_id
string

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

Maximum string length: 255
Example:

"INV-2287"

​
counterpart
object

Object representing de-normalized counterpart data

​
counterpart_address_id
string<uuid>

ID of the counterpart's address

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_bank_account_id
string<uuid>

ID of the counterpart's bank account

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_id
string<uuid>

ID of the counterpart

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
counterpart_raw
object

Object representing counterpart data which was extracted by OCR. Used for informational purposes.

​
counterpart_vat_id_id
string<uuid>

ID of the counterpart's VAT registration

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
created_by_external_user_id
string

External system's user ID for the creator

Maximum string length: 255
Example:

"ext_user_123"

​
created_by_external_user_name
string

Name of the external user who created the credit note

Maximum string length: 255
Example:

"John Doe"

​
created_by_user_id
string<uuid>

ID of the user who created the credit note

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
currency
string

The currency code

Maximum string length: 5
Example:

"EUR"

​
currency_exchange
object
​
description
string

Description of the credit note

Maximum string length: 255
Example:

"Credit note for returned items from invoice INV-2287"

​
document_id
string

The credit note's unique document number

Maximum string length: 255
Example:

"CN-2287"

​
file_id
string<uuid>

The id of the credit note file stored in the file saver.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
file_url
string

The URL of the credit note file stored in the file saver.

​
issued_at
string<date>

Date when the credit note was issued

Example:

"2024-01-15"

​
ocr_request_id
string<uuid>

ID of the OCR processing request

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
ocr_status
string

Status of OCR processing

Maximum string length: 10
Example:

"completed"

​
project_id
string<uuid>

ID of the associated project

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
sender
string

Email address of the sender

Maximum string length: 255
Example:

"supplier@example.com"

​
subtotal
integer

The subtotal amount before taxes

Example:

1000

​
tags
object[]

List of tags associated with this credit note

Example:
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Department A",
    "category": "department"
  }
]
​
tax
integer

The tax percentage

Example:

20

​
tax_amount
integer

The calculated tax amount

Example:

200

​
total_amount
integer

The total amount including taxes

Example:

1200