Get receivables

GET

Headers

Auth

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.

Query parameters

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

id__instringOptional

status__inenumOptional

entity_user_id__instringOptional

sortenumOptional

Allowed sort fields

tag_ids__instringOptional

typeenumOptional

Allowed values: quoteinvoicecredit_note

document_idstringOptional

document_id__containsstringOptional

document_id__icontainsstringOptional

issue_date__gtdatetimeOptional

issue_date__ltdatetimeOptional

issue_date__gtedatetimeOptional

issue_date__ltedatetimeOptional

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

counterpart_idstringOptional

counterpart_namestringOptional

counterpart_name__containsstringOptional

counterpart_name__icontainsstringOptional

total_amountintegerOptional

total_amount__gtintegerOptional

total_amount__ltintegerOptional

total_amount__gteintegerOptional

total_amount__lteintegerOptional

statusenumOptional

entity_user_idstringOptional

based_onstringOptional

due_date__gtstringOptional

due_date__ltstringOptional

due_date__gtestringOptional

due_date__ltestringOptional

project_idstringOptional

Response

This endpoint returns an object

datalist of objects

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

GET

1 curl https://api.sandbox.monite.com/v1/receivables \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "type": "credit_note",
5       "counterpart_id": "data",
6       "counterpart_type": "individual",
7       "created_at": "2024-01-15T09:30:00Z",
8       "currency": "AED",
9       "entity": {
10         "type": "individual",
11         "first_name": "data",
12         "last_name": "data"
13       },
14       "entity_address": {
15         "city": "city",
16         "line1": "line1",
17         "postal_code": "postal_code"
18       },
19       "file_language": "ab",
20       "id": "data",
21       "line_items": [
22         {
23           "product": {
24             "id": "id",
25             "created_at": "2024-01-15T09:30:00Z",
26             "updated_at": "2024-01-15T09:30:00Z",
27             "entity_id": "entity_id",
28             "name": "name",
29             "price": {
30               "currency": "AED",
31               "value": 1
32             },
33             "price_after_vat": {
34               "currency": "AED",
35               "value": 1
36             },
37             "vat_rate": {
38               "country": "AF",
39               "value": 1
40             }
41           },
42           "quantity": 1.1
43         }
44       ],
45       "original_file_language": "ab",
46       "status": "draft",
47       "total_vat_amount": 1,
48       "updated_at": "2024-01-15T09:30:00Z",
49       "based_on": "data",
50       "based_on_document_id": "data",
51       "commercial_condition_description": "data",
52       "counterpart_billing_address": {
53         "city": "Berlin",
54         "country": "AF",
55         "line1": "Flughafenstrasse 52",
56         "postal_code": "10115"
57       },
58       "counterpart_business_type": "data",
59       "counterpart_contact": {
60         "address": {
61           "city": "Berlin",
62           "country": "AF",
63           "line1": "Flughafenstrasse 52",
64           "postal_code": "10115"
65         },
66         "first_name": "Marge",
67         "last_name": "Smith",
68         "email": "marge@example.org",
69         "phone": "55512378654",
70         "title": "Dr."
71       },
72       "counterpart_name": "data",
73       "counterpart_shipping_address": {
74         "city": "Berlin",
75         "country": "AF",
76         "line1": "Flughafenstrasse 52",
77         "postal_code": "10115"
78       },
79       "counterpart_tax_id": "data",
80       "counterpart_vat_id": {
81         "id": "id",
82         "counterpart_id": "counterpart_id",
83         "value": "123456789"
84       },
85       "deduction_amount": 1,
86       "deduction_memo": "data",
87       "discount": {
88         "amount": 1,
89         "type": "amount"
90       },
91       "discounted_subtotal": 1,
92       "document_id": "data",
93       "due_date": "data",
94       "entity_user_id": "data",
95       "entity_vat_id": {
96         "id": "id",
97         "country": "AF",
98         "entity_id": "entity_id",
99         "value": "123456789"
100       },
101       "file": {
102         "id": "id",
103         "created_at": "2024-01-15T09:30:00Z",
104         "file_type": "payables",
105         "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
106         "mimetype": "application/pdf",
107         "name": "invoice.pdf",
108         "region": "eu-central-1",
109         "size": 24381,
110         "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
111         "pages": [
112           {
113             "id": "id",
114             "mimetype": "image/png",
115             "number": 0,
116             "size": 21972,
117             "url": "https://bucket.s3.amazonaws.com/123/456.png"
118           }
119         ],
120         "previews": [
121           {
122             "height": 400,
123             "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
124             "width": 200
125           }
126         ]
127       },
128       "file_url": "data",
129       "issue_date": "2024-01-15T09:30:00Z",
130       "memo": "data",
131       "original_file_url": "data",
132       "partner_metadata": {
133         "key": "value"
134       },
135       "project_id": "data",
136       "purchase_order": "data",
137       "subtotal": 1,
138       "tags": [
139         {
140           "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
141           "created_at": "2022-09-07T16:35:18Z",
142           "updated_at": "2022-09-07T16:35:18Z",
143           "name": "Marketing",
144           "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
145           "description": "Tag for the Marketing Department"
146         }
147       ],
148       "total_amount": 1,
149       "total_vat_amounts": [
150         {
151           "amount": 1,
152           "value": 1
153         }
154       ],
155       "total_withholding_tax": 1,
156       "trade_name": "data",
157       "vat_exempt": true,
158       "vat_exemption_rationale": "data",
159       "vat_mode": "exclusive",
160       "withholding_tax_rate": 1
161     }
162   ],
163   "next_pagination_token": "next_pagination_token",
164   "prev_pagination_token": "prev_pagination_token"
165 }

1	curl https://api.sandbox.monite.com/v1/receivables \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"type": "credit_note",
5	"counterpart_id": "data",
6	"counterpart_type": "individual",
7	"created_at": "2024-01-15T09:30:00Z",
8	"currency": "AED",
9	"entity": {
10	"type": "individual",
11	"first_name": "data",
12	"last_name": "data"
13	},
14	"entity_address": {
15	"city": "city",
16	"line1": "line1",
17	"postal_code": "postal_code"
18	},
19	"file_language": "ab",
20	"id": "data",
21	"line_items": [
22	{
23	"product": {
24	"id": "id",
25	"created_at": "2024-01-15T09:30:00Z",
26	"updated_at": "2024-01-15T09:30:00Z",
27	"entity_id": "entity_id",
28	"name": "name",
29	"price": {
30	"currency": "AED",
31	"value": 1
32	},
33	"price_after_vat": {
34	"currency": "AED",
35	"value": 1
36	},
37	"vat_rate": {
38	"country": "AF",
39	"value": 1
40	}
41	},
42	"quantity": 1.1
43	}
44	],
45	"original_file_language": "ab",
46	"status": "draft",
47	"total_vat_amount": 1,
48	"updated_at": "2024-01-15T09:30:00Z",
49	"based_on": "data",
50	"based_on_document_id": "data",
51	"commercial_condition_description": "data",
52	"counterpart_billing_address": {
53	"city": "Berlin",
54	"country": "AF",
55	"line1": "Flughafenstrasse 52",
56	"postal_code": "10115"
57	},
58	"counterpart_business_type": "data",
59	"counterpart_contact": {
60	"address": {
61	"city": "Berlin",
62	"country": "AF",
63	"line1": "Flughafenstrasse 52",
64	"postal_code": "10115"
65	},
66	"first_name": "Marge",
67	"last_name": "Smith",
68	"email": "marge@example.org",
69	"phone": "55512378654",
70	"title": "Dr."
71	},
72	"counterpart_name": "data",
73	"counterpart_shipping_address": {
74	"city": "Berlin",
75	"country": "AF",
76	"line1": "Flughafenstrasse 52",
77	"postal_code": "10115"
78	},
79	"counterpart_tax_id": "data",
80	"counterpart_vat_id": {
81	"id": "id",
82	"counterpart_id": "counterpart_id",
83	"value": "123456789"
84	},
85	"deduction_amount": 1,
86	"deduction_memo": "data",
87	"discount": {
88	"amount": 1,
89	"type": "amount"
90	},
91	"discounted_subtotal": 1,
92	"document_id": "data",
93	"due_date": "data",
94	"entity_user_id": "data",
95	"entity_vat_id": {
96	"id": "id",
97	"country": "AF",
98	"entity_id": "entity_id",
99	"value": "123456789"
100	},
101	"file": {
102	"id": "id",
103	"created_at": "2024-01-15T09:30:00Z",
104	"file_type": "payables",
105	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
106	"mimetype": "application/pdf",
107	"name": "invoice.pdf",
108	"region": "eu-central-1",
109	"size": 24381,
110	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
111	"pages": [
112	{
113	"id": "id",
114	"mimetype": "image/png",
115	"number": 0,
116	"size": 21972,
117	"url": "https://bucket.s3.amazonaws.com/123/456.png"
118	}
119	],
120	"previews": [
121	{
122	"height": 400,
123	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
124	"width": 200
125	}
126	]
127	},
128	"file_url": "data",
129	"issue_date": "2024-01-15T09:30:00Z",
130	"memo": "data",
131	"original_file_url": "data",
132	"partner_metadata": {
133	"key": "value"
134	},
135	"project_id": "data",
136	"purchase_order": "data",
137	"subtotal": 1,
138	"tags": [
139	{
140	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
141	"created_at": "2022-09-07T16:35:18Z",
142	"updated_at": "2022-09-07T16:35:18Z",
143	"name": "Marketing",
144	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
145	"description": "Tag for the Marketing Department"
146	}
147	],
148	"total_amount": 1,
149	"total_vat_amounts": [
150	{
151	"amount": 1,
152	"value": 1
153	}
154	],
155	"total_withholding_tax": 1,
156	"trade_name": "data",
157	"vat_exempt": true,
158	"vat_exemption_rationale": "data",
159	"vat_mode": "exclusive",
160	"withholding_tax_rate": 1
161	}
162	],
163	"next_pagination_token": "next_pagination_token",
164	"prev_pagination_token": "prev_pagination_token"
165	}