Mark an invoice as partially paid

Deprecated

POST

/receivables/:receivable_id/mark_as_partially_paid

Deprecated. Use POST /payment_records to record an invoice payment.

Path parameters

receivable_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.

Request

This endpoint expects an object.

amount_paidintegerRequired>=1

How much has been paid on the invoice (in minor units).

commentstringOptional

Optional comment explaining how the payment was made.

Response

Successful Response

Quote

Invoice

Credit Note

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/mark_as_partially_paid \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "amount_paid": 1
8 }'

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

Mark an invoice as uncollectible

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/mark_as_partially_paid \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"amount_paid": 1
8	}'

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