Create, search, retrieve, and update customer records.
Get 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 Customers
Create Customer
Creates a new customer, optionally with a default invoice group and invoice settings.
Create Customer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Create Customer › Responses
Request accepted
MessageUpdate Customer by National Identity Number
Updates the customer identified by the national identity number provided in the request body.
Update Customer by National Identity Number › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update Customer by National Identity Number › Responses
Request accepted
MessageList Customer Summaries
Returns a compact list of customers containing only identification and name fields. Supports filtering by identification regex, country code, and customer type (person or company).
query Parameters
limitThe maximum number of customers to return.
pageThe page number.
identificationregexURL-encoded regular expression to filter customers by national identity number or organisation number.
countrycodeFilters customers by country code, e.g. NO.
ispersonWhen true, returns only private customers. When false, returns only corporate customers.
List Customer Summaries › Responses
Returns all requested customers
List Customer IDs by Phone Number or Email
Get Customer
Returns the customer with the specified ID.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Get Customer › Responses
Returns the customer
IdentificationSSN/Org number
Guid^([0-9A-Fa-f]{32}$|^…UC Identifier
DefaultAccount^([0-9A-Fa-f]{32}$|^…UC Identifier
BirthDateNameThe name of the company
FamilyNameLast name
GivenNameFirst name
TagsUpdate Customer
Updates the details of the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Update Customer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update Customer › Responses
Request accepted
MessageUpdate Customer by National Identity Number
Updates the customer identified by the national identity number in the path.
path Parameters
idThe customer's national identity number.
Update Customer by National Identity Number › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update Customer by National Identity Number › Responses
Request accepted
MessageCreate Contact Person
Creates a new contact person and associates them with the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Create Contact Person › 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 Person › Responses
Request accepted
MessageList Offers by Customer
Returns all offers associated with the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
List Offers by Customer › Responses
Request accepted
CountList Offers by Third-Party Customer ID
Returns all offers associated with the customer identified by the given ID in a third-party system.
path Parameters
idThe customer ID in the third-party system.
tpidThe third-party system identifier.
List Offers by Third-Party Customer ID › Responses
Request accepted
CountGet Customer by Request ID
Returns the customer and their default invoice group associated with the specified request ID, used to look up a customer created by a known request.
path Parameters
id^([0-9A-Fa-f]{32}$|^… · requiredThe request ID used when the customer was created.
Get Customer by Request ID › Responses
Returns the customer and it's default invoice group
List 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 Contracts by Customer and Metering Point
Returns all contracts on the specified metering point that belong to the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
acid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
List Contracts by Customer and Metering Point › Responses
Returns all contracts belonging to the customer on the metering point
Set Metering Point Nickname
Sets a customer-defined nickname on the specified metering point.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Set Metering Point Nickname › Request Body
NicknameAccountingPointIdentificationThe accounting point identifier
AccountingPointGuid^([0-9A-Fa-f]{32}$|^…UC Identifier
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
Set Metering Point Nickname › Responses
Request accepted
MessageApply Contract Commands
Applies one or more commands to update the specified contract, verifying that the contract belongs to the specified customer before processing.
Supported commands: RemoveProduct, AddProduct, MoveContract, SetEndDate, UpdateMoveInDate.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
cguid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Apply Contract Commands › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Apply Contract Commands › Responses
Valid request
MessageUpdate 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
MessageDelete Customer
Initiates erasure of all personal data associated with the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Delete Customer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CommentDelete Customer › Responses
Request accepted
MessageSync Customer Data
Requests a synchronisation of the specified customer's data from an external source.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Sync Customer Data › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CasingSync Customer Data › Responses
Request accepted
MessageSearch Customers
Searches for customers matching the specified criteria across multiple fields and returns matching results.
Search Customers › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CountryCodeQueryStringPhone numbers, Guid, etc
SearchInCRMSearch in the crm system
SearchInBrRegSearch in the entity registry
SearchPhoneRegistriesSearch in the phone registries
SearchInternallySearch in uc databases
Search Customers › Responses
Results found
Archive Customer
Archives the specified customer, removing them from active use while retaining their data.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Archive Customer › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
ReasonInheritor^([0-9A-Fa-f]{32}$|^…UC Identifier
Archive Customer › Responses
Request accepted
Message