Create a receivable

POST

/receivables

POST

/v1/receivables

1 curl -X POST https://api.sandbox.monite.com/v1/receivables \
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   "counterpart_id": "counterpart_id",
8   "currency": "AED",
9   "line_items": [
10     {
11       "quantity": 1.1,
12       "vat_rate_id": "vat_rate_id"
13     }
14   ],
15   "type": "quote"
16 }'

Try it

201Created

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

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.

objectRequired

Response

Successful Response

quoteobject

invoiceobject

credit_noteobject

Headers

Request

Response

Errors