Search invoices with given parameters
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": null,
"limit": 20
},
"query": {
"auto_charges": null,
"billed_customer_id": null,
"currency": null,
"customer_id": null,
"due": {
"eq": null,
"gte": null,
"lte": null
},
"due_date": {
"eq": null,
"gte": null,
"lte": null
},
"hide_zero": null,
"invoice_date": {
"eq": null,
"gte": null,
"lte": null
},
"invoice_number": null,
"invoice_sent": null,
"managed_externally": null,
"paid": {
"eq": null,
"gte": null,
"lte": null
},
"paid_date": {
"eq": null,
"gte": null,
"lte": null
},
"payment_methods": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"search": null,
"status": null,
"statuses": [
"<string>"
],
"subscription_id": null,
"total": {
"eq": null,
"gte": null,
"lte": null
},
"uuid": null
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": null,
"limit": 123
},
"results": [
{
"auto_charges": true,
"billed_customer_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer_id": "<string>",
"due": {
"currency": "<string>",
"value_in_cents": 123
},
"due_date": "2023-11-07T05:31:56Z",
"hosted_link": null,
"invoice_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>",
"paid": {
"currency": "<string>",
"value_in_cents": 123
},
"paid_date": null,
"pdf_link": null,
"prorated_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"status": "<string>",
"sub_total": {
"currency": "<string>",
"value_in_cents": 123
},
"subscription_id": null,
"total": {
"currency": "<string>",
"value_in_cents": 123
},
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The idempotency key that will be used to ensure the request is only performed once
The company ID with the prefix 'cmp_'.
OK
The response is of type object
.
curl --request POST \
--url https://api.maplebilling.com/api/v1/companies/{company_id}/invoices/find \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"include_meta": true,
"pagination": {
"from_key": null,
"limit": 20
},
"query": {
"auto_charges": null,
"billed_customer_id": null,
"currency": null,
"customer_id": null,
"due": {
"eq": null,
"gte": null,
"lte": null
},
"due_date": {
"eq": null,
"gte": null,
"lte": null
},
"hide_zero": null,
"invoice_date": {
"eq": null,
"gte": null,
"lte": null
},
"invoice_number": null,
"invoice_sent": null,
"managed_externally": null,
"paid": {
"eq": null,
"gte": null,
"lte": null
},
"paid_date": {
"eq": null,
"gte": null,
"lte": null
},
"payment_methods": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_ids": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_pricing_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"product_tags": {
"condition": "AND",
"values": [
"<string>"
]
},
"search": null,
"status": null,
"statuses": [
"<string>"
],
"subscription_id": null,
"total": {
"eq": null,
"gte": null,
"lte": null
},
"uuid": null
},
"sort_key": "createdAtDesc"
}'
{
"pagination": {
"from_key": null,
"limit": 123
},
"results": [
{
"auto_charges": true,
"billed_customer_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"customer_id": "<string>",
"due": {
"currency": "<string>",
"value_in_cents": 123
},
"due_date": "2023-11-07T05:31:56Z",
"hosted_link": null,
"invoice_date": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>",
"paid": {
"currency": "<string>",
"value_in_cents": 123
},
"paid_date": null,
"pdf_link": null,
"prorated_amount": {
"currency": "<string>",
"value_in_cents": 123
},
"status": "<string>",
"sub_total": {
"currency": "<string>",
"value_in_cents": 123
},
"subscription_id": null,
"total": {
"currency": "<string>",
"value_in_cents": 123
},
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
]
}