Update a receivable (v2023-09-01) — Monite Documentation

Successful Response

1 curl -X PATCH https://api.sandbox.monite.com/v1/receivables/receivable_id \ 2 -H "x-monite-version: 2023-09-01" \ 3 -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \ 4 -H "Authorization: Bearer <token>" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "quote": {} 8 }'

1 { 2 "type": "credit_note", 3 "counterpart_address": { 4 "city": "Berlin", 5 "country": "AF", 6 "line1": "Flughafenstrasse 52", 7 "postal_code": "10115", 8 "line2": "line2", 9 "state": "state" 10 }, 11 "counterpart_id": "string", 12 "counterpart_type": "individual", 13 "created_at": "2024-01-15T09:30:00Z", 14 "currency": "AED", 15 "entity": { 16 "type": "individual", 17 "first_name": "string", 18 "last_name": "string", 19 "email": "string", 20 "logo": "string", 21 "phone": "string", 22 "tax_id": "string", 23 "website": "string" 24 }, 25 "entity_address": { 26 "city": "city", 27 "line1": "line1", 28 "postal_code": "postal_code", 29 "country": "AF", 30 "line2": "line2", 31 "state": "state" 32 }, 33 "file_language": "ab", 34 "id": "string", 35 "line_items": [ 36 { 37 "product": { 38 "id": "id", 39 "created_at": "2024-01-15T09:30:00Z", 40 "updated_at": "2024-01-15T09:30:00Z", 41 "entity_id": "entity_id", 42 "name": "name", 43 "price": { 44 "currency": "AED", 45 "value": 1 46 }, 47 "price_after_vat": { 48 "currency": "AED", 49 "value": 1 50 }, 51 "vat_rate": { 52 "id": "id", 53 "created_at": "2024-01-15T09:30:00Z", 54 "updated_at": "2024-01-15T09:30:00Z", 55 "country": "AF", 56 "value": 1 57 } 58 }, 59 "quantity": 1.1, 60 "discount": { 61 "amount": 1, 62 "type": "amount" 63 }, 64 "total_before_vat": 1 65 } 66 ], 67 "original_file_language": "ab", 68 "status": "draft", 69 "total_vat_amount": 1, 70 "updated_at": "2024-01-15T09:30:00Z", 71 "based_on": "string", 72 "based_on_document_id": "string", 73 "commercial_condition_description": "string", 74 "counterpart_billing_address": { 75 "city": "Berlin", 76 "country": "AF", 77 "line1": "Flughafenstrasse 52", 78 "postal_code": "10115", 79 "line2": "line2", 80 "state": "state" 81 }, 82 "counterpart_business_type": "string", 83 "counterpart_contact": { 84 "address": { 85 "city": "Berlin", 86 "country": "AF", 87 "line1": "Flughafenstrasse 52", 88 "postal_code": "10115", 89 "line2": "line2", 90 "state": "state" 91 }, 92 "first_name": "Marge", 93 "last_name": "Smith", 94 "email": "marge@example.org", 95 "phone": "55512378654", 96 "title": "Dr." 97 }, 98 "counterpart_name": "string", 99 "counterpart_shipping_address": { 100 "city": "Berlin", 101 "country": "AF", 102 "line1": "Flughafenstrasse 52", 103 "postal_code": "10115", 104 "line2": "line2", 105 "state": "state" 106 }, 107 "counterpart_tax_id": "string", 108 "counterpart_vat_id": { 109 "id": "id", 110 "counterpart_id": "counterpart_id", 111 "value": "123456789", 112 "country": "AF", 113 "type": "ae_trn" 114 }, 115 "deduction_amount": 1, 116 "deduction_memo": "string", 117 "discount": { 118 "amount": 1, 119 "type": "amount" 120 }, 121 "discounted_subtotal": 1, 122 "document_id": "string", 123 "due_date": "string", 124 "entity_bank_account": { 125 "id": "id", 126 "account_holder_name": "account_holder_name", 127 "account_number": "account_number", 128 "bank_name": "bank_name", 129 "bic": "bic", 130 "country": "AF", 131 "currency": "AED", 132 "display_name": "display_name", 133 "iban": "iban", 134 "is_default": true, 135 "routing_number": "routing_number", 136 "sort_code": "sort_code", 137 "was_created_by_user_id": "was_created_by_user_id" 138 }, 139 "entity_user_id": "string", 140 "entity_vat_id": { 141 "id": "id", 142 "country": "AF", 143 "entity_id": "entity_id", 144 "value": "123456789", 145 "type": "ae_trn" 146 }, 147 "file": { 148 "id": "id", 149 "created_at": "2024-01-15T09:30:00Z", 150 "file_type": "payables", 151 "md5": "31d1a2dd1ad3dfc39be849d70a68dac0", 152 "mimetype": "application/pdf", 153 "name": "invoice.pdf", 154 "region": "eu-central-1", 155 "size": 24381, 156 "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf", 157 "pages": [ 158 { 159 "id": "id", 160 "mimetype": "image/png", 161 "number": 0, 162 "size": 21972, 163 "url": "https://bucket.s3.amazonaws.com/123/456.png" 164 } 165 ], 166 "previews": [ 167 { 168 "height": 400, 169 "url": "https://bucketname.s3.amazonaws.com/1/2/3.png", 170 "width": 200 171 } 172 ] 173 }, 174 "file_url": "string", 175 "issue_date": "2024-01-15T09:30:00Z", 176 "memo": "string", 177 "original_file_url": "string", 178 "partner_metadata": { 179 "key": "value" 180 }, 181 "project_id": "string", 182 "purchase_order": "string", 183 "subtotal": 1, 184 "tags": [ 185 { 186 "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 187 "created_at": "2022-09-07T16:35:18Z", 188 "updated_at": "2022-09-07T16:35:18Z", 189 "name": "Marketing", 190 "category": "document_type", 191 "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 192 "description": "Tag for the Marketing Department" 193 } 194 ], 195 "total_amount": 1, 196 "total_vat_amounts": [ 197 { 198 "amount": 1, 199 "value": 1, 200 "id": "id" 201 } 202 ], 203 "total_withholding_tax": 1, 204 "trade_name": "string", 205 "vat_exempt": true, 206 "vat_exemption_rationale": "string", 207 "vat_mode": "exclusive", 208 "withholding_tax_rate": 1 209 }

Update a receivable

Path parameters

Headers

Request

Response

Errors

1	curl -X PATCH https://api.sandbox.monite.com/v1/receivables/receivable_id \
2	-H "x-monite-version: 2023-09-01" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"quote": {}
8	}'

1	{
2	"type": "credit_note",
3	"counterpart_address": {
4	"city": "Berlin",
5	"country": "AF",
6	"line1": "Flughafenstrasse 52",
7	"postal_code": "10115",
8	"line2": "line2",
9	"state": "state"
10	},
11	"counterpart_id": "string",
12	"counterpart_type": "individual",
13	"created_at": "2024-01-15T09:30:00Z",
14	"currency": "AED",
15	"entity": {
16	"type": "individual",
17	"first_name": "string",
18	"last_name": "string",
19	"email": "string",
20	"logo": "string",
21	"phone": "string",
22	"tax_id": "string",
23	"website": "string"
24	},
25	"entity_address": {
26	"city": "city",
27	"line1": "line1",
28	"postal_code": "postal_code",
29	"country": "AF",
30	"line2": "line2",
31	"state": "state"
32	},
33	"file_language": "ab",
34	"id": "string",
35	"line_items": [
36	{
37	"product": {
38	"id": "id",
39	"created_at": "2024-01-15T09:30:00Z",
40	"updated_at": "2024-01-15T09:30:00Z",
41	"entity_id": "entity_id",
42	"name": "name",
43	"price": {
44	"currency": "AED",
45	"value": 1
46	},
47	"price_after_vat": {
48	"currency": "AED",
49	"value": 1
50	},
51	"vat_rate": {
52	"id": "id",
53	"created_at": "2024-01-15T09:30:00Z",
54	"updated_at": "2024-01-15T09:30:00Z",
55	"country": "AF",
56	"value": 1
57	}
58	},
59	"quantity": 1.1,
60	"discount": {
61	"amount": 1,
62	"type": "amount"
63	},
64	"total_before_vat": 1
65	}
66	],
67	"original_file_language": "ab",
68	"status": "draft",
69	"total_vat_amount": 1,
70	"updated_at": "2024-01-15T09:30:00Z",
71	"based_on": "string",
72	"based_on_document_id": "string",
73	"commercial_condition_description": "string",
74	"counterpart_billing_address": {
75	"city": "Berlin",
76	"country": "AF",
77	"line1": "Flughafenstrasse 52",
78	"postal_code": "10115",
79	"line2": "line2",
80	"state": "state"
81	},
82	"counterpart_business_type": "string",
83	"counterpart_contact": {
84	"address": {
85	"city": "Berlin",
86	"country": "AF",
87	"line1": "Flughafenstrasse 52",
88	"postal_code": "10115",
89	"line2": "line2",
90	"state": "state"
91	},
92	"first_name": "Marge",
93	"last_name": "Smith",
94	"email": "marge@example.org",
95	"phone": "55512378654",
96	"title": "Dr."
97	},
98	"counterpart_name": "string",
99	"counterpart_shipping_address": {
100	"city": "Berlin",
101	"country": "AF",
102	"line1": "Flughafenstrasse 52",
103	"postal_code": "10115",
104	"line2": "line2",
105	"state": "state"
106	},
107	"counterpart_tax_id": "string",
108	"counterpart_vat_id": {
109	"id": "id",
110	"counterpart_id": "counterpart_id",
111	"value": "123456789",
112	"country": "AF",
113	"type": "ae_trn"
114	},
115	"deduction_amount": 1,
116	"deduction_memo": "string",
117	"discount": {
118	"amount": 1,
119	"type": "amount"
120	},
121	"discounted_subtotal": 1,
122	"document_id": "string",
123	"due_date": "string",
124	"entity_bank_account": {
125	"id": "id",
126	"account_holder_name": "account_holder_name",
127	"account_number": "account_number",
128	"bank_name": "bank_name",
129	"bic": "bic",
130	"country": "AF",
131	"currency": "AED",
132	"display_name": "display_name",
133	"iban": "iban",
134	"is_default": true,
135	"routing_number": "routing_number",
136	"sort_code": "sort_code",
137	"was_created_by_user_id": "was_created_by_user_id"
138	},
139	"entity_user_id": "string",
140	"entity_vat_id": {
141	"id": "id",
142	"country": "AF",
143	"entity_id": "entity_id",
144	"value": "123456789",
145	"type": "ae_trn"
146	},
147	"file": {
148	"id": "id",
149	"created_at": "2024-01-15T09:30:00Z",
150	"file_type": "payables",
151	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
152	"mimetype": "application/pdf",
153	"name": "invoice.pdf",
154	"region": "eu-central-1",
155	"size": 24381,
156	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
157	"pages": [
158	{
159	"id": "id",
160	"mimetype": "image/png",
161	"number": 0,
162	"size": 21972,
163	"url": "https://bucket.s3.amazonaws.com/123/456.png"
164	}
165	],
166	"previews": [
167	{
168	"height": 400,
169	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
170	"width": 200
171	}
172	]
173	},
174	"file_url": "string",
175	"issue_date": "2024-01-15T09:30:00Z",
176	"memo": "string",
177	"original_file_url": "string",
178	"partner_metadata": {
179	"key": "value"
180	},
181	"project_id": "string",
182	"purchase_order": "string",
183	"subtotal": 1,
184	"tags": [
185	{
186	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
187	"created_at": "2022-09-07T16:35:18Z",
188	"updated_at": "2022-09-07T16:35:18Z",
189	"name": "Marketing",
190	"category": "document_type",
191	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
192	"description": "Tag for the Marketing Department"
193	}
194	],
195	"total_amount": 1,
196	"total_vat_amounts": [
197	{
198	"amount": 1,
199	"value": 1,
200	"id": "id"
201	}
202	],
203	"total_withholding_tax": 1,
204	"trade_name": "string",
205	"vat_exempt": true,
206	"vat_exemption_rationale": "string",
207	"vat_mode": "exclusive",
208	"withholding_tax_rate": 1
209	}