Page Comparison

ids

An array of integer ids, each belonging to an Invoice

For example:

[1, 23, 456]

See detailed description further downYou can include up to 20,000 elements.

object[], Mandatory

periodFrom

Start date of the financial period for invoice aggregation.

Only invoices with an EffectiveDate on or after this date will be included.

Example (ISO date strings):

"2024-07-14"
"2024-07-14T15:30:00"
"2024-07-14T15:30:00Z"

DateTime, Mandatory

periodTo

End date of the financial period for invoice aggregation.

Only invoices with an EffectiveDate on or before this date will be included.

Example (ISO date strings):

"2024-11-14"
"2024-11-14T15:30:00"
"2024-11-14T15:30:00Z"

DateTime, Mandatory

isClientInvoices

Determines whether to aggregate client invoices or supplier invoices.

• true: Aggregates client invoices only, and ignores supplier invoices

• false: Aggregates supplier invoices only, and ignores client invoices

bool, Optional

doNotAggregateSingle

Controls whether to skip aggregation of single invoices. Defaults to true

Single invoices can result from sending a single invoice id, or from a group of company+currency+vat

bool, Optional