Create, retrieve, configure, and manage invoice groups (accounts) and their contacts.
List Invoice Group Events
Returns events for an invoice group that match the specified filter criteria. Use the request body to filter which events are returned. The response contains the matching event records.
List Invoice Group Events › Request Body
RequestIDRecordIDsEventsFromDateToDatePageLimitSortAscendingList Invoice Group Events › Responses
Success
Update Invoice Group Configuration
Partially updates invoice configuration for an invoice group (invoice collection/account) or for all invoice groups associated with a customer.
Provide either AccountGuid or CustomerGuid in the request body.
Use AccountGuid to update one invoice group. Use CustomerGuid to update all invoice groups associated with the customer.
Only the invoice settings included in the request are updated. Other settings remain unchanged.
The request can include settings such as distribution channel, administration fee, payment terms, manual approval, and related invoicing options.
When administration fee is enabled, the API verifies that the required administration fee product exists for the tenant. If the product is not configured, administration fee is disabled.
Update Invoice Group Configuration › Request Body
accountGuidcustomerGuidprintFeesecretLocationaccountOnHoldonHoldReasoninvoiceMinLimitpostingInfonotedistributionChannelpaymentTermsdueDaySettingTypeinvoiceDesigninvoiceMarkyourReferenceinvoiceIntervalprincipleinvoiceOpenJournalEntriesadministrationfeestandardMessageChannelrecognitionCodeautomaticRefundmanualApprovaleInvoiceReferenceeInvoiceBankOperatorInfonoDirectDebitinternalcustomerOnHoldUpdate Invoice Group Configuration › Responses
Invoice group configuration updated
Update Multiple Invoice Group Configurations
Partially updates invoice configuration for multiple invoice groups (invoice collections/accounts) or customers.
Each item in the request must identify the target by providing either AccountGuid or CustomerGuid.
Use AccountGuid to update one invoice group. Use CustomerGuid to update all invoice groups associated with the customer.
Only the invoice settings included in each item are updated. Other settings remain unchanged.
Update Multiple Invoice Group Configurations › Responses
Invoice group configurations updated
Get Invoice Group Query Parameters
Returns the set of supported search parameters that can be used to query invoice groups (invoice collections/accounts).
Use this endpoint to discover the available filter fields, their names, and default values before building a query.
The returned template can be populated and posted to the POST /accounts/query endpoint to search for matching invoice groups.
Get Invoice Group Query Parameters › Responses
Query Invoice Groups
Searches for invoice groups (invoice collections/accounts) that match the criteria provided in the request body.
Supply an AccountSearchParameters object to filter results by fields such as customer, distribution channel, payment terms, on-hold status, and other invoicing settings.
Call GET /accounts/query first to discover the available search parameters and their default values.
Results are paginated using the required page (zero-based) and size query parameters. page must be greater than or equal to 0 and size must be greater than 0.
Each match is returned as an InvoiceConfigGroupDto. An empty list is returned when no invoice groups match the criteria.
query Parameters
pagesizeQuery Invoice Groups › Responses
Matching invoice groups
guidnameaccountGuidThe unique identifier for the invoice collection associated with this invoice configuration.
customerGuidcustomerNameerpIdpaymentTermsdueDaySettingTypeinvoiceIntervalDaysinvoiceIntervalDaysType0 (AfterDayOfMonth), 1 (WeekDays).
invoiceMarkprintFeedistributionChannelmanualApprovalinvoiceDesignotherPayeryourReferenceinvoiceIntervalnotepostingInfostatus0 (Active), -1 (Ended).
principleinvoiceMinLimitinvoiceOpenJournalEntriesadministrationfeecustomerOnHoldaccountOnHoldonHoldReasonsecretLocationstandardMessageChannelrecognitionCodeemailcellphonestateMessagelastInvoiceDayotherPayerGuidautomaticRefundrestAmountGet Invoice Group
Returns the invoice group (invoice collection/account) configuration for the specified invoice group ID.
The response includes billing configuration such as distribution channel, payment terms, invoice interval, and on-hold status for both the invoice group and its associated customer. Contact details, bank accounts, and dimension data are also included where available.
path Parameters
accountGuidThe invoice group (invoice collection/account) ID.
Get Invoice Group › Responses
Success
guidnameaccountGuidThe unique identifier for the invoice collection associated with this invoice configuration.
customerGuidcustomerNameerpIdpaymentTermsdueDaySettingTypeinvoiceIntervalDaysinvoiceIntervalDaysType0 (AfterDayOfMonth), 1 (WeekDays).
invoiceMarkprintFeedistributionChannelmanualApprovalinvoiceDesignotherPayeryourReferenceinvoiceIntervalnotepostingInfostatus0 (Active), -1 (Ended).
principleinvoiceMinLimitinvoiceOpenJournalEntriesadministrationfeecustomerOnHoldaccountOnHoldonHoldReasonsecretLocationstandardMessageChannelrecognitionCodeemailcellphonestateMessagelastInvoiceDayotherPayerGuidautomaticRefundrestAmountchannelPrinteInvoiceReferenceeInvoiceBankOperatorInfonoDirectDebitinternalcustomerStateMessageList Abandoned Invoice Lines for Invoice Group
Returns all abandoned invoice lines for the specified invoice group (invoice collection/account). Returns an empty response if no abandoned lines are found for the invoice group.
query Parameters
accountguidThe invoice group (invoice collection/account) ID
List Abandoned Invoice Lines for Invoice Group › Responses
Success
customerGUIclientGLNaccountGuidlastAccountStatelastAccountTimestampList Abandoned Lines.
Returns all abandoned invoice lines across all invoice groups (invoice collections/accounts) for the tenant.
query Parameters
pageThe page number to retrieve. Defaults to 1.
sizeThe number of results per page. Defaults to 1,000.
List Abandoned Lines. › Responses
Success
customerGUIclientGLNaccountGuidlastAccountStatelastAccountTimestampList Archived Invoice Lines
Returns archived invoice lines for the specified customer and invoice group (invoice collection/account).
query Parameters
customerguidThe customer ID.
accountguidThe invoice group (invoice collection/account) ID
List Archived Invoice Lines › Responses
Success
customerGUIclientGLNaccountGuidlastAccountStatelastAccountTimestampArchive Invoice Lines
Moves one or more invoice lines from the abandoned collection to the archive collection. After archiving, a report event is triggered for each affected customer.
Archive Invoice Lines › Responses
Invoice lines archived successfully
Add Invoice Line
Adds a new invoice line to the import collection for the specified customer or invoice group.
Either AccountGuid or CustomerIdErp must be provided. For products with SE or PTI line types, an accounting point and contract must be specified.
VAT is calculated automatically based on the product configuration. The billing period defaults to the current month unless explicitly provided.
Add Invoice Line › Request Body
productIdproductElementIdquantitypricedescriptionaccountGuidvatvatCodecustomerIdErpaccountingPointGuidaccountingPointIdcurrencytermStartDatetermEndDatequantityUnitAdd Invoice Line › Responses
OK
Update Imported Invoice Line
Updates a manually created invoice line in the import collection.
Only lines with import type Manually can be updated. VAT and amounts are recalculated based on the updated values and product configuration.
Update Imported Invoice Line › Responses
Invoice line updated
Retrieves uninvoiced invoice lines for the specified customer.
Returns uninvoiced (imported) invoice lines for the specified customer, optionally filtered by the supplied query parameters.
All query fields are optional and are combined using AND logic. When the request body is omitted or empty, every uninvoiced line for the customer is returned.
Filters
AccountingPointId— only lines belonging to the given accounting point.ProductId— only lines for the given product (matched on the product element id).PeriodStart— only lines whoseTermStartDateis on or after this date (inclusive).PeriodEnd— only lines whoseTermEndDateis on or before this date (inclusive).
Returns: a list of InvoiceLineDto objects. An empty list is returned when no lines match the criteria.
path Parameters
customerguidRetrieves uninvoiced invoice lines for the specified customer. › Request Body
productIdaccountingPointIdperiodStartperiodEndRetrieves uninvoiced invoice lines for the specified customer. › Responses
OK
iderpIdlineState0 (Imported), 10 (ErpExporting), 15 (ErpExported), 20 (Distributed), 30 (Sent), -2 (Deleted), -1 (Abandoned).
productIddescriptiontextaccountingPointIdperiodStartperiodEndquantityquantityUnitpriceamountvatAmountvatCodeIdvatRatecurrencyaccountPeriodvendorptiInvoiceNumberlineTypeinvoiceLineType0 (Unknown), 1 (SE), 2 (Pti), 3 (Broadband), 4 (TV), 5 (DistrictHeating), 6 (DistrictCooling), 7 (WasteManagement), 8 (InterestAmount), 9 (Services), 10 (Custom), 11 (Fee), 12 (DownPayment), 13 (ReminderFee), 14 (RestAmount), 15 (Generic), 16 (PrePayment), 17 (ChargingAgreement), 18 (RevenueShare), 1000 (Information).
importType0 (SettlementLines), 1 (PTI), 2 (NetAdmin), 3 (NetAdminWithAP), 4 (ScanVegt), 51 (Manually), 61 (FileImport), 71 (DownPayment), 81 (ErpSystem).
importTimeStampcommentImport Journal Entry Line
Retrieves an open journal entry from the ERP system and imports it as an open journal line in the import collection.
If the journal entry is linked to an invoice number, the associated customer and invoice group are resolved automatically.
Providing customerguid and accountguid explicitly overrides the automatic resolution. The imported line is submitted for review after import.
query Parameters
journalentryidThe ERP journal entry ID to import.
customerguidThe customer ID. Used to override automatic resolution from the journal entry.
accountguidThe invoice group (invoice collection/account) ID. Used to override automatic resolution from the journal entry.
Import Journal Entry Line › Responses
OK
List Invoice Groups
Get Invoice Group
Returns the invoice group (account) with the specified ID, including the associated customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
Get Invoice Group › Responses
Return the invoice group with the specified id
Update Invoice Group
Updates the addresses or communication details of the specified invoice group.
The update is processed asynchronously. A 202 response confirms the request was accepted, not that the update has been applied.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
Update Invoice Group › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
The account's addresses
The account's communication objects
NameInvoiceTagUpdate Invoice Group › Responses
Request accepted
MessageGet Customer and Invoice Groups by Third-Party ID
Returns the customer and all associated invoice groups identified by the given ID in a third-party system.
path Parameters
idThe invoice group ID in the third-party system.
tpidThe third-party system identifier.
Get Customer and Invoice Groups by Third-Party ID › Responses
Return the customer and a list of the customers invoice groups
List Metering Points by Invoice Group
Returns an overview of all metering points and their current contracts for the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points by Invoice Group › Responses
Returns a simplified overview of the metering points and their current contracts
List Metering Points by Third-Party Invoice Group ID
Returns a simplified overview of all metering points and their current contracts for the invoice group identified by the given ID in a third-party system.
path Parameters
idThe invoice group ID in the third-party system.
tpidThe third-party system identifier.
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points by Third-Party Invoice Group ID › Responses
Returns a simplified overview of the metering points and their current contracts
List Contracts by Invoice Group and Metering Point
Returns all contracts on the specified metering point that belong to the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
acid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
List Contracts by Invoice Group and Metering Point › Responses
Returns all contracts belonging to the invoice group on the metering point
List Contracts by Third-Party Invoice Group and Metering Point
Returns all contracts on the specified metering point that belong to the invoice group identified by the given ID in a third-party system.
path Parameters
idThe invoice group ID in the third-party system.
tpidThe third-party system identifier.
acidThe metering point ID.
List Contracts by Third-Party Invoice Group and Metering Point › Responses
Returns all contracts belonging to the invoice group on the metering point
Delete Invoice Group
Initiates erasure of all personal data associated with the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
Delete Invoice Group › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CommentAn explanation from the clerk
UserIdThe id of the user who requested the termination
DeleteInCRMDeleteInBEDelete Invoice Group › Responses
Request accepted
MessageCreate Contact for Invoice Group
Creates a new contact person and associates them with the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
Create Contact for Invoice Group › Request Body
GivenNameFamilyNameRequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CustomerGuid^([0-9A-Fa-f]{32}$|^…UC Identifier
Identifiers in other systems
EmailMobileRolesCreate Contact for Invoice Group › Responses
Request accepted
MessageList Customer Invoice Groups
Returns all invoice groups, contacts, and customer details for the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
List Customer Invoice Groups › Responses
Returns the customer's invoice groups
Create Invoice Group
Creates a new invoice group for the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Create Invoice Group › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
NameAccount name
InvoiceTagAsk BE
CreateInCRMWhether to create a crm account or use the default crm account
Create Invoice Group › Responses
Request accepted
MessageList Metering Points Summary by Customer
Returns a simplified overview of all metering points and their current contracts across all invoice groups for the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points Summary by Customer › Responses
Returns a simplified overview of the accounting points and their current contract
Update Customer Invoice Group
Updates the address or communication details of the specified invoice group belonging to the customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
acguid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
Update Customer Invoice Group › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update Customer Invoice Group › Responses
Request accepted
Message
