Mark an invoice as partially paid

Deprecated

POST

/receivables/:receivable_id/mark_as_partially_paid

POST

/v1/receivables/:receivable_id/mark_as_partially_paid

1 curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/mark_as_partially_paid \
2      -H "x-monite-version: 2024-05-25" \
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   "amount_paid": 1
8 }'

Try it

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         "name": "name",
34         "price": {
35           "currency": "AED",
36           "value": 1
37         },
38         "price_after_vat": {
39           "currency": "AED",
40           "value": 1
41         },
42         "vat_rate": {
43           "country": "AF",
44           "value": 1,
45           "id": "id",
46           "components": [
47             {
48               "name": "name",
49               "value": 1.1
50             }
51           ],
52           "is_custom": true,
53           "name": "name"
54         },
55         "accounting_tax_rate_id": "accounting_tax_rate_id",
56         "description": "description",
57         "external_reference": "HT-1234-S-BL",
58         "is_inline": true,
59         "ledger_account_id": "ledger_account_id",
60         "measure_unit": {
61           "name": "name",
62           "id": "id",
63           "description": "description"
64         },
65         "smallest_amount": 1.1,
66         "type": "product"
67       },
68       "quantity": 1.1,
69       "total_after_vat": 1,
70       "total_before_vat": 1,
71       "discount": {
72         "amount": 1,
73         "type": "amount"
74       }
75     }
76   ],
77   "original_file_language": "ab",
78   "status": "draft",
79   "total_vat_amount": 1,
80   "updated_at": "2024-01-15T09:30:00Z",
81   "based_on": "based_on",
82   "based_on_document_id": "based_on_document_id",
83   "comment": "comment",
84   "commercial_condition_description": "commercial_condition_description",
85   "counterpart_billing_address": {
86     "city": "Berlin",
87     "country": "AF",
88     "line1": "Flughafenstrasse 52",
89     "postal_code": "10115",
90     "id": "id",
91     "line2": "line2",
92     "state": "state"
93   },
94   "counterpart_business_type": "counterpart_business_type",
95   "counterpart_contact": {
96     "address": {
97       "city": "Berlin",
98       "country": "AF",
99       "line1": "Flughafenstrasse 52",
100       "postal_code": "10115",
101       "id": "id",
102       "line2": "line2",
103       "state": "state"
104     },
105     "first_name": "Marge",
106     "last_name": "Smith",
107     "email": "marge@example.org",
108     "phone": "55512378654",
109     "title": "Dr."
110   },
111   "counterpart_external_reference": "counterpart_external_reference",
112   "counterpart_name": "counterpart_name",
113   "counterpart_shipping_address": {
114     "city": "Berlin",
115     "country": "AF",
116     "line1": "Flughafenstrasse 52",
117     "postal_code": "10115",
118     "id": "id",
119     "line2": "line2",
120     "state": "state"
121   },
122   "counterpart_tax_id": "counterpart_tax_id",
123   "counterpart_vat_id": {
124     "id": "id",
125     "counterpart_id": "counterpart_id",
126     "value": "123456789",
127     "country": "AF",
128     "type": "ae_trn"
129   },
130   "deduction_amount": 1,
131   "deduction_memo": "deduction_memo",
132   "discount": {
133     "amount": 1,
134     "type": "amount",
135     "value": 1
136   },
137   "discounted_subtotal": 1,
138   "document_id": "document_id",
139   "due_date": "due_date",
140   "einvoice_file_url": "einvoice_file_url",
141   "entity_bank_account": {
142     "id": "id",
143     "account_holder_name": "account_holder_name",
144     "account_number": "account_number",
145     "bank_name": "bank_name",
146     "bic": "bic",
147     "iban": "iban",
148     "routing_number": "routing_number",
149     "sort_code": "sort_code"
150   },
151   "entity_user_id": "entity_user_id",
152   "entity_vat_id": {
153     "id": "id",
154     "country": "AF",
155     "entity_id": "entity_id",
156     "value": "123456789",
157     "type": "ae_trn"
158   },
159   "expiry_date": "expiry_date",
160   "file_url": "file_url",
161   "footer": "footer",
162   "issue_date": "2024-01-15T09:30:00Z",
163   "memo": "memo",
164   "original_file_url": "original_file_url",
165   "partner_metadata": {
166     "key": "value"
167   },
168   "project_id": "project_id",
169   "quote_accept_page_url": "quote_accept_page_url",
170   "signature_required": true,
171   "subtotal": 1,
172   "subtotal_after_vat": 1,
173   "tags": [
174     {
175       "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
176       "created_at": "2022-09-07T16:35:18Z",
177       "updated_at": "2022-09-07T16:35:18Z",
178       "name": "Marketing",
179       "category": "document_type",
180       "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
181       "description": "Tag for the Marketing Department"
182     }
183   ],
184   "total_amount": 1,
185   "total_vat_amounts": [
186     {
187       "amount": 1,
188       "taxable_amount": 1,
189       "value": 1,
190       "id": "id",
191       "components": [
192         {
193           "name": "name",
194           "value": 1.1,
195           "amount": 1
196         }
197       ],
198       "name": "name"
199     }
200   ],
201   "total_withholding_tax": 1,
202   "trade_name": "trade_name",
203   "vat_exempt": true,
204   "vat_exemption_rationale": "vat_exemption_rationale",
205   "vat_inclusive_discount_mode": "exclusive",
206   "vat_mode": "exclusive",
207   "withholding_tax_rate": 1
208 }

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

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.

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

quoteobject

invoiceobject

credit_noteobject

Path parameters

Headers

Request

Response

Errors