GET
/
consumers
/
{consumer_id}
/
accounting
/
invoices
/
multi-analytic-plans
/
type
/
{invoice_type}

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

invoice_type
enum<string>
required

An enumeration.

Available options:
customer_invoice,
customer_refund,
supplier_invoice,
supplier_refund
consumer_id
string
required

Query Parameters

date_from
string
date_to
string
journal_ids
string

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

include_payments
enum<string>
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>
default:
all

Extra filter to retrieve invoices with a specific payment status.

Available options:
all,
unpaid,
paid
updated_after
string

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.

folder_id
string

Accounting folder ID, this needs to be passed when activating the multiple folders feature.

page
integer
default:
1
Required range: x > 1
size
integer
default:
50
Required range: 1 < x < 100

Response

200 - application/json
items
object[]
required
page
integer
required
Required range: x > 1
size
integer
required
Required range: x > 1
total
integer
required
Required range: x > 0