Get payables — Monite Documentation

Lists all payables from the connected entity.

If you already have the data of the payable (amount in minor units, currency, vendor information, and other details) stored somewhere as individual attributes, you can create a payable with these attributes by calling POST /payables and providing the base64-encoded contents of the original invoice file in the field base64_encoded_file.

A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and demanding payment.

The file_name field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured to automatically set suggested_payment_term, this object can be omitted from the request body.

The id generated for this payable can be used in other API calls to update the data of this payable or trigger status transitions, for example. essential data fields to move from draft to new

Related guide: Create a payable from data

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>=1<=100

Max is 100

pagination_tokenstringOptional

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

sort"id" or "created_at"Optional

Allowed sort fields

Allowed values: idcreated_at

created_at__gtdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__ltdatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__gtedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

created_at__ltedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

statusenumOptional

status__inenumOptional

id__instringOptional

total_amountintegerOptional

total_amount__gtintegerOptional

total_amount__ltintegerOptional

total_amount__gteintegerOptional

total_amount__lteintegerOptional

amountintegerOptional

amount__gtintegerOptional

amount__ltintegerOptional

amount__gteintegerOptional

amount__lteintegerOptional

currencyenumOptional

counterpart_namestringOptional

counterpart_name__containsstringOptional

counterpart_name__icontainsstringOptional

search_textstringOptional

due_datestringOptional

due_date__gtstringOptional

due_date__ltstringOptional

due_date__gtestringOptional

due_date__ltestringOptional

document_idstringOptional

document_id__containsstringOptional

document_id__icontainsstringOptional

was_created_by_user_idstringOptional

counterpart_idstringOptional

source_of_payable_data"ocr" or "user_specified"Optional

Allowed values: ocruser_specified

ocr_statusenumOptional

Allowed values: processingerrorsuccess

line_item_idstringOptional

Search for a payable by the identifier of the line item associated with it.

purchase_order_idstringOptional

Search for a payable by the identifier of the purchase order associated with it.

project_idstringOptional

Search for a payable by the identifier of the project associated with it.

tag_idsstringOptional

Search for a payable by the identifiers of the tags associated with it.

Response

Successful Response

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

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

1 { 2 "data": [ 3 { 4 "id": "id", 5 "created_at": "2024-01-15T09:30:00Z", 6 "updated_at": "2024-01-15T09:30:00Z", 7 "entity_id": "entity_id", 8 "payable_origin": "upload", 9 "source_of_payable_data": "ocr", 10 "status": "draft", 11 "amount_due": 1000, 12 "amount_paid": 1000, 13 "amount_to_pay": 1000, 14 "approval_policy_id": "approval_policy_id", 15 "counterpart": { 16 "email": "acme@example.com", 17 "name": "Acme Inc.", 18 "phone": "5551231234", 19 "tax_id": "DE12345678" 20 }, 21 "counterpart_address_id": "counterpart_address_id", 22 "counterpart_bank_account_id": "counterpart_bank_account_id", 23 "counterpart_id": "counterpart_id", 24 "counterpart_raw_data": { 25 "email": "acme@example.com", 26 "name": "Acme Inc.", 27 "phone": "5551231234", 28 "tax_id": "DE12345678" 29 }, 30 "counterpart_vat_id_id": "counterpart_vat_id_id", 31 "created_by_role_id": "created_by_role_id", 32 "currency": "AED", 33 "currency_exchange": { 34 "default_currency_code": "default_currency_code", 35 "rate": 1.1, 36 "total": 1.1 37 }, 38 "description": "description", 39 "discount": 500, 40 "document_id": "DE2287", 41 "due_date": "due_date", 42 "file": { 43 "id": "id", 44 "created_at": "2024-01-15T09:30:00Z", 45 "file_type": "payables", 46 "name": "invoice.pdf", 47 "region": "eu-central-1", 48 "md5": "31d1a2dd1ad3dfc39be849d70a68dac0", 49 "mimetype": "application/pdf", 50 "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf", 51 "size": 24381, 52 "previews": [ 53 { 54 "url": "https://bucketname.s3.amazonaws.com/1/2/3.png", 55 "width": 200, 56 "height": 400 57 } 58 ], 59 "pages": [ 60 { 61 "id": "id", 62 "mimetype": "image/png", 63 "size": 21972, 64 "number": 0, 65 "url": "https://bucket.s3.amazonaws.com/123/456.png" 66 } 67 ] 68 }, 69 "file_id": "file_id", 70 "issued_at": "issued_at", 71 "marked_as_paid_by_entity_user_id": "71e8875a-43b3-434f-b12a-54c84c176ef3", 72 "marked_as_paid_with_comment": "Was paid partly in the end of the month.", 73 "ocr_request_id": "ocr_request_id", 74 "ocr_status": "processing", 75 "other_extracted_data": { 76 "total": 7000, 77 "total_paid_amount_raw": 50, 78 "total_raw": 70, 79 "total_excl_vat": 7700, 80 "total_excl_vat_raw": 77, 81 "total_vat_amount": 700, 82 "total_vat_amount_raw": 7, 83 "total_vat_rate": 1250, 84 "total_vat_rate_raw": 12.5, 85 "currency": "EUR", 86 "purchase_order_number": "1234", 87 "counterpart_name": "Monite GMbH", 88 "counterpart_account_id": "DEUTDEFF", 89 "document_id": "CST-13341", 90 "tax_payer_id": "12345678901", 91 "counterpart_vat_id": "DE88939004" 92 }, 93 "paid_at": "2024-01-15T09:30:00Z", 94 "partner_metadata": { 95 "key": "value" 96 }, 97 "payment_terms": { 98 "name": "name", 99 "term_final": { 100 "number_of_days": 1 101 } 102 }, 103 "project_id": "project_id", 104 "purchase_order_id": "purchase_order_id", 105 "sender": "hello@example.com", 106 "subtotal": 1250, 107 "suggested_payment_term": { 108 "date": "date" 109 }, 110 "tags": [ 111 { 112 "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 113 "created_at": "2022-09-07T16:35:18Z", 114 "updated_at": "2022-09-07T16:35:18Z", 115 "name": "Marketing", 116 "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5", 117 "description": "Tag for the Marketing Department" 118 } 119 ], 120 "tax": 2000, 121 "tax_amount": 250, 122 "total_amount": 1500, 123 "was_created_by_user_id": "was_created_by_user_id" 124 } 125 ], 126 "next_pagination_token": "next_pagination_token", 127 "prev_pagination_token": "prev_pagination_token" 128 }

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

1	{
2	"data": [
3	{
4	"id": "id",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"entity_id": "entity_id",
8	"payable_origin": "upload",
9	"source_of_payable_data": "ocr",
10	"status": "draft",
11	"amount_due": 1000,
12	"amount_paid": 1000,
13	"amount_to_pay": 1000,
14	"approval_policy_id": "approval_policy_id",
15	"counterpart": {
16	"email": "acme@example.com",
17	"name": "Acme Inc.",
18	"phone": "5551231234",
19	"tax_id": "DE12345678"
20	},
21	"counterpart_address_id": "counterpart_address_id",
22	"counterpart_bank_account_id": "counterpart_bank_account_id",
23	"counterpart_id": "counterpart_id",
24	"counterpart_raw_data": {
25	"email": "acme@example.com",
26	"name": "Acme Inc.",
27	"phone": "5551231234",
28	"tax_id": "DE12345678"
29	},
30	"counterpart_vat_id_id": "counterpart_vat_id_id",
31	"created_by_role_id": "created_by_role_id",
32	"currency": "AED",
33	"currency_exchange": {
34	"default_currency_code": "default_currency_code",
35	"rate": 1.1,
36	"total": 1.1
37	},
38	"description": "description",
39	"discount": 500,
40	"document_id": "DE2287",
41	"due_date": "due_date",
42	"file": {
43	"id": "id",
44	"created_at": "2024-01-15T09:30:00Z",
45	"file_type": "payables",
46	"name": "invoice.pdf",
47	"region": "eu-central-1",
48	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
49	"mimetype": "application/pdf",
50	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
51	"size": 24381,
52	"previews": [
53	{
54	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
55	"width": 200,
56	"height": 400
57	}
58	],
59	"pages": [
60	{
61	"id": "id",
62	"mimetype": "image/png",
63	"size": 21972,
64	"number": 0,
65	"url": "https://bucket.s3.amazonaws.com/123/456.png"
66	}
67	]
68	},
69	"file_id": "file_id",
70	"issued_at": "issued_at",
71	"marked_as_paid_by_entity_user_id": "71e8875a-43b3-434f-b12a-54c84c176ef3",
72	"marked_as_paid_with_comment": "Was paid partly in the end of the month.",
73	"ocr_request_id": "ocr_request_id",
74	"ocr_status": "processing",
75	"other_extracted_data": {
76	"total": 7000,
77	"total_paid_amount_raw": 50,
78	"total_raw": 70,
79	"total_excl_vat": 7700,
80	"total_excl_vat_raw": 77,
81	"total_vat_amount": 700,
82	"total_vat_amount_raw": 7,
83	"total_vat_rate": 1250,
84	"total_vat_rate_raw": 12.5,
85	"currency": "EUR",
86	"purchase_order_number": "1234",
87	"counterpart_name": "Monite GMbH",
88	"counterpart_account_id": "DEUTDEFF",
89	"document_id": "CST-13341",
90	"tax_payer_id": "12345678901",
91	"counterpart_vat_id": "DE88939004"
92	},
93	"paid_at": "2024-01-15T09:30:00Z",
94	"partner_metadata": {
95	"key": "value"
96	},
97	"payment_terms": {
98	"name": "name",
99	"term_final": {
100	"number_of_days": 1
101	}
102	},
103	"project_id": "project_id",
104	"purchase_order_id": "purchase_order_id",
105	"sender": "hello@example.com",
106	"subtotal": 1250,
107	"suggested_payment_term": {
108	"date": "date"
109	},
110	"tags": [
111	{
112	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
113	"created_at": "2022-09-07T16:35:18Z",
114	"updated_at": "2022-09-07T16:35:18Z",
115	"name": "Marketing",
116	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
117	"description": "Tag for the Marketing Department"
118	}
119	],
120	"tax": 2000,
121	"tax_amount": 250,
122	"total_amount": 1500,
123	"was_created_by_user_id": "was_created_by_user_id"
124	}
125	],
126	"next_pagination_token": "next_pagination_token",
127	"prev_pagination_token": "prev_pagination_token"
128	}