Mark an invoice as paid

POST

/receivables/:receivable_id/mark_as_paid

POST

/v1/receivables/:receivable_id/mark_as_paid

1 curl -X POST https://api.sandbox.monite.com/v1/receivables/receivable_id/mark_as_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 '{}'

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

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 explaining how the payment was made.

paid_atdatetimeOptional

Date and time when the invoice was paid.

Response

Successful Response

quoteobject

invoiceobject

credit_noteobject

Path parameters

Headers

Request

Response

Errors