Skip to main content
GET
/
payable_credit_notes
Get credit notes
curl --request GET \
  --url https://api.sandbox.monite.com/v1/payable_credit_notes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "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
    }
  ],
  "next_pagination_token": "eyJwYWdlIjoyfQ==",
  "prev_pagination_token": "eyJwYWdlIjoxfQ=="
}

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"

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
id,
created_at
​
created_at__gt
string<date-time>
​
created_at__lt
string<date-time>
​
created_at__gte
string<date-time>
​
created_at__lte
string<date-time>
​
issued_at
string<date>
​
issued_at__gt
string<date>
​
issued_at__lt
string<date>
​
issued_at__gte
string<date>
​
issued_at__lte
string<date>
​
document_id
string
​
document_id__iexact
string
​
document_id__contains
string
​
document_id__icontains
string
​
has_file
boolean
​
total_amount__gt
integer
Required range: x >= 0
​
total_amount__lt
integer
Required range: x >= 0
​
total_amount__gte
integer
Required range: x >= 0
​
total_amount__lte
integer
Required range: x >= 0
​
subtotal__gt
integer
Required range: x >= 0
​
subtotal__lt
integer
Required range: x >= 0
​
subtotal__gte
integer
Required range: x >= 0
​
subtotal__lte
integer
Required range: x >= 0
​
based_on
string<uuid>
​
counterpart_id
string<uuid>
​
created_by_entity_user_id
string<uuid>
​
status
enum<string>
Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
status__in
enum<string>[]
Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
status__not_in
enum<string>[]
Available options:
new,
draft,
applied,
approved,
rejected,
canceled,
submitted_for_approval
​
origin
enum<string>
Available options:
upload,
einvoicing
​
currency
enum<string>
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
​
project_id
string<uuid>
​
project_id__in
string<uuid>[]

Response

Successful Response

A paginated list of credit notes.

​
data
object[]
required

List of credit notes for the current page

​
next_pagination_token
string

Token to retrieve the next page of results

Example:

"eyJwYWdlIjoyfQ=="

​
prev_pagination_token
string

Token to retrieve the previous page of results

Example:

"eyJwYWdlIjoxfQ=="