Mark an invoice as uncollectible

POST

/receivables/:receivable_id/mark_as_uncollectible

POST

/v1/receivables/:receivable_id/mark_as_uncollectible

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

Try it

200Successful

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

Path parameters

receivable_idstringRequired

Headers

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.

Request

This endpoint expects an object.

commentstringOptional

Optional comment explains why the Invoice goes uncollectible.

Response

Successful Response

quoteobject

invoiceobject

credit_noteobject

Path parameters

Headers

Request

Response

Errors