Create a receivable

POST

/receivables

POST

/v1/receivables

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

Try it

201Created

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

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.

Receivable Facade Create Quote PayloadobjectRequired

Receivable Facade Create Invoice PayloadobjectRequired

Receivable Create Based on PayloadobjectRequired

Response

Successful Response

quoteobject

invoiceobject

credit_noteobject

Headers

Request

Response

Errors