Get a receivable by ID

Successful Response

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>"

1 { 2 "type": "credit_note", 3 "counterpart_id": "string", 4 "counterpart_type": "individual", 5 "created_at": "2024-01-15T09:30:00Z", 6 "currency": "AED", 7 "entity": { 8 "type": "individual", 9 "first_name": "string", 10 "last_name": "string", 11 "email": "string", 12 "logo": "string", 13 "phone": "string", 14 "tax_id": "string", 15 "website": "string" 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": "string", 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 } 44 }, 45 "quantity": 1.1, 46 "discount": { 47 "amount": 1, 48 "type": "amount" 49 }, 50 "total_before_vat": 1 51 } 52 ], 53 "original_file_language": "ab", 54 "status": "draft", 55 "total_vat_amount": 1, 56 "updated_at": "2024-01-15T09:30:00Z", 57 "based_on": "string", 58 "based_on_document_id": "string", 59 "commercial_condition_description": "string", 60 "counterpart_billing_address": { 61 "city": "Berlin", 62 "country": "AF", 63 "line1": "Flughafenstrasse 52", 64 "postal_code": "10115", 65 "id": "id", 66 "line2": "line2", 67 "state": "state" 68 }, 69 "counterpart_business_type": "string", 70 "counterpart_contact": { 71 "address": { 72 "city": "Berlin", 73 "country": "AF", 74 "line1": "Flughafenstrasse 52", 75 "postal_code": "10115", 76 "id": "id", 77 "line2": "line2", 78 "state": "state" 79 }, 80 "first_name": "Marge", 81 "last_name": "Smith", 82 "email": "marge@example.org", 83 "phone": "55512378654", 84 "title": "Dr." 85 }, 86 "counterpart_name": "string", 87 "counterpart_shipping_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 "counterpart_tax_id": "string", 97 "counterpart_vat_id": { 98 "id": "id", 99 "counterpart_id": "counterpart_id", 100 "value": "123456789", 101 "country": "AF", 102 "type": "ae_trn" 103 }, 104 "deduction_amount": 1, 105 "deduction_memo": "string", 106 "discount": { 107 "amount": 1, 108 "type": "amount" 109 }, 110 "discounted_subtotal": 1, 111 "document_id": "string", 112 "due_date": "string", 113 "entity_bank_account": { 114 "id": "id", 115 "account_holder_name": "account_holder_name", 116 "account_number": "account_number", 117 "bank_name": "bank_name", 118 "bic": "bic", 119 "iban": "iban", 120 "routing_number": "routing_number", 121 "sort_code": "sort_code" 122 }, 123 "entity_user_id": "string", 124 "entity_vat_id": { 125 "id": "id", 126 "country": "AF", 127 "entity_id": "entity_id", 128 "value": "123456789", 129 "type": "ae_trn" 130 }, 131 "file_url": "string", 132 "issue_date": "2024-01-15T09:30:00Z", 133 "memo": "string", 134 "original_file_url": "string", 135 "partner_metadata": { 136 "key": "value" 137 }, 138 "project_id": "string", 139 "purchase_order": "string", 140 "subtotal": 1, 141 "tags": [ 142 { 143 "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 144 "created_at": "2022-09-07T16:35:18Z", 145 "updated_at": "2022-09-07T16:35:18Z", 146 "name": "Marketing", 147 "category": "document_type", 148 "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 149 "description": "Tag for the Marketing Department" 150 } 151 ], 152 "total_amount": 1, 153 "total_vat_amounts": [ 154 { 155 "amount": 1, 156 "value": 1, 157 "id": "id" 158 } 159 ], 160 "total_withholding_tax": 1, 161 "trade_name": "string", 162 "vat_exempt": true, 163 "vat_exemption_rationale": "string", 164 "vat_mode": "exclusive", 165 "withholding_tax_rate": 1 166 }

Path parameters

Headers

Response

Errors

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>"

1	{
2	"type": "credit_note",
3	"counterpart_id": "string",
4	"counterpart_type": "individual",
5	"created_at": "2024-01-15T09:30:00Z",
6	"currency": "AED",
7	"entity": {
8	"type": "individual",
9	"first_name": "string",
10	"last_name": "string",
11	"email": "string",
12	"logo": "string",
13	"phone": "string",
14	"tax_id": "string",
15	"website": "string"
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": "string",
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	}
44	},
45	"quantity": 1.1,
46	"discount": {
47	"amount": 1,
48	"type": "amount"
49	},
50	"total_before_vat": 1
51	}
52	],
53	"original_file_language": "ab",
54	"status": "draft",
55	"total_vat_amount": 1,
56	"updated_at": "2024-01-15T09:30:00Z",
57	"based_on": "string",
58	"based_on_document_id": "string",
59	"commercial_condition_description": "string",
60	"counterpart_billing_address": {
61	"city": "Berlin",
62	"country": "AF",
63	"line1": "Flughafenstrasse 52",
64	"postal_code": "10115",
65	"id": "id",
66	"line2": "line2",
67	"state": "state"
68	},
69	"counterpart_business_type": "string",
70	"counterpart_contact": {
71	"address": {
72	"city": "Berlin",
73	"country": "AF",
74	"line1": "Flughafenstrasse 52",
75	"postal_code": "10115",
76	"id": "id",
77	"line2": "line2",
78	"state": "state"
79	},
80	"first_name": "Marge",
81	"last_name": "Smith",
82	"email": "marge@example.org",
83	"phone": "55512378654",
84	"title": "Dr."
85	},
86	"counterpart_name": "string",
87	"counterpart_shipping_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	"counterpart_tax_id": "string",
97	"counterpart_vat_id": {
98	"id": "id",
99	"counterpart_id": "counterpart_id",
100	"value": "123456789",
101	"country": "AF",
102	"type": "ae_trn"
103	},
104	"deduction_amount": 1,
105	"deduction_memo": "string",
106	"discount": {
107	"amount": 1,
108	"type": "amount"
109	},
110	"discounted_subtotal": 1,
111	"document_id": "string",
112	"due_date": "string",
113	"entity_bank_account": {
114	"id": "id",
115	"account_holder_name": "account_holder_name",
116	"account_number": "account_number",
117	"bank_name": "bank_name",
118	"bic": "bic",
119	"iban": "iban",
120	"routing_number": "routing_number",
121	"sort_code": "sort_code"
122	},
123	"entity_user_id": "string",
124	"entity_vat_id": {
125	"id": "id",
126	"country": "AF",
127	"entity_id": "entity_id",
128	"value": "123456789",
129	"type": "ae_trn"
130	},
131	"file_url": "string",
132	"issue_date": "2024-01-15T09:30:00Z",
133	"memo": "string",
134	"original_file_url": "string",
135	"partner_metadata": {
136	"key": "value"
137	},
138	"project_id": "string",
139	"purchase_order": "string",
140	"subtotal": 1,
141	"tags": [
142	{
143	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
144	"created_at": "2022-09-07T16:35:18Z",
145	"updated_at": "2022-09-07T16:35:18Z",
146	"name": "Marketing",
147	"category": "document_type",
148	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
149	"description": "Tag for the Marketing Department"
150	}
151	],
152	"total_amount": 1,
153	"total_vat_amounts": [
154	{
155	"amount": 1,
156	"value": 1,
157	"id": "id"
158	}
159	],
160	"total_withholding_tax": 1,
161	"trade_name": "string",
162	"vat_exempt": true,
163	"vat_exemption_rationale": "string",
164	"vat_mode": "exclusive",
165	"withholding_tax_rate": 1
166	}