Get delivery notes

GET

/delivery_notes

Get all delivery notes with filtering and pagination.

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

orderenumOptional

Order by

Allowed values: ascdesc

limitintegerOptional>=1<=100Defaults to 100

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sortenumOptional

Allowed sort fields

Allowed values: statusdocument_iddelivery_datecreated_at

id__instringOptionalformat: "uuid"

statusenumOptional

Allowed values: createdcanceleddelivered

status__inenumOptional

Allowed values: createdcanceleddelivered

document_idstringOptional

document_id__containsstringOptional

document_id__icontainsstringOptional

created_by_entity_user_idstringOptional

counterpart_idstringOptional

based_onstringOptional

based_on_document_idstringOptional

based_on_document_id__containsstringOptional

based_on_document_id__icontainsstringOptional

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

delivery_date__gtstringOptional

delivery_date__ltstringOptional

delivery_date__gtestringOptional

delivery_date__ltestringOptional

Response

Successful Response

datalist of objects

List of delivery notes

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

GET

1 curl https://api.sandbox.monite.com/v1/delivery_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>"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "id",
5       "created_at": "2024-01-15T09:30:00Z",
6       "updated_at": "2024-01-15T09:30:00Z",
7       "counterpart": {
8         "id": "id",
9         "individual": {
10           "first_name": "Adnan",
11           "is_customer": true,
12           "is_vendor": true,
13           "last_name": "Singh",
14           "email": "asingh@example.net",
15           "phone": "5553211234",
16           "tags": [
17             {
18               "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19               "created_at": "2022-09-07T16:35:18Z",
20               "updated_at": "2022-09-07T16:35:18Z",
21               "name": "Marketing",
22               "category": "document_type",
23               "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
24               "description": "Tag for the Marketing Department"
25             }
26           ],
27           "title": "Mr."
28         },
29         "language": "ab",
30         "organization": {
31           "is_customer": true,
32           "is_vendor": true,
33           "legal_name": "Acme Inc.",
34           "email": "acme@example.com",
35           "phone": "5551231234",
36           "tags": [
37             {
38               "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
39               "created_at": "2022-09-07T16:35:18Z",
40               "updated_at": "2022-09-07T16:35:18Z",
41               "name": "Marketing",
42               "category": "document_type",
43               "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
44               "description": "Tag for the Marketing Department"
45             }
46           ]
47         }
48       },
49       "counterpart_address": {
50         "id": "id",
51         "city": "Berlin",
52         "counterpart_id": "counterpart_id",
53         "country": "AF",
54         "line1": "Flughafenstrasse 52",
55         "postal_code": "10115",
56         "line2": "line2",
57         "state": "state"
58       },
59       "counterpart_id": "counterpart_id",
60       "display_signature_placeholder": true,
61       "document_id": "document_id",
62       "entity": {
63         "type": "individual",
64         "first_name": "entity",
65         "last_name": "entity",
66         "email": "entity",
67         "logo": "entity",
68         "phone": "entity",
69         "tax_id": "entity",
70         "website": "entity"
71       },
72       "entity_address": {
73         "city": "city",
74         "line1": "line1",
75         "postal_code": "postal_code",
76         "country": "AF",
77         "line2": "line2",
78         "state": "state"
79       },
80       "entity_id": "entity_id",
81       "file_language": "ab",
82       "line_items": [
83         {
84           "product": {
85             "name": "name",
86             "description": "description",
87             "measure_unit": {
88               "name": "name",
89               "description": "description"
90             }
91           },
92           "quantity": 1.1
93         }
94       ],
95       "original_file_language": "ab",
96       "status": "created",
97       "based_on": "based_on",
98       "based_on_document_id": "based_on_document_id",
99       "created_by_entity_user_id": "created_by_entity_user_id",
100       "delivery_date": "delivery_date",
101       "delivery_number": "delivery_number",
102       "file_url": "file_url",
103       "memo": "memo",
104       "original_file_url": "original_file_url"
105     }
106   ],
107   "next_pagination_token": "next_pagination_token",
108   "prev_pagination_token": "prev_pagination_token"
109 }

Create a delivery note

Up Next

1	curl https://api.sandbox.monite.com/v1/delivery_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": "id",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"counterpart": {
8	"id": "id",
9	"individual": {
10	"first_name": "Adnan",
11	"is_customer": true,
12	"is_vendor": true,
13	"last_name": "Singh",
14	"email": "asingh@example.net",
15	"phone": "5553211234",
16	"tags": [
17	{
18	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19	"created_at": "2022-09-07T16:35:18Z",
20	"updated_at": "2022-09-07T16:35:18Z",
21	"name": "Marketing",
22	"category": "document_type",
23	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
24	"description": "Tag for the Marketing Department"
25	}
26	],
27	"title": "Mr."
28	},
29	"language": "ab",
30	"organization": {
31	"is_customer": true,
32	"is_vendor": true,
33	"legal_name": "Acme Inc.",
34	"email": "acme@example.com",
35	"phone": "5551231234",
36	"tags": [
37	{
38	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
39	"created_at": "2022-09-07T16:35:18Z",
40	"updated_at": "2022-09-07T16:35:18Z",
41	"name": "Marketing",
42	"category": "document_type",
43	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
44	"description": "Tag for the Marketing Department"
45	}
46	]
47	}
48	},
49	"counterpart_address": {
50	"id": "id",
51	"city": "Berlin",
52	"counterpart_id": "counterpart_id",
53	"country": "AF",
54	"line1": "Flughafenstrasse 52",
55	"postal_code": "10115",
56	"line2": "line2",
57	"state": "state"
58	},
59	"counterpart_id": "counterpart_id",
60	"display_signature_placeholder": true,
61	"document_id": "document_id",
62	"entity": {
63	"type": "individual",
64	"first_name": "entity",
65	"last_name": "entity",
66	"email": "entity",
67	"logo": "entity",
68	"phone": "entity",
69	"tax_id": "entity",
70	"website": "entity"
71	},
72	"entity_address": {
73	"city": "city",
74	"line1": "line1",
75	"postal_code": "postal_code",
76	"country": "AF",
77	"line2": "line2",
78	"state": "state"
79	},
80	"entity_id": "entity_id",
81	"file_language": "ab",
82	"line_items": [
83	{
84	"product": {
85	"name": "name",
86	"description": "description",
87	"measure_unit": {
88	"name": "name",
89	"description": "description"
90	}
91	},
92	"quantity": 1.1
93	}
94	],
95	"original_file_language": "ab",
96	"status": "created",
97	"based_on": "based_on",
98	"based_on_document_id": "based_on_document_id",
99	"created_by_entity_user_id": "created_by_entity_user_id",
100	"delivery_date": "delivery_date",
101	"delivery_number": "delivery_number",
102	"file_url": "file_url",
103	"memo": "memo",
104	"original_file_url": "original_file_url"
105	}
106	],
107	"next_pagination_token": "next_pagination_token",
108	"prev_pagination_token": "prev_pagination_token"
109	}