Get credit notes

GET

/payable_credit_notes

GET

/v1/payable_credit_notes

curl https://api.sandbox.monite.com/v1/payable_credit_notes \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "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": "AF",
          "line1": "Flughafenstrasse 52",
          "line2": "line2",
          "postal_code": "10115",
          "state": "state"
        },
        "bank_account": {
          "account_holder_name": "account_holder_name",
          "account_number": "123456789012",
          "bic": "DEUTDE2HXXX",
          "iban": "iban",
          "routing_number": "routing_number",
          "sort_code": "sort_code"
        },
        "email": "acme@example.com",
        "name": "Acme Inc.",
        "phone": "5551231234",
        "tax_id": "DE12345678",
        "vat_id": {
          "country": "AF",
          "type": "type",
          "value": "value"
        }
      },
      "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": "AF",
          "line1": "Flughafenstrasse 52",
          "line2": "line2",
          "postal_code": "10115",
          "state": "state"
        },
        "bank_account": {
          "account_holder_name": "account_holder_name",
          "account_number": "123456789012",
          "bic": "DEUTDE2HXXX",
          "iban": "iban",
          "routing_number": "routing_number",
          "sort_code": "sort_code"
        },
        "email": "acme@example.com",
        "name": "Acme Inc.",
        "phone": "5551231234",
        "tax_id": "DE12345678",
        "vat_id": {
          "country": "AF",
          "type": "type",
          "value": "value"
        }
      },
      "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": "default_currency_code",
        "rate": 1.1,
        "total": 1.1
      },
      "description": "Credit note for returned items from invoice INV-2287",
      "document_id": "CN-2287",
      "file_id": "123e4567-e89b-12d3-a456-426614174000",
      "file_url": "file_url",
      "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",
          "created_at": "2022-09-07T16:35:18Z",
          "updated_at": "2022-09-07T16:35:18Z",
          "name": "Department A",
          "category": "department",
          "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
          "description": "Tag for the Marketing Department"
        }
      ],
      "tax": 20,
      "tax_amount": 200,
      "total_amount": 1200
    }
  ],
  "next_pagination_token": "eyJwYWdlIjoyfQ==",
  "prev_pagination_token": "eyJwYWdlIjoxfQ=="
}

Authentication

AuthorizationBearer

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

Query parameters

orderenumOptional

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

Allowed values:

limitintegerOptional1-100Defaults to 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.

pagination_tokenstringOptional

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.

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.

sortenumOptional

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

Allowed values:

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

issued_atstringOptionalformat: "date"

issued_at__gtstringOptionalformat: "date"

issued_at__ltstringOptionalformat: "date"

issued_at__gtestringOptionalformat: "date"

issued_at__ltestringOptionalformat: "date"

document_idstringOptional

document_id__iexactstringOptional

document_id__containsstringOptional

document_id__icontainsstringOptional

has_filebooleanOptional

total_amount__gtintegerOptional>=0

total_amount__ltintegerOptional>=0

total_amount__gteintegerOptional>=0

total_amount__lteintegerOptional>=0

subtotal__gtintegerOptional>=0

subtotal__ltintegerOptional>=0

subtotal__gteintegerOptional>=0

subtotal__lteintegerOptional>=0

based_onstringOptionalformat: "uuid"

counterpart_idstringOptionalformat: "uuid"

created_by_entity_user_idstringOptionalformat: "uuid"

statusenumOptional

Credit note statuses (used in accounts payable).

status__inenumOptional

Credit note statuses (used in accounts payable).

status__not_inenumOptional

Credit note statuses (used in accounts payable).

originenumOptional

Allowed values:

currencyenumOptional

project_idstringOptionalformat: "uuid"

project_id__instringOptionalformat: "uuid"

Response

Successful Response

datalist of objects

List of credit notes for the current page

next_pagination_tokenstringOptional

Token to retrieve the next page of results

prev_pagination_tokenstringOptional

Token to retrieve the previous page of results

Errors

400

Get Payable Credit Notes Request Bad Request Error

401

Get Payable Credit Notes Request Unauthorized Error

403

Get Payable Credit Notes Request Forbidden Error

406

Get Payable Credit Notes Request Not Acceptable Error

422

Get Payable Credit Notes Request Unprocessable Entity Error

429

Get Payable Credit Notes Request Too Many Requests Error

Authentication

Headers

Query parameters

Response

Errors