Skip to main content
GET
Get invoices by type (sale/purchase entries - Multiple Analytic Plans)

Path Parameters

consumer_id
string<uuid>
required
invoice_type
enum<string>
required
Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

date_from
string<date> | null
date_to
string<date> | null
journal_ids
string | null

Journal Ids used to filter the invoices. The Ids are separated by ','

include_payments
enum<string> | null
default:false

Indicate if payments linked to the invoices should be included in the response. By default payments are not included and the field payments is null.

Available options:
true,
false
payment_status
enum<string> | null
default:all

Extra filter to retrieve invoices with a specific payment status.

Available options:
all,
unpaid,
paid
updated_after
string<date-time> | null

Retrieve invoices created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

include_invoice_lines
enum<string> | null
default:false

Indicate if invoice lines should be included in the response. By default invoice lines are not included when this requires extra requests on the target API.

Available options:
true,
false
include_partner_info
enum<string> | null
default:false

Indicate if partner (client/supplier) information should be included in the response. By default partner information is not included when it requires extra requests on the target API to be retrieved.

Available options:
true,
false
approval_status
enum<string> | null

Filter invoices by approval status.

Available options:
pending,
approved,
rejected

Response

Successful Response

items
InvoiceItemOutMultiAnalyticPlans · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1