Create Aggregation

post

https://api.instellix.io/v2/billing/configuration/aggregation

Create a new aggregation configuration. Aggregation configurations are an additional post processing to sum up the item amounts by certain criterias. For example BY_TAX_RATE would sum up the values of the items (rowTotalExclusiveVat, rowTotalInclusiveVat, ...) grouped by the tax rates of the items. Only one configuration per invoiceType is possible.

Body Params

Please see AggregationConfigurationCreationRequest Model below for more information regarding required values and input type. Only one configuration per operatingSiteIdent possible.

aggregationConfigurationIdent

string

required

length between 1 and 100

Unique external reference. Must not be null. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

aggregationStrategies

array of strings

required

length ≥ 1

List of applied aggregations. Must not be empty.

aggregationStrategies*

List of applied aggregations.

aggregationStrategiesExtended

array of objects | null

List of additional custom aggregations on already applied aggregations, to aggregate results of those aggregations, e.g., aggregate Subtotals with itemGroups containing the subTotalSum.grouping_field_value "Test" and "Test2".

aggregationStrategiesExtended

invoiceType

string

required

Type of document for which the aggregation shall be used. Must not be null. Must be one of:


invoice
creditmemo
order
depositinvoice
depositinvoicecancellation
creditmemo_goodwill
creditmemo_warranty
self_billing_invoice
self_billing_invoice_correction

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX