Cancel a delivery note — Monite Documentation

Path parameters

delivery_note_idstringRequired

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.

Response

Successful Response

idstringformat: "uuid"

Unique ID of the delivery note

created_atdatetime

Time at which the delivery note was created. Timestamps follow the ISO 8601 standard.

updated_atdatetime

Time at which the delivery note was last updated. Timestamps follow the ISO 8601 standard.

counterpartobject

Counterpart of the delivery note

counterpart_addressobject

Address of the counterpart

counterpart_idstringformat: "uuid"

ID of the counterpart

display_signature_placeholderboolean

Whether to display a signature placeholder in the generated PDF

document_idstring

Document ID of the delivery note

entityobject

Entity that created the delivery note

entity_addressobject

Address of the entity that created the delivery note

entity_idstringformat: "uuid"

ID of the entity that created the delivery note

file_languageenum

The language of the customer-facing PDF file (file_url). The value matches the counterpart’s language at the time when this PDF file was generated.

line_itemslist of objects

List of line items in the delivery note

original_file_languageenum

The language of the entity’s copy of the PDF file (original_file_url). The value matches the entity’s language at the time when this PDF file was generated.

statusenum

Allowed values: createdcanceleddelivered

Status of the delivery note

based_onstringOptionalformat: "uuid"

The unique ID of a previous document related to the delivery note if applicable.

based_on_document_idstringOptional

The unique document ID of a previous document related to the delivery note if applicable.

created_by_entity_user_idstringOptionalformat: "uuid"

ID of the user that created the delivery note

delivery_datestringOptionalformat: "date"

Date of delivery

delivery_numberstringOptional

Delivery number

file_urlstringOptional

The delivery note’s PDF URL in the customer-facing language.

memostringOptional

Additional information regarding the delivery note

original_file_urlstringOptional

The delivery note’s PDF URL in the entity’s language.

Errors

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

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