Get a receivable by ID

GET

/receivables/:receivable_id

GET

/v1/receivables/:receivable_id

1 curl https://api.sandbox.monite.com/v1/receivables/receivable_id \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

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   "attachments": [
82     {
83       "id": "id",
84       "mimetype": "application/pdf",
85       "name": "timesheet.pdf",
86       "size": 120101,
87       "url": "https://bucketname.s3.amazonaws.com/path/to/timesheet.pdf",
88       "include_in_email": true
89     }
90   ],
91   "based_on": "based_on",
92   "based_on_document_id": "based_on_document_id",
93   "comment": "comment",
94   "commercial_condition_description": "commercial_condition_description",
95   "counterpart_billing_address": {
96     "city": "Berlin",
97     "country": "AF",
98     "line1": "Flughafenstrasse 52",
99     "postal_code": "10115",
100     "id": "id",
101     "line2": "line2",
102     "state": "state"
103   },
104   "counterpart_business_type": "counterpart_business_type",
105   "counterpart_contact": {
106     "address": {
107       "city": "Berlin",
108       "country": "AF",
109       "line1": "Flughafenstrasse 52",
110       "postal_code": "10115",
111       "id": "id",
112       "line2": "line2",
113       "state": "state"
114     },
115     "first_name": "Marge",
116     "last_name": "Smith",
117     "email": "marge@example.org",
118     "phone": "55512378654",
119     "title": "Dr."
120   },
121   "counterpart_external_reference": "counterpart_external_reference",
122   "counterpart_name": "counterpart_name",
123   "counterpart_shipping_address": {
124     "city": "Berlin",
125     "country": "AF",
126     "line1": "Flughafenstrasse 52",
127     "postal_code": "10115",
128     "id": "id",
129     "line2": "line2",
130     "state": "state"
131   },
132   "counterpart_tax_id": "counterpart_tax_id",
133   "counterpart_vat_id": {
134     "id": "id",
135     "counterpart_id": "counterpart_id",
136     "value": "123456789",
137     "country": "AF",
138     "type": "ae_trn"
139   },
140   "deduction_amount": 1,
141   "deduction_memo": "deduction_memo",
142   "discount": {
143     "amount": 1,
144     "type": "amount",
145     "value": 1
146   },
147   "discounted_subtotal": 1,
148   "document_id": "document_id",
149   "document_rendering": {
150     "credit_note": {
151       "display_entity_bank_account": true
152     },
153     "display_entity_bank_account": true,
154     "display_line_items": true,
155     "invoice": {
156       "display_entity_bank_account": true
157     },
158     "line_items": {
159       "discount": {
160         "display": true,
161         "label": "label"
162       },
163       "measure_unit": {
164         "display": true,
165         "label": "label"
166       },
167       "name": {
168         "display": true,
169         "label": "label"
170       },
171       "price": {
172         "display": true,
173         "label": "label",
174         "precision": 1
175       },
176       "price_after_vat": {
177         "display": true,
178         "label": "label",
179         "precision": 1
180       },
181       "quantity": {
182         "display": true,
183         "label": "label"
184       },
185       "total_price": {
186         "display": true,
187         "label": "label",
188         "precision": 1
189       },
190       "total_price_after_vat": {
191         "display": true,
192         "label": "label",
193         "precision": 1
194       },
195       "vat_amount": {
196         "display": true,
197         "label": "label",
198         "precision": 1
199       },
200       "vat_rate": {
201         "display": true,
202         "label": "label",
203         "precision": 1
204       }
205     },
206     "quote": {
207       "display_entity_bank_account": true,
208       "display_signature": true
209     }
210   },
211   "due_date": "due_date",
212   "einvoice_file_url": "einvoice_file_url",
213   "entity_bank_account": {
214     "id": "id",
215     "account_holder_name": "account_holder_name",
216     "account_number": "account_number",
217     "bank_name": "bank_name",
218     "bic": "bic",
219     "iban": "iban",
220     "routing_number": "routing_number",
221     "sort_code": "sort_code"
222   },
223   "entity_user_id": "entity_user_id",
224   "entity_vat_id": {
225     "id": "id",
226     "country": "AF",
227     "entity_id": "entity_id",
228     "value": "123456789",
229     "type": "ae_trn"
230   },
231   "expiry_date": "expiry_date",
232   "file_url": "file_url",
233   "footer": "footer",
234   "issue_date": "2024-01-15T09:30:00Z",
235   "memo": "memo",
236   "original_file_url": "original_file_url",
237   "partner_metadata": {
238     "key": "value"
239   },
240   "project_id": "project_id",
241   "quote_accept_page_url": "quote_accept_page_url",
242   "signature_required": true,
243   "subtotal": 1,
244   "subtotal_after_vat": 1,
245   "tags": [
246     {
247       "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
248       "created_at": "2022-09-07T16:35:18Z",
249       "updated_at": "2022-09-07T16:35:18Z",
250       "name": "Marketing",
251       "category": "document_type",
252       "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
253       "description": "Tag for the Marketing Department"
254     }
255   ],
256   "total_amount": 1,
257   "total_vat_amounts": [
258     {
259       "amount": 1,
260       "taxable_amount": 1,
261       "value": 1,
262       "id": "id",
263       "components": [
264         {
265           "amount": 1,
266           "name": "name",
267           "value": 1.1
268         }
269       ],
270       "name": "name"
271     }
272   ],
273   "total_withholding_tax": 1,
274   "trade_name": "trade_name",
275   "vat_exempt": true,
276   "vat_exemption_rationale": "vat_exemption_rationale",
277   "vat_inclusive_discount_mode": "exclusive",
278   "vat_mode": "exclusive",
279   "withholding_tax_rate": 1
280 }

Returns the details of an existing accounts receivable invoice, quote, or credit note with the specified ID.

The response fields vary depending on the document type. Use the type field to distinguish between different document types.

Entity users with the receivable.read.allowed_for_own permission (rather than allowed) can access only documents that they created themselves.

Path parameters

receivable_idstringRequired

ID of an existing invoice, quote, or credit note that you want to retrieve.

Response

Successful Response

quoteobject

invoiceobject

credit_noteobject

Get a receivable by ID

Path parameters

Headers

Response

Errors