Skip to main content

Invoice Aggregation Record

This node contains information related to aggregation. This can specify if the invoice is part of an aggregation parent invoice or if it is a parent itself. Contained in Invoice Document Record

isChild

True if the invoice was aggregated into a parent invoice.

bool

isParent

True if the invoice is an aggregation parent. This means that it aggregates child invoices. An invoice cannot be both isClient and isParent.

Note: The invoice document includes references to all child invoices for parents.

bool

parentInvoiceId

If the invoice is a child then this is the ID of the parent invoice.

int?

periodFrom

The period start of aggregation (year-month-day). Populated with child and parent invoices only.

date

periodTo

The period end of aggregation (year-month-day). Populated with child and parent invoices only.

date

EXAMPLES

Example payload:

CODE
{
    "isChild": false,
    "isParent": false,
    "parentInvoiceId": null,
    "periodFrom": null,
    "periodTo": null
}

An aggregation parent:

CODE
{
    "isChild": false,
    "isParent": true,
    "parentInvoiceId": null,
    "periodFrom": "2020-12-04",
    "periodTo": "2020-12-04"
}

An aggregation child:

CODE
{
    "isChild": true,
    "isParent": false,
    "parentInvoiceId": 1835,
    "periodFrom": "2020-12-04",
    "periodTo": "2020-12-04"
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.