Get all credit notes for an entity

GET

/payable_credit_notes

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

order"asc" or "desc"Optional

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

Allowed values: ascdesc

limitintegerOptional>=1<=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.

sort"id" or "created_at"Optional

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

Allowed values: idcreated_at

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

issued_atstringOptional

issued_at__gtstringOptional

issued_at__ltstringOptional

issued_at__gtestringOptional

issued_at__ltestringOptional

document_idstringOptional

document_id__iexactstringOptional

document_id__containsstringOptional

document_id__icontainsstringOptional

amount__gtintegerOptional

amount__ltintegerOptional

amount__gteintegerOptional

amount__lteintegerOptional

subtotal__gtintegerOptional

subtotal__ltintegerOptional

subtotal__gteintegerOptional

subtotal__lteintegerOptional

based_onstringOptional

counterpart_idstringOptional

created_by_entity_user_idstringOptional

statusenumOptional

Allowed values: draftissueddeleted

status__inenumOptional

Allowed values: draftissueddeleted

status__not_inenumOptional

Allowed values: draftissueddeleted

currencyenumOptional

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

GET

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

1 {
2   "data": [
3     {
4       "id": "123e4567-e89b-12d3-a456-426614174000",
5       "created_at": "2024-01-15T14:30:00Z",
6       "updated_at": "2024-01-15T14:30:00Z",
7       "based_on": "123e4567-e89b-12d3-a456-426614174000",
8       "entity_id": "123e4567-e89b-12d3-a456-426614174000",
9       "origin": "SAP",
10       "source_of_data": "user_specified",
11       "status": "submitted_for_approval",
12       "amount": 1200,
13       "based_on_document_id": "INV-2287",
14       "counterpart_address_id": "123e4567-e89b-12d3-a456-426614174000",
15       "counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
16       "counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
17       "counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
18       "created_by_external_user_id": "ext_user_123",
19       "created_by_external_user_name": "John Doe",
20       "created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
21       "currency": "EUR",
22       "currency_exchange": {
23         "default_currency_code": "default_currency_code",
24         "rate": 1.1,
25         "total": 1.1
26       },
27       "description": "Credit note for returned items from invoice INV-2287",
28       "document_id": "CN-2287",
29       "issued_at": "2024-01-15",
30       "ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
31       "ocr_status": "completed",
32       "project_id": "123e4567-e89b-12d3-a456-426614174000",
33       "sender": "supplier@example.com",
34       "subtotal": 1000,
35       "tags": [
36         {
37           "id": "123e4567-e89b-12d3-a456-426614174000",
38           "created_at": "2022-09-07T16:35:18Z",
39           "updated_at": "2022-09-07T16:35:18Z",
40           "name": "Department A",
41           "category": "department",
42           "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
43           "description": "Tag for the Marketing Department"
44         }
45       ],
46       "tax": 20,
47       "tax_amount": 200
48     }
49   ],
50   "next_pagination_token": "eyJwYWdlIjoyfQ==",
51   "prev_pagination_token": "eyJwYWdlIjoxfQ=="
52 }

Create a new credit note.

Up Next

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

1	{
2	"data": [
3	{
4	"id": "123e4567-e89b-12d3-a456-426614174000",
5	"created_at": "2024-01-15T14:30:00Z",
6	"updated_at": "2024-01-15T14:30:00Z",
7	"based_on": "123e4567-e89b-12d3-a456-426614174000",
8	"entity_id": "123e4567-e89b-12d3-a456-426614174000",
9	"origin": "SAP",
10	"source_of_data": "user_specified",
11	"status": "submitted_for_approval",
12	"amount": 1200,
13	"based_on_document_id": "INV-2287",
14	"counterpart_address_id": "123e4567-e89b-12d3-a456-426614174000",
15	"counterpart_bank_account_id": "123e4567-e89b-12d3-a456-426614174000",
16	"counterpart_id": "123e4567-e89b-12d3-a456-426614174000",
17	"counterpart_vat_id_id": "123e4567-e89b-12d3-a456-426614174000",
18	"created_by_external_user_id": "ext_user_123",
19	"created_by_external_user_name": "John Doe",
20	"created_by_user_id": "123e4567-e89b-12d3-a456-426614174000",
21	"currency": "EUR",
22	"currency_exchange": {
23	"default_currency_code": "default_currency_code",
24	"rate": 1.1,
25	"total": 1.1
26	},
27	"description": "Credit note for returned items from invoice INV-2287",
28	"document_id": "CN-2287",
29	"issued_at": "2024-01-15",
30	"ocr_request_id": "123e4567-e89b-12d3-a456-426614174000",
31	"ocr_status": "completed",
32	"project_id": "123e4567-e89b-12d3-a456-426614174000",
33	"sender": "supplier@example.com",
34	"subtotal": 1000,
35	"tags": [
36	{
37	"id": "123e4567-e89b-12d3-a456-426614174000",
38	"created_at": "2022-09-07T16:35:18Z",
39	"updated_at": "2022-09-07T16:35:18Z",
40	"name": "Department A",
41	"category": "department",
42	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
43	"description": "Tag for the Marketing Department"
44	}
45	],
46	"tax": 20,
47	"tax_amount": 200
48	}
49	],
50	"next_pagination_token": "eyJwYWdlIjoyfQ==",
51	"prev_pagination_token": "eyJwYWdlIjoxfQ=="
52	}