{
"openapi": "3.0.4",
"info": {
"title": "API Reference",
"description": "This is the OpenAPI specification for UtilityCloud's API methods made for machine to machine (m2m) use.\nYou can view it in a modern UI, or in good, old Swagger UI.",
"contact": {
"name": "UtilityCloud",
"url": "https://www.utilitycloud.tech",
"email": "support@utilitycloud.no"
},
"license": {
"name": "UtilityCloud commercial agreement",
"url": "https://www.utilitycloud.tech"
},
"version": "1.3.2",
"x-schema-prefix": "none",
"x-uc-meta": "Finalized 2026-09-07T07:08:14Z."
},
"servers": [
{
"url": "https://api-stag.utilitycloud.app",
"description": "Test environment"
},
{
"url": "https://api.utilitycloud.app",
"description": "Production environment"
}
],
"paths": {
"/be/v3/commonreport/allfiles": {
"get": {
"tags": [
"Reports"
],
"summary": "List Report File Names",
"description": "Returns report file names and related metadata for the specified tenant.\nUse `customerGuid` to return report file names for a specific customer.\nUse `ignoreSubFolders` to exclude report file names from subfolders. \n\nUse case: API consumers can use this endpoint to browse available report files before downloading or processing a selected file.",
"operationId": "CommonReportGetAllReportFileNames",
"parameters": [
{
"name": "customerGuid",
"in": "query",
"description": "Optional filter for returning report file names for a specific customer.",
"explode": false,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ignoreSubFolders",
"in": "query",
"description": "Set to true to exclude report file names from subfolders.",
"explode": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_ReportFileNamesDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/commonreport/file": {
"get": {
"tags": [
"Reports"
],
"summary": "Download Report File",
"description": "Downloads a report file for a tenant.\nUse `filename` to specify the report file to download. The value must match a file name returned by the `List Report File Names` endpoint.\nThe file content is returned as `application/octet-stream`.",
"operationId": "CommonReportDownloadReportFile",
"parameters": [
{
"name": "filename",
"in": "query",
"description": "The report file name.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/products": {
"get": {
"tags": [
"Products"
],
"summary": "List Products",
"description": "Returns products for the specified tenant.\nUse `availableDownpayment` to return products available for down payment.\nUse `forProductType` to return products for a specific ERP mapping type.\nIf ERP is configured as the product master, products are retrieved from ERP. Otherwise, products are retrieved from UtilityCloud. \nProducts are sorted by sort order and name.",
"operationId": "ProductGet",
"parameters": [
{
"name": "availableDownpayment",
"in": "query",
"description": "Optional filter for returning products available for down payment.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "forProductType",
"in": "query",
"description": "Optional filter for returning products for a specific ERP mapping type.",
"explode": false,
"schema": {
"$ref": "#/components/schemas/be_api_v3_ErpMappingType"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_ProductDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/gridowners": {
"get": {
"tags": [
"Grid Owners"
],
"summary": "List Grid Owners",
"description": "Returns all grid owners for the tenant, optionally filtered by organization number.\nEach result includes PTI invoice counts for the current month: expected, imported, and paid. Use `organizationNumber` to filter results to a specific grid owner.",
"operationId": "GridOwnerGet",
"parameters": [
{
"name": "organizationNumber",
"in": "query",
"description": "Optional filter for returning grid owners with the specified organization number.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_GridOwnerGetDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "No grid owners found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/gridowners/pti": {
"get": {
"tags": [
"Grid Owners"
],
"summary": "Get Grid Owner PTI Totals",
"description": "Returns PTI invoice totals for the specified grid owner.\nThe response includes counts and amounts for imported, paid, and expected supplier invoices.",
"operationId": "GridOwnerGetPti",
"parameters": [
{
"name": "gridownergln",
"in": "query",
"description": "The grid owner GLN.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_GridOwnerPtiDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/records/list": {
"post": {
"tags": [
"Events",
"Invoice Groups"
],
"summary": "List Invoice Group Events",
"description": "Returns events for an invoice group that match the specified filter criteria.\nUse the request body to filter which events are returned.\nThe response contains the matching event records.",
"operationId": "EventListPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_RecordFilter"
},
"example": {
"RequestID": null,
"RecordIDs": [ ],
"Aggregate": {
"type": "account",
"value": "ac9bc62b-14d4-44f0-9c06-f4a069de667f"
},
"Events": [
"CreditInvoice",
"InvoiceForce",
"PostInvoiceLines",
"UpdateInvoiceConfig",
"UpdateInvoiceConfigs",
"UpdateDueDate",
"PostReminderLine",
"PaymentAgreementPost",
"CustomerNotification",
"ImportJournalEntry",
"AbandonInvoiceLines"
],
"FromDate": "2026-08-28T07:07:56.0704914+00:00",
"ToDate": "2026-09-07T07:07:56.0704936+00:00",
"Page": 0,
"Limit": 100,
"SortAscending": true
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_RecordFilter"
},
"example": {
"RequestID": null,
"RecordIDs": [ ],
"Aggregate": {
"type": "account",
"value": "ac9bc62b-14d4-44f0-9c06-f4a069de667f"
},
"Events": [
"CreditInvoice",
"InvoiceForce",
"PostInvoiceLines",
"UpdateInvoiceConfig",
"UpdateInvoiceConfigs",
"UpdateDueDate",
"PostReminderLine",
"PaymentAgreementPost",
"CustomerNotification",
"ImportJournalEntry",
"AbandonInvoiceLines"
],
"FromDate": "2026-08-28T07:07:56.0704914+00:00",
"ToDate": "2026-09-07T07:07:56.0704936+00:00",
"Page": 0,
"Limit": 100,
"SortAscending": true
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_RecordFilter"
},
"example": {
"RequestID": null,
"RecordIDs": [ ],
"Aggregate": {
"type": "account",
"value": "ac9bc62b-14d4-44f0-9c06-f4a069de667f"
},
"Events": [
"CreditInvoice",
"InvoiceForce",
"PostInvoiceLines",
"UpdateInvoiceConfig",
"UpdateInvoiceConfigs",
"UpdateDueDate",
"PostReminderLine",
"PaymentAgreementPost",
"CustomerNotification",
"ImportJournalEntry",
"AbandonInvoiceLines"
],
"FromDate": "2026-08-28T07:07:56.0704914+00:00",
"ToDate": "2026-09-07T07:07:56.0704936+00:00",
"Page": 0,
"Limit": 100,
"SortAscending": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_RecordsResponse"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/account": {
"delete": {
"tags": [
"Dimensions"
],
"summary": "Remove Invoice Group Dimension",
"description": "Removes a dimension from a given invoice group (invoice collection/account).\nThe invoice group and dimension must exist for the operation to succeed. Returns the updated invoice group configuration after the dimension has been removed.",
"operationId": "DimensionAccountDelete",
"parameters": [
{
"name": "accountguid",
"in": "query",
"description": "The invoice group ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dimensionId",
"in": "query",
"description": "The dimension ID to remove.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice group or dimension not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/account/{guid}": {
"post": {
"tags": [
"Dimensions"
],
"summary": "Add Invoice Group Dimension Value",
"description": "Sets a custom dimension value for the specified invoice group (invoice collection/account). The dimension must have `Custom Value Allowed` enabled.\nIf custom values are not allowed for the dimension, the request fails.\nReturns the updated invoice group configuration after the dimension value has been added.\nThis endpoint is typically used to assign a user-defined value to an invoice group-specific dimension.",
"operationId": "DimensionAccountPostCustomValue",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The unique identifier of the invoice group.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dimensionNumber",
"in": "query",
"description": "The dimension number to assign a custom value to.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dimensionEntryValue",
"in": "query",
"description": "The custom dimension value to assign.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/customer": {
"delete": {
"tags": [
"Dimensions"
],
"summary": "Remove Customer Dimension",
"description": "Removes a dimension from a customer.\nThe customer and dimension must exist for the operation to succeed.\nReturns the updated invoice group configuration after the dimension has been removed.",
"operationId": "DimensionCustomerDelete",
"parameters": [
{
"name": "customerguid",
"in": "query",
"description": "The customer ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dimensionId",
"in": "query",
"description": "The dimension ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Customer or dimension not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/customer/{guid}": {
"post": {
"tags": [
"Dimensions"
],
"summary": "Add Customer Dimension Value",
"description": "Sets a custom dimension value for the specified customer. The dimension must have `Custom Value Allowed` enabled.\nIf the dimension does not allow custom values, the request will fail.\nThis endpoint is typically used to assign a user-defined value to a customer-specific dimension.",
"operationId": "DimensionCustomerPostCustomValue",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "dimensionNumber",
"in": "query",
"description": "The dimension number.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "dimensionEntryValue",
"in": "query",
"description": "The custom dimension value to assign.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/product": {
"delete": {
"tags": [
"Dimensions"
],
"summary": "Remove Product Dimension",
"description": "Removes a dimension from the specified product element.",
"operationId": "DimensionProductDelete",
"parameters": [
{
"name": "productElementId",
"in": "query",
"description": "The product element ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dimensionId",
"in": "query",
"description": "The dimension ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Dimension removed"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Product or dimension not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
},
"post": {
"tags": [
"Dimensions"
],
"summary": "Add Product Dimension",
"description": "Adds a dimension to the specified product element.",
"operationId": "DimensionProductPost",
"parameters": [
{
"name": "productElementId",
"in": "query",
"description": "The product element ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dimensionId",
"in": "query",
"description": "The dimension ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dimensionEntryId",
"in": "query",
"description": "The dimension entry ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Dimension added"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Product or dimension not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/dimensions/product/list": {
"post": {
"tags": [
"Dimensions"
],
"summary": "Add Product Dimensions",
"description": "Adds multiple dimensions to the specified product element.",
"operationId": "DimensionProductPostList",
"parameters": [
{
"name": "productElementId",
"in": "query",
"description": "The product element ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_DimensionIdDto"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_DimensionIdDto"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_DimensionIdDto"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Dimensions added"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Product or dimension not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/accounts/invoiceconfig": {
"patch": {
"tags": [
"Invoice Groups"
],
"summary": "Update Invoice Group Configuration",
"description": "Partially updates invoice configuration for an invoice group (invoice collection/account) or for all invoice groups associated with a customer.\nProvide either `AccountGuid` or `CustomerGuid` in the request body.\nUse `AccountGuid` to update one invoice group. Use `CustomerGuid` to update all invoice groups associated with the customer.\nOnly the invoice settings included in the request are updated. Other settings remain unchanged.\nThe request can include settings such as distribution channel, administration fee, payment terms, manual approval, and related invoicing options.\nWhen 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.",
"operationId": "AccountPatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigPatchDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice group configuration updated"
},
"400": {
"description": "Payload is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice group or customer not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/accounts/invoiceconfigs": {
"patch": {
"tags": [
"Invoice Groups"
],
"summary": "Update Multiple Invoice Group Configurations",
"description": "Partially updates invoice configuration for multiple invoice groups (invoice collections/accounts) or customers.\nEach item in the request must identify the target by providing either `AccountGuid` or `CustomerGuid`.\nUse `AccountGuid` to update one invoice group. Use `CustomerGuid` to update all invoice groups associated with the customer.\nOnly the invoice settings included in each item are updated. Other settings remain unchanged.",
"operationId": "AccountPatchList",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigListDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice group configurations updated"
},
"400": {
"description": "Payload is invalid or empty",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/accounts/query": {
"post": {
"tags": [
"Invoice Groups"
],
"summary": "Query Invoice Groups",
"description": "Searches for invoice groups (invoice collections/accounts) that match the criteria provided in the request body.\n\nSupply an `AccountSearchParameters` object to filter results by fields such as customer, distribution channel, payment terms, on-hold status, and other invoicing settings.\nCall `GET /accounts/query` first to discover the available search parameters and their default values.\n\nResults 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.\nEach match is returned as an `InvoiceConfigGroupDto`. An empty list is returned when no invoice groups match the criteria.",
"operationId": "AccountPostQuery",
"parameters": [
{
"name": "page",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_AccountSearchParameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Matching invoice groups",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigGroupDto"
}
}
}
}
},
"400": {
"description": "Payload is invalid or paging parameters are out of range",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
},
"get": {
"tags": [
"Invoice Groups"
],
"summary": "Get Invoice Group Query Parameters",
"description": "Returns the set of supported search parameters that can be used to query invoice groups (invoice collections/accounts).\n\nUse this endpoint to discover the available filter fields, their names, and default values before building a query.\nThe returned template can be populated and posted to the `POST /accounts/query` endpoint to search for matching invoice groups.",
"operationId": "AccountGetQueryParameters",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_AccountSearchParameters"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/accounts/{accountGuid}": {
"get": {
"tags": [
"Invoice Groups"
],
"summary": "Get Invoice Group",
"description": "Returns the invoice group (invoice collection/account) configuration for the specified invoice group ID.\n\nThe 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. \nContact details, bank accounts, and dimension data are also included where available.",
"operationId": "AccountGetOnGuid",
"parameters": [
{
"name": "accountGuid",
"in": "path",
"description": "The invoice group (invoice collection/account) ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/callback/ropo": {
"post": {
"tags": [
"Events",
"Ropo"
],
"summary": "Receive Ropo Callback",
"description": "Receives callback notifications from Ropo.",
"operationId": "RopoPostCallBack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_RopoCallbackData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Callback received and queued for processing"
},
"400": {
"description": "Payload is invalid or missing required data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_api_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-api-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/import/fileimport": {
"post": {
"tags": [
"Imports",
"Invoices"
],
"summary": "Upload Invoice Data",
"description": "Uploads invoice data for processing and import.\nThe payload is validated before import. Duplicate imports identified by import ID are rejected. \n\nIf a supplier billing type is specified, the invoice is processed as a Pass-Through Invoicing (PTI) import and routed to the PTI import container. \nOtherwise, the invoice is uploaded to standard import storage and queued for processing.",
"operationId": "ImportFilePost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ImportInvoice"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "File validated and uploaded"
},
"400": {
"description": "Validation failed or duplicate import ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-import-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/import/ptiimport/{guid}/pdffile": {
"get": {
"tags": [
"PTI"
],
"summary": "Download Supplier Invoice PDF",
"description": "Returns the PDF file for a supplier invoice imported via Pass-Through Invoicing (PTI) for the specified customer.\nAt least one filter parameter must be provided to identify the correct import record.",
"operationId": "PtiImportGetPdf",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ptiinvoicenumber",
"in": "query",
"description": "The supplier invoice number.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "vendor",
"in": "query",
"description": "The supplier organization number. Used together with the supplier invoice number to identify the import.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "erpId",
"in": "query",
"description": "The ERP/invoice ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "accountguid",
"in": "query",
"description": "The invoice group (Invoice collection/Account) ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "invoiceNumber",
"in": "query",
"description": "The invoice number.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Invoice pdf file content result",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "No matching PTI import found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_import_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-import-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:07Z."
}
},
"/be/v3/invoice/credits/list": {
"post": {
"tags": [
"Invoices"
],
"summary": "Credit Invoices",
"description": "Submits credit requests for a list of invoices.\nEach request must include an ERP/invoice ID and may specify whether the credit note should be distributed, a reason, a comment, and whether a refund should be executed.",
"operationId": "CreditPostList",
"parameters": [
{
"name": "force",
"in": "query",
"description": "Set to 'fireatwill' to force crediting regardless of validation rules.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_CreditInvoicePayload"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Credit requests submitted"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "One or more invoices not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/webhook/AccountLifeTimeStatusUpdate": {
"get": {
"tags": [
"Debt Collection",
"Webhooks"
],
"summary": "Get Invoice Group Status Update Webhook Model",
"description": "Returns a sample payload for the `AccountLifeTimeStatusUpdate` webhook event.\nThis webhook is triggered when the status of an invoice group changes to `Ended` or `Active`. The payload includes the invoice group ID, customer ID, customer number, and the new status.\n\nUse case: Debt collection partners can use this payload to update their records and related processes when an invoice group status changes.",
"operationId": "DebtCollectorGetWebhookAccountLifeTimeStatusUpdateModel",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_WebhookPayloadAccountLifeTimeStatusUpdatePayload"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/webhook/InvoiceDunnedPaid": {
"get": {
"tags": [
"Debt Collection",
"Webhooks"
],
"summary": "Get Dunned Invoice Payment Webhook Model",
"description": "Returns a sample payload for the `InvoiceDunnedPaid` webhook event.\nThis webhook is triggered when a payment is registered on an invoice that was previously marked as dunned. \nThe payload includes the paid amount, payment date, invoice number, and bank account information.\n\nUse case: Debt collection partners can use this webhook to update their records and stop or adjust collection activities as soon as a payment is registered.",
"operationId": "DebtCollectorGetWebhookInvoiceDunnedPaidModel",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_WebhookPayloadInvoiceDunnedPaidPayload"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/webhook/InvoiceDunnedCredited": {
"get": {
"tags": [
"Debt Collection",
"Webhooks"
],
"summary": "Get Dunned Invoice Credit Webhook Model",
"description": "Returns a sample payload for the `InvoiceDunnedCredited` webhook event.\nThis webhook is triggered when a dunned invoice is credited. The payload includes the invoice number, credit note number, credited date, and invoice total amount.\n\nUse case: Debt collection partners can use this webhook to stop or adjust collection activities when a dunned invoice is credited.",
"operationId": "DebtCollectorGetWebhookInvoiceDunnedCreditedModel",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_WebhookPayloadInvoiceDunnedCreditedPayload"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection": {
"get": {
"tags": [
"Debt Collection"
],
"summary": "List Open Invoices for Debt Collection",
"description": "Returns open invoices that are eligible for debt collection for the specified tenant.\nOnly invoices with overdue status Debt, no active stop reminders, and an unpaid balance are included. \n\nNote: Only available for tenants using UtilityCloud Ledger. \nUse case: Debt collection partners can use this endpoint to fetch invoices that are currently open for collection, enabling them to initiate or continue collection processes.",
"operationId": "DebtCollectorGet",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionInvoiceDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/fee": {
"post": {
"tags": [
"Debt Collection"
],
"summary": "Add Debt Collection Fee to Invoice",
"description": "Adds one or more fee items to the specified invoice and creates corresponding ledger accounting lines.\nThe total fee amount is added to the invoice total. \nEach fee item must reference a valid product and have a unique identifier within the request. \nThe new total amount including VAT must equal the original invoice total plus the sum of all fee amounts.\n\nNote: Only available for tenants using UtilityCloud Ledger.\nUse case: Debt collection partners can use this endpoint to register additional costs, such as collection fees, on an overdue invoice.",
"operationId": "DebtCollectorPostFee",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionFeeDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Fee items added to invoice"
},
"400": {
"description": "Validation failed, amount mismatch, duplicate identifier, or invalid product",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice or customer not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/invoicelines": {
"post": {
"tags": [
"Debt Collection"
],
"summary": "Add Lines for Next Invoice",
"description": "Adds one or more invoice lines to be included on the customer's next invoice.\nLines are imported as open journal entries and linked to the referenced invoice. Each line must include a unique identifier, amount, and description.\n\nNote: Only available for tenants using UtilityCloud Ledger.\nUse case: Debt collection partners can use this endpoint to register additional charges or information to be billed on the customer's next invoice.",
"operationId": "DebtCollectorPostInvoiceLines",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionInvoiceLineDto"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice lines added"
},
"400": {
"description": "Validation failed, invoice not found or missing open journal product configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/collect": {
"post": {
"tags": [
"Debt Collection"
],
"summary": "Assign Invoice to Debt Collection",
"description": "Marks an invoice as taken over for debt collection.\nThe invoice must be eligible for collection. When assigned, the invoice status is updated to `dunned`, \nreminders are stopped, and the debt case ID and details are recorded. \nInvoices already assigned to a debt case are excluded from the list returned by GET /debtcollection.\n\nNote: Only available for tenants using UtilityCloud Ledger.\nUse case: Debt collection partners can use this endpoint to confirm that a collection case has been initiated and update the invoice status in UtilityCloud.",
"operationId": "DebtCollectorPostPickup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionCasePostDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice assigned to debt collection"
},
"400": {
"description": "Invoice is not available for debt collection",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/update": {
"patch": {
"tags": [
"Debt Collection"
],
"summary": "Update Debt Case Details",
"description": "Updates debt case details for an invoice already assigned to debt collection.\nThe invoice number and existing debt case ID are required for verification. The debt case ID, date, URL, and comment can be updated independently; only provided fields are changed.\n\nNote: Only available for tenants using UtilityCloud Ledger.\nUse case: Debt collection partners can use this endpoint to update debt case details after a collection case has already been created.",
"operationId": "DebtCollectorPatchUpdate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionPatchDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Debt case details updated"
},
"400": {
"description": "Verification failed, invoice not marked as collected with the provided case ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/debtcollection/resolve": {
"post": {
"tags": [
"Debt Collection"
],
"summary": "Resolve Debt Collection Case",
"description": "Closes a debt collection case and returns the invoice to the tenant's standard collection process.\nThe invoice number and matching debt case ID are required. The invoice must have an active debt case with the provided ID.\n\nNote: Only available for tenants using UtilityCloud Ledger.\nUse case: Debt collection partners can use this endpoint when a debt case was created by mistake or when an agreement has been made to close the case",
"operationId": "DebtCollectorPostResolved",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionCasePostDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Debt collection case resolved"
},
"400": {
"description": "Invoice does not have an active debt case with the specified ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/{guid}": {
"get": {
"tags": [
"Invoices"
],
"summary": "List Customer Invoices",
"description": "Returns invoices for the specified customer.\nResults can be filtered to a specific invoice group (invoice collection/account) using accountguid. \nResults are paginated; page size depends on the ERP system. Credited invoices are included by default.",
"operationId": "InvoiceGet",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "accountguid",
"in": "query",
"description": "The invoice group ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. The first page is 1.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "removeCredited",
"in": "query",
"description": "Set to true to exclude credited invoices from the response.",
"explode": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_PublicInvoiceHeader"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Customer not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "No invoices found for the specified customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/details": {
"get": {
"tags": [
"Invoices"
],
"summary": "Get Invoice Details",
"description": "Returns detailed information for a single invoice.\nEither the ERP/invoice ID or the invoice number must be provided to identify the invoice. \nInvoice lines can optionally be merged in the response. Response is cached for 15 minutes.",
"operationId": "InvoiceGetDetails",
"parameters": [
{
"name": "erpid",
"in": "query",
"description": "The ERP/invoice ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "number",
"in": "query",
"description": "The invoice number.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "showMerged",
"in": "query",
"description": "Set to true to merge invoice lines in the response.",
"explode": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_UCInvoiceDetails"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"503": {
"description": "Unable to fetch invoice details from ERP"
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/{guid}/pdf": {
"get": {
"tags": [
"Invoices"
],
"summary": "Download Invoice PDF",
"description": "Downloads the PDF document for the specified invoice.\n\nNote: A Base64-encoded token can be provided as an alternative to supplying tenant and customer ID directly. \nFor internal tenants and non-production environments without a distribution test system, a generated preview PDF is returned instead of the original distribution file.",
"operationId": "InvoiceGetPdf",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "number",
"in": "query",
"description": "The invoice number.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "query",
"description": "A Base64-encoded token containing tenant and customer identifiers. Used as an alternative to providing tenant and customer ID directly.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "originalfromreminder",
"in": "query",
"description": "Set to true to return the original invoice PDF when the invoice was created from a reminder.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "originalOnly",
"in": "query",
"description": "Set to true to return only the original invoice PDF.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "locale",
"in": "query",
"description": "The country code used to determine the language of the PDF preview, for example no, fi, or se. Defaults to the tenant country code.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice PDF not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/duedate": {
"patch": {
"tags": [
"Invoices"
],
"summary": "Update Invoice Due Date",
"description": "Updates the due date for the specified invoice.\nThe request body must include the ERP/invoice ID and the new due date. For UtilityCloud Ledger, interest calculation on late payment can optionally be stopped.",
"operationId": "InvoicePatchDueDay",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ChangeInvoiceDueDateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/overdue": {
"patch": {
"tags": [
"Invoices"
],
"summary": "Update Invoice Overdue Process",
"description": "Starts or stops the overdue process for the specified invoice.\nThe request body must include the ERP/invoice ID and the `StopOverdue` flag. A comment and the number of days to pause the process can optionally be included.",
"operationId": "InvoicePatchOverdue",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceOverDueRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/creditcheck": {
"post": {
"tags": [
"Invoices"
],
"summary": "Get Customer Payment Risk Assessment",
"description": "Returns a payment risk assessment for the specified customer based on invoice data in UtilityCloud.\nThe response includes overdue, dunned, and loss invoice counts and amounts. \nThe `CreditCheckPassed` flag indicates whether the customer has breached any of the payment thresholds configured for the tenant.",
"operationId": "InvoicePostCreditCheck",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceCreditCheckPayloadDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceCreditCheckPayloadDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceCreditCheckPayloadDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceCreditCheckDto"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Customer not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/agreements/payments": {
"get": {
"tags": [
"Payment Agreements"
],
"summary": "Get Payment Agreement",
"description": "Returns the payment agreement for the specified invoice.",
"operationId": "PaymentAgreementGet",
"parameters": [
{
"name": "erpId",
"in": "query",
"description": "The ERP/invoice ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_PaymentAgreement"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
},
"patch": {
"tags": [
"Payment Agreements"
],
"summary": "Update Payment Agreement",
"description": "Updates the status of an existing payment agreement linked to an invoice.\nSupported status transitions are activate and delete.\n\nNote: The invoice must have status `Sent` or `Partial` for the update to be accepted. \nThe payment agreement must exist and cannot be set to a status it already has.",
"operationId": "PaymentAgreementPatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_PaymentAgreementPatchPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Payment agreement updated"
},
"400": {
"description": "Invoice status does not allow update, or agreement already has the requested status",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice or payment agreement not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
},
"post": {
"tags": [
"Payment Agreements"
],
"summary": "Create Payment Agreement",
"description": "Creates a new payment agreement for the specified invoice.\nThe invoice must have status Sent or Partial for the agreement to be created. \nWhen the agreement is created, reminders for the invoice are stopped and the invoice due date is updated to the latest payment line date if payment lines are provided.\nOnly one active payment agreement can exist per invoice at a time.",
"operationId": "PaymentAgreementPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_PaymentAgreement"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Payment agreement created"
},
"400": {
"description": "Invoice status does not allow a new payment agreement, or ERP update failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
},
"delete": {
"tags": [
"Payment Agreements"
],
"summary": "Delete Payment Agreement",
"description": "Deletes the payment agreement associated with the specified invoice.\nWhen the agreement is deleted, invoice reminders are restarted.",
"operationId": "PaymentAgreementDelete",
"parameters": [
{
"name": "erpId",
"in": "query",
"description": "The ERP/invoice ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Payment agreement deleted"
},
"400": {
"description": "No payment agreement found for the specified invoice",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/invoice/search": {
"post": {
"tags": [
"Invoices"
],
"summary": "Search Invoices",
"description": "Returns a paginated list of invoices matching the specified search criteria.\nResults can optionally be sorted with the newest invoices first.",
"operationId": "SearchPost",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. The first page is 1.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"description": "The number of results per page.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceSearchPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_invoice_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-invoice-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/ledger/ledgerreporting/balance/details": {
"get": {
"tags": [
"Accounting",
"Reports"
],
"summary": "List Accounting Line Details",
"description": "Returns individual accounting line entries created within the specified date range.\nSuitable for detailed analysis, reconciliation, or ERP integration where aggregated summaries are insufficient.",
"operationId": "ReportingGetAccountingBalanceDetails",
"parameters": [
{
"name": "fromDay",
"in": "query",
"description": "The start of the date range (inclusive). Lines created within this range will be included.",
"required": true,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "toDay",
"in": "query",
"description": "The end of the date range (inclusive). Lines created within this range will be included.",
"required": true,
"explode": false,
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_ReportAccountingLineDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-ledger-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/ledger/payments": {
"get": {
"tags": [
"Payments"
],
"summary": "List Payment Jobs",
"description": "Returns a paginated list of payment jobs filtered by payment status and optionally by payment types.",
"operationId": "PaymentsGet",
"parameters": [
{
"name": "paymentStatus",
"in": "query",
"description": "Filters results by payment status.",
"required": true,
"explode": false,
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentStatus"
}
},
{
"name": "paymentsType",
"in": "query",
"description": "Filters results by one or more payment types.",
"explode": false,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentType"
}
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. Defaults to 1.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"description": "The number of results per page. Defaults to 10,000.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentJobDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-ledger-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/ledger/banktransactions/search": {
"post": {
"tags": [
"Bank Transactions"
],
"summary": "Search Bank Transactions",
"description": "Returns a paginated list of bank transactions matching the specified search criteria.",
"operationId": "BankTransactionsPostSearch",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. The first page is 1.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"description": "The number of results per page.",
"required": true,
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_BankTransactionSearchDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_BankTransactionDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-ledger-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/ledger/accountinglines/item/{itemReference}": {
"get": {
"tags": [
"Accounting"
],
"summary": "List Accounting Lines",
"description": "Returns all accounting lines associated with a specific item reference, such as an invoice or PTI file import.",
"operationId": "AccountingLinesGetOnItemRef",
"parameters": [
{
"name": "itemReference",
"in": "path",
"description": "The item reference to retrieve accounting lines for, such as an ERP/invoice ID or supplier invoice PTI file import ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_AccountingLineDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_ledger_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-ledger-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/abandon": {
"get": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "List Abandoned Invoice Lines for Invoice Group",
"description": "Returns all abandoned invoice lines for the specified invoice group (invoice collection/account).\nReturns an empty response if no abandoned lines are found for the invoice group.",
"operationId": "AbandonLinesGet",
"parameters": [
{
"name": "accountguid",
"in": "query",
"description": "The invoice group (invoice collection/account) ID",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PublicLinesResponse"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/abandon/all": {
"get": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "List Abandoned Lines.",
"description": "Returns all abandoned invoice lines across all invoice groups (invoice collections/accounts) for the tenant.",
"operationId": "AbandonLinesGetAll",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. Defaults to 1.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"description": "The number of results per page. Defaults to 1,000.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PublicLinesResponse"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/archived": {
"get": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "List Archived Invoice Lines",
"description": "Returns archived invoice lines for the specified customer and invoice group (invoice collection/account).",
"operationId": "ArchivedLinesGet",
"parameters": [
{
"name": "customerguid",
"in": "query",
"description": "The customer ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "accountguid",
"in": "query",
"description": "The invoice group (invoice collection/account) ID",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PublicLinesResponse"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
},
"post": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "Archive Invoice Lines",
"description": "Moves one or more invoice lines from the abandoned collection to the archive collection.\nAfter archiving, a report event is triggered for each affected customer.",
"operationId": "ArchivedLinesPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLinesIdDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice lines archived successfully"
},
"400": {
"description": "No valid invoice line IDs provided",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/imported": {
"post": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "Add Invoice Line",
"description": "Adds a new invoice line to the import collection for the specified customer or invoice group.\n\nEither `AccountGuid` or `CustomerIdErp` must be provided. For products with `SE` or `PTI` line types, an accounting point and contract must be specified. \nVAT is calculated automatically based on the product configuration. The billing period defaults to the current month unless explicitly provided.",
"operationId": "ImportedLinesPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PostInvoiceLinesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
},
"patch": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "Update Imported Invoice Line",
"description": "Updates a manually created invoice line in the import collection.\nOnly lines with import type `Manually` can be updated. VAT and amounts are recalculated based on the updated values and product configuration.",
"operationId": "ImportedLinesPatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PatchInvoiceLinesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Invoice line updated"
},
"400": {
"description": "Line not found, or line is not manually created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/imported/query/customer/{customerguid}": {
"post": {
"tags": [
"Invoice Groups",
"Invoice Lines"
],
"summary": "Retrieves uninvoiced invoice lines for the specified customer.",
"description": "Returns uninvoiced (imported) invoice lines for the specified customer, optionally filtered by the supplied query parameters.\n\nAll 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.\n\n**Filters**\n- `AccountingPointId` — only lines belonging to the given accounting point.\n- `ProductId` — only lines for the given product (matched on the product element id).\n- `PeriodStart` — only lines whose `TermStartDate` is on or after this date (inclusive).\n- `PeriodEnd` — only lines whose `TermEndDate` is on or before this date (inclusive).\n\n**Returns:** a list of `InvoiceLineDto` objects. An empty list is returned when no lines match the criteria.",
"operationId": "ImportedLinesPostCustomerQuery",
"parameters": [
{
"name": "customerguid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_PostInvoiceLineQuery"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineDto"
}
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/imported/vatcode": {
"patch": {
"tags": [
"Invoice Lines"
],
"summary": "Update VAT Code for Imported Invoice Lines",
"description": "Updates the VAT code for one or more invoice lines in the import collection.\nAll VAT codes in the request must be valid. If any VAT code is invalid, no updates are applied.",
"operationId": "ImportedLinesPatchVatCode",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_lines_v3_LineIdVatCode"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "VAT codes updated"
},
"400": {
"description": "One or more VAT codes are invalid or missing",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/imported/all": {
"get": {
"tags": [
"Invoice Lines"
],
"summary": "Download All Imported Invoice Lines",
"description": "Returns all imported invoice lines for the tenant as a downloadable ZIP file.",
"operationId": "ImportedLinesGetAll",
"parameters": [
{
"name": "page",
"in": "query",
"description": "The page number to retrieve. Defaults to 1.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "size",
"in": "query",
"description": "The number of lines per page. Defaults to 50,000.",
"explode": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "ZIP file containing imported invoice lines",
"content": {
"application/zip": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "No imported invoice lines found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/invoiced/reminderline": {
"post": {
"tags": [
"Invoice Lines",
"Unimicro"
],
"summary": "Add or Update Reminder Fee Line",
"description": "Adds or updates a reminder fee line on an existing invoice and triggers an invoice resend for distribution.\n\nIf a reminder fee line does not already exist on the invoice, a new line is created using the configured reminder fee product. \nIf a line exists, it is updated with the new fee amount. The invoice is then queued for redistribution.\n\nNote: Requests with collector status codes `42502` or `42505` are accepted but ignored without updating the invoice.",
"operationId": "InvoicedLinesPostReminderLine",
"requestBody": {
"content": {
"application/json": {
"schema": { }
}
},
"required": true
},
"responses": {
"200": {
"description": "Reminder fee line added or updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLine"
}
}
}
},
"400": {
"description": "Invalid or missing payload fields, or reminder fee is zero with no existing line",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Invoice or customer not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "A journal entry line already exists for this reminder ID",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/be/v3/lines/journalentries": {
"post": {
"tags": [
"Invoice Groups"
],
"summary": "Import Journal Entry Line",
"description": "Retrieves an open journal entry from the ERP system and imports it as an open journal line in the import collection.\n\nIf the journal entry is linked to an invoice number, the associated customer and invoice group are resolved automatically. \nProviding `customerguid` and `accountguid` explicitly overrides the automatic resolution. The imported line is submitted for review after import.",
"operationId": "JournalEntriesPost",
"parameters": [
{
"name": "journalentryid",
"in": "query",
"description": "The ERP journal entry ID to import.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "customerguid",
"in": "query",
"description": "The customer ID. Used to override automatic resolution from the journal entry.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "accountguid",
"in": "query",
"description": "The invoice group (invoice collection/account) ID. Used to override automatic resolution from the journal entry.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad request result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"404": {
"description": "Not found result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal error result",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/be_lines_v3_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From be-lines-v3¤uc-m2m.json; tweaked 2026-09-07T07:08:08Z."
}
},
"/v1/cm/accounts": {
"get": {
"tags": [
"Invoice Groups"
],
"summary": "List Invoice Groups",
"description": "Returns a paginated list of all invoice groups (accounts) for the tenant.",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of invoice groups to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Return all accounts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccounts200"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccounts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{guid}": {
"get": {
"tags": [
"Invoice Groups"
],
"summary": "Get Invoice Group",
"description": "Returns the invoice group (account) with the specified ID, including the associated customer.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Return the invoice group with the specified id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccount200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccount400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccount500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Invoice Groups"
],
"summary": "Update Invoice Group",
"description": "Updates the addresses or communication details of the specified invoice group.\n\nThe update is processed asynchronously. A 202 response confirms the request was accepted, not that the update has been applied.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_UpdateAccountInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccount400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccount500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{id}/tps/{tpid}/customerandaccounts": {
"get": {
"tags": [
"Invoice Groups",
"Customers"
],
"summary": "Get Customer and Invoice Groups by Third-Party ID",
"description": "Returns the customer and all associated invoice groups identified by the given ID in a third-party system.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The invoice group ID in the third-party system.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tpid",
"in": "path",
"description": "The third-party system identifier.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Return the customer and a list of the customers invoice groups",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{guid}/accountingpointsdisplay": {
"get": {
"tags": [
"Invoice Groups",
"Metering Points"
],
"summary": "List Metering Points by Invoice Group",
"description": "Returns an overview of all metering points and their current contracts for the specified invoice group.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "showall",
"in": "query",
"description": "When true, includes reverted and ended metering points.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of metering points to return.",
"explode": false,
"schema": {
"type": "number",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Returns a simplified overview of the metering points and their current contracts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{id}/tps/{tpid}/accountingpointsdisplay": {
"get": {
"tags": [
"Invoice Groups",
"Metering Points"
],
"summary": "List Metering Points by Third-Party Invoice Group ID",
"description": "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.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The invoice group ID in the third-party system.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tpid",
"in": "path",
"description": "The third-party system identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "showall",
"in": "query",
"description": "When true, includes reverted and ended metering points.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of metering points to return.",
"explode": false,
"schema": {
"type": "number",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Returns a simplified overview of the metering points and their current contracts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{guid}/accountingpoint/{acid}/contracts": {
"get": {
"tags": [
"Contracts",
"Invoice Groups",
"Metering Points"
],
"summary": "List Contracts by Invoice Group and Metering Point",
"description": "Returns all contracts on the specified metering point that belong to the specified invoice group.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "acid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"example": "bca1872d-7b90-4fad-8c14-5d9d99d92b85"
}
}
],
"responses": {
"200": {
"description": "Returns all contracts belonging to the invoice group on the metering point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{id}/tps/{tpid}/accountingpoint{acid}/contracts": {
"get": {
"tags": [
"Contracts",
"Invoice Groups",
"Metering Points"
],
"summary": "List Contracts by Third-Party Invoice Group and Metering Point",
"description": "Returns all contracts on the specified metering point that belong to the invoice group identified by the given ID in a third-party system.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The invoice group ID in the third-party system.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tpid",
"in": "path",
"description": "The third-party system identifier.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "acid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns all contracts belonging to the invoice group on the metering point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{guid}/erase": {
"post": {
"tags": [
"Invoice Groups"
],
"summary": "Delete Invoice Group",
"description": "Initiates erasure of all personal data associated with the specified invoice group.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseAccountInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseAccount400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseAccount500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoints": {
"get": {
"tags": [
"Metering Points"
],
"summary": "List Metering Points",
"description": "Returns a paginated list of all metering points for the tenant.",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of metering points to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Returns all metering points",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoints200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoints400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoints500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"post": {
"tags": [
"Metering Points"
],
"summary": "Create Metering Point",
"description": "Creates a new metering point for the tenant.\n",
"parameters": [
{
"name": "servicetype",
"in": "header",
"description": "The service type of the metering point.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostAccountingPointsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostAccountingPoints400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostAccountingPoints500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoints/search": {
"post": {
"tags": [
"Metering Points"
],
"summary": "List Metetering Points by GSRN",
"description": "Lists metering points matching the specified metering point GSRN (aka EAN)",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPointGuidsRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Results found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPointGuids200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPointGuids400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPointGuids500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{guid}": {
"get": {
"tags": [
"Metering Points"
],
"summary": "Get Metering Point",
"description": "Returns the metering point with the specified ID.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Returns the metering point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoint200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"put": {
"tags": [
"Metering Points"
],
"summary": "Replace Metering Point",
"description": "Replaces the updatable fields of the specified metering point with the values provided in the request body.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPointRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Metering Points"
],
"summary": "Update Metering Point",
"description": "Updates one or more fields of the specified metering point.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPointRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{guid}/timeseries": {
"put": {
"tags": [
"Metering Points"
],
"summary": "Update VAT and ElCert Share",
"description": "Updates the VAT code and electricity certificate share on the specified metering point. \nEach value applies from a given start date, so several values can be set to take effect on different dates.\n\nIf the submitted values for VAT code or electricity certificate share differ from the current ones, they replace the existing values in full; \nan unchanged set is ignored. At least one of the two must contain a change, otherwise the request is rejected. \nEach value must have a value and a valid start date, and two values with the same start date are not allowed.\n\nThe update is processed asynchronously. A 202 response confirms the request was accepted, not that it has been applied. Requires super-user permissions.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The metering point GSRN identification number.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutTimeSeriesRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutTimeSeries400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{guid}/contracts": {
"get": {
"tags": [
"Contracts",
"Metering Points"
],
"summary": "List Contracts by Metering Point",
"description": "Returns all contracts on the specified metering point, optionally filtered by status or date.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "filter",
"in": "query",
"description": "Filters the contracts by status. Possible values: all, active, past, future.",
"explode": false,
"schema": {
"enum": [
"all",
"active",
"path",
"future"
],
"type": "string",
"default": "all"
}
},
{
"name": "date",
"in": "query",
"description": "Unix timestamp. Returns only contracts active at this point in time.",
"explode": false,
"schema": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
}
}
],
"responses": {
"200": {
"description": "Returns all contracts on the metering point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointContracts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{id}/apid": {
"put": {
"tags": [
"Metering Points"
],
"summary": "Replace Metering Point by GSRN",
"description": "Replaces the updatable fields of the metering point identified by its 18-digit GSRN identification number.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The metering point GSRN identification number (18 digits).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPointWithIdRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PutAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Metering Points"
],
"summary": "Update Metering Point by GSRN",
"description": "Updates one or more fields of the metering point identified by its 18-digit GSRN identification number.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The metering point GSRN identification number (18 digits).",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPointWithIdRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{id}/apid/events": {
"get": {
"tags": [
"Metering Points",
"Events"
],
"summary": "List Events by Metering Point",
"description": "Returns all events registered on the specified metering point, sorted by timestamp.\nResults include both contract module events (contract requests and state changes)\nand market process events (market hub messages such as start and end of supply).\nEvents are returned in two separate arrays: CM for contract module events,\nand MWE for market process events.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The metering point GSRN identification number (18 digits).",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns all events on the accounting point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEvents200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEvents400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEvents500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/accountingpoint/{id}/apid/event/{eid}/payload": {
"get": {
"tags": [
"Metering Points",
"Events"
],
"summary": "Get Event Payload",
"description": "Returns the full payload of a specific event on the specified metering point.\nThe event may originate from the contract module (contract requests or state changes) or from the market process engine (market hub messages).\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The metering point GSRN identification number (18 digits).",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "eid",
"in": "path",
"description": "The event ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the payload of the event",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEventPayload200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEventPayload400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEventPayload404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountingPointEventPayload500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contracts": {
"get": {
"tags": [
"Contracts"
],
"summary": "List Contracts",
"description": "Returns a paginated list of all contracts for the tenant, optionally filtered by status or date.",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of contracts to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Returns all contracts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContracts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"post": {
"tags": [
"Contracts"
],
"summary": "Create Contract",
"description": "Initiates the creation of a new contract for a customer and metering point.\nThe request is validated for required fields including customer identification, metering point identification, and product IDs.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContractsInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contracts/GetProcessAlternatives": {
"post": {
"tags": [
"Contracts"
],
"summary": "Get Contract Process Alternatives",
"description": "Returns the available process alternatives for a given customer and metering point combination.\nUsed to determine whether a supplier switch, new supply, or other process is applicable before initiating a contract.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProcessAlternatives_RequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProcessAlternatives_200"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProcessAlternatives_400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProcessAlternatives_500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contracts/terminate": {
"post": {
"tags": [
"Contracts"
],
"summary": "Terminate Contract",
"description": "Initiates termination of the active contract on the specified metering point for the given customer.\nThe contract is looked up by customer identification, metering point ID, and service type key.\nReturns 428 if the requested end date is prior to the contract's start date.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContractsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contracts/revert": {
"post": {
"tags": [
"Contracts"
],
"summary": "Revert Contract",
"description": "Reverts a contract action on the specified metering point for the given customer.\nThe reversion type must be one of: `RevertTermination`, `RevertActivation`, or `RevertProductChange`.\nReturns 428 if revert is not an available action on the contract in its current state.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContractsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}": {
"get": {
"tags": [
"Contracts"
],
"summary": "Get Contract",
"description": "Returns the contract with the specified ID, including customer, invoice group, metering point, and product details.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Returns the contract",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Contracts"
],
"summary": "Update Contract",
"description": "Applies one or more commands to update the specified contract.\nSupported commands: `RemoveProduct`, `AddProduct`, `MoveContract`, `SetEndDate`, `UpdateMoveInDate`.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContractsInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/force/activate": {
"post": {
"tags": [
"Contracts"
],
"summary": "Force Activate Contract",
"description": "Manually activates the specified contract, bypassing normal market process requirements.\nThis is an administrative action intended for corrective use.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceActivateContractInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceActivateContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceActivateContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/force/end": {
"post": {
"tags": [
"Contracts"
],
"summary": "Force End Contract",
"description": "Manually ends the specified contract, bypassing normal market process requirements.\nThis is an administrative action intended for corrective use.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEndContractInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEndContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEndContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/force/erase": {
"post": {
"tags": [
"Contracts"
],
"summary": "Force Delete Contract",
"description": "Permanently erases the specified contract and its associated data, bypassing normal process requirements.\nThis is an administrative action intended for corrective use and is irreversible.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEraseContractInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEraseContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceEraseContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/force/revert": {
"post": {
"tags": [
"Contracts"
],
"summary": "Force Revert Contract",
"description": "Manually reverts the specified contract, bypassing normal market process requirements.\nThis is an administrative action intended for corrective use.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceRevertContractInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceRevertContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceRevertContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/force/terminate": {
"post": {
"tags": [
"Contracts"
],
"summary": "Force Terminate Contract",
"description": "Manually terminates the specified contract, bypassing normal market process requirements.\nThis is an administrative action intended for corrective use.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceTerminateContractInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceTerminateContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostForceTerminateContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{corid}/corid": {
"get": {
"tags": [
"Contracts"
],
"summary": "Get Contract by Request ID",
"description": "Returns the contract associated with the specified request ID, used to look up a contract created by a known request.",
"parameters": [
{
"name": "corid",
"in": "path",
"description": "The request ID used when the contract was created.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Returns the contract",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{id}/corid/customerandaccounts": {
"get": {
"tags": [
"Contracts"
],
"summary": "Get Customer and Invoice Groups by Correlation Request ID",
"description": "Returns the customer and all associated invoice groups for the contract identified by the specified correlation ID.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The correlation ID of the contract.",
"required": true,
"schema": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"example": "bca1872d-7b90-4fad-8c14-5d9d99d92b85"
}
}
],
"responses": {
"200": {
"description": "Returns the customer and invoice groups",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAndAccounts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/terminate": {
"post": {
"tags": [
"Contracts"
],
"summary": "Terminate Contract by ID",
"description": "Terminates the specified contract. Supports the same termination reasons as POST /contracts/terminate,\nbut targets a contract directly by ID rather than by customer identification and metering point.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContractRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_TerminateContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/contract/{guid}/revert": {
"post": {
"tags": [
"Contracts"
],
"summary": "Revert Contract by ID",
"description": "Reverts the specified contract.\nSupports skipping market process messages via optional flags in the request body.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContractRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContract400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_RevertContract500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customers": {
"get": {
"tags": [
"Customers"
],
"summary": "List Customers",
"description": "Returns a paginated list of all customers for the tenant.",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of customers to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Returns all customers",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomers200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Customers"
],
"summary": "Update Customer by National Identity Number",
"description": "Updates the customer identified by the national identity number provided in the request body.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerInput2"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"post": {
"tags": [
"Customers"
],
"summary": "Create Customer",
"description": "Creates a new customer, optionally with a default invoice group and invoice settings.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomersRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customers/slim": {
"get": {
"tags": [
"Customers"
],
"summary": "List Customer Summaries",
"description": "Returns a compact list of customers containing only identification and name fields.\nSupports filtering by identification regex, country code, and customer type (person or company).\n",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of customers to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
},
{
"name": "identificationregex",
"in": "query",
"description": "URL-encoded regular expression to filter customers by national identity number or organisation number.",
"explode": false,
"schema": {
"type": "string",
"example": "%5E(%5B4%5D%5B1-9%5D%7C%5B5-6%5D%5B0-9%5D%7C7%5B0-1%5D)(0%5B1-9%5D%7C1%5B0-2%5D)%5B0-9%5D%7B7%7D%24"
}
},
{
"name": "countrycode",
"in": "query",
"description": "Filters customers by country code, e.g. NO.",
"explode": false,
"schema": {
"type": "string",
"example": "NO"
}
},
{
"name": "isperson",
"in": "query",
"description": "When true, returns only private customers. When false, returns only corporate customers.",
"explode": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Returns all requested customers",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomersSlim200"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customers/phone": {
"post": {
"tags": [
"Customers"
],
"summary": "List Customer IDs by Phone Number or Email",
"description": "Returns the IDs of all customers associated with the specified phone number or email address.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomersWithPhoneNumberRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Returns all customerguids",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomersWithPhoneNumber200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomersWithPhoneNumber400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomersWithPhoneNumber500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customers/search": {
"post": {
"tags": [
"Customers"
],
"summary": "Search Customers",
"description": "Searches for customers matching the specified criteria and returns their IDs.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomerGuidsRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Results found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomerGuids200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomerGuids400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomerGuids500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}": {
"get": {
"tags": [
"Customers"
],
"summary": "Get Customer",
"description": "Returns the customer with the specified ID.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Returns the customer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomer200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Customers"
],
"summary": "Update Customer",
"description": "Updates the details of the specified customer.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{id}/nin": {
"patch": {
"tags": [
"Customers"
],
"summary": "Update Customer by National Identity Number",
"description": "Updates the customer identified by the national identity number in the path.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer's national identity number.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/contacts": {
"post": {
"tags": [
"Customers"
],
"summary": "Create Contact Person",
"description": "Creates a new contact person and associates them with the specified customer.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContactsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContacts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContacts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/offers": {
"get": {
"tags": [
"Customers",
"Offers"
],
"summary": "List Offers by Customer",
"description": "Returns all offers associated with the specified customer.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffers200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerOffers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerOffers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{id}/tps/{tpid}/offers": {
"get": {
"tags": [
"Customers",
"Offers"
],
"summary": "List Offers by Third-Party Customer ID",
"description": "Returns all offers associated with the customer identified by the given ID in a third-party system.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer ID in the third-party system.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "tpid",
"in": "path",
"description": "The third-party system identifier.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffers200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerOffers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerOffers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/account/{guid}/contacts": {
"post": {
"tags": [
"Invoice Groups"
],
"summary": "Create Contact for Invoice Group",
"description": "Creates a new contact person and associates them with the specified invoice group.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContactsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContacts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostContacts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{id}/requestid": {
"get": {
"tags": [
"Customers"
],
"summary": "Get Customer by Request ID",
"description": "Returns the customer and their default invoice group associated with the specified request ID,\nused to look up a customer created by a known request.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The request ID used when the customer was created.",
"required": true,
"schema": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"example": "bca1872d-7b90-4fad-8c14-5d9d99d92b85"
}
}
],
"responses": {
"200": {
"description": "Returns the customer and it's default invoice group",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerByRequestID200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerByRequestID400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerByRequestID500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/accounts": {
"get": {
"tags": [
"Customers",
"Invoice Groups"
],
"summary": "List Customer Invoice Groups",
"description": "Returns all invoice groups, contacts, and customer details for the specified customer.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Returns the customer's invoice groups",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAccounts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAccounts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAccounts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"post": {
"tags": [
"Customers",
"Invoice Groups"
],
"summary": "Create Invoice Group",
"description": "Creates a new invoice group for the specified customer.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccountsInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccounts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccounts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/accountingpointsdisplay": {
"get": {
"tags": [
"Contracts",
"Metering Points",
"Invoice Groups"
],
"summary": "List Metering Points Summary by Customer",
"description": "Returns a simplified overview of all metering points and their current contracts across all invoice groups for the specified customer.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "showall",
"in": "query",
"description": "When true, includes reverted and ended metering points.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of metering points to return.",
"explode": false,
"schema": {
"maximum": 100,
"type": "number",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Returns a simplified overview of the accounting points and their current contract",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetCustomerAccountingPointsDisplay200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointsDisplay500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/accountingpoint{acid}/contracts": {
"get": {
"tags": [
"Contracts",
"Metering Points",
"Customers"
],
"summary": "List Contracts by Customer and Metering Point",
"description": "Returns all contracts on the specified metering point that belong to the specified customer.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "acid",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"example": "bca1872d-7b90-4fad-8c14-5d9d99d92b85"
}
}
],
"responses": {
"200": {
"description": "Returns all contracts belonging to the customer on the metering point",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetAccountAccountingPointContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/accountingpoint": {
"post": {
"tags": [
"Metering Points",
"Customers"
],
"summary": "Set Metering Point Nickname",
"description": "Sets a customer-defined nickname on the specified metering point.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostAccountingPointNicknameRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccountingPoint400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccountingPoint404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerAccountingPoint500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/contracts": {
"post": {
"tags": [
"Contracts"
],
"summary": "Create a new contract or change the product on an accounting point",
"description": "",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The uc id of the customer",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerContractsRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostCustomerContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/contract/{cguid}": {
"patch": {
"tags": [
"Customers",
"Contracts"
],
"summary": "Apply Contract Commands",
"description": "Applies one or more commands to update the specified contract, verifying that the contract belongs to the specified customer before processing.\nSupported commands: `RemoveProduct`, `AddProduct`, `MoveContract`, `SetEndDate`, `UpdateMoveInDate`.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "cguid",
"in": "path",
"description": "The contract ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContractsInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContracts400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Contract not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_contract_404"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchContracts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/account/{acguid}": {
"patch": {
"tags": [
"Customers",
"Invoice Groups"
],
"summary": "Update Customer Invoice Group",
"description": "Updates the address or communication details of the specified invoice group belonging to the customer.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
},
{
"name": "acguid",
"in": "path",
"description": "The invoice group ID.",
"required": true,
"schema": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"example": "bca1872d-7b90-4fad-8c14-5d9d99d92b85"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerAccountRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerAccount400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_account_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchCustomerAccount500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/erase": {
"post": {
"tags": [
"Customers"
],
"summary": "Delete Customer",
"description": "Initiates erasure of all personal data associated with the specified customer.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseCustomer_RequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"428": {
"description": "Not permitted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_action_not_permitted"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/status": {
"post": {
"summary": "🕚 Change a customers status",
"description": "",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The uc id of the customer",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_change_customer_status_req_body"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_change_customer_status_400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_change_customer_status_500"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/sync": {
"post": {
"tags": [
"Customers"
],
"summary": "Sync Customer Data",
"description": "Requests a synchronisation of the specified customer's data from an external source.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SyncCustomerRequestBody"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SyncCustomer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SyncCustomer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/opportunity/{guid}": {
"get": {
"tags": [
"Contracts"
],
"summary": "Get Opportunity",
"description": "Returns the opportunity ID associated with the specified customer, used to retrieve the CRM opportunity created during contract initiation.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Opportunity found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOpportunity200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOpportunity400"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOpportunity404"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/opportunity/{id}/AcceptOffer": {
"post": {
"tags": [
"Offers",
"Freshsales"
],
"summary": "Accept Offer",
"description": "Accepts the specified offer in FreshSales and triggers contract creation.\nFetches the contract data associated with the opportunity from FreshSales\nand initiates an asynchronous contract creation request.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The FreshSales opportunity ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Request forwarded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_tp_accept_offer_500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/search/customer": {
"post": {
"tags": [
"Customers"
],
"summary": "Search Customers",
"description": "Searches for customers matching the specified criteria across multiple fields and returns matching results.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomersRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Results found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomers200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomers404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchCustomers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/search/accountingpoints": {
"post": {
"tags": [
"Metering Points"
],
"summary": "Search Metering Points",
"description": "Searches for metering points whose GSRN identification or ID matches the supplied query string, scoped to the given service type.\nWhen `CheckStatus` is true, each result also indicates whether the metering point currently has an active contract and the associated customer.\nResults are paginated. A query string shorter than three characters returns an empty result set.\n",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of results to return.",
"explode": false,
"schema": {
"type": "number"
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPointsRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Results found",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPoints200_a"
},
{
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPoints200_b"
}
]
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPoints400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_SearchAccountingPoints500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/customer/{guid}/archive": {
"post": {
"tags": [
"Customers"
],
"summary": "Archive Customer",
"description": "Archives the specified customer, removing them from active use while retaining their data.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The customer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_archive_customer_req_body"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_archive_customer_status_400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_customer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_archive_customer_status_500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/offers": {
"get": {
"tags": [
"Offers"
],
"summary": "List Offers",
"description": "Returns a paginated list of all offers for the tenant.",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of invoice groups to return.",
"explode": false,
"schema": {
"type": "number",
"default": 10
}
},
{
"name": "page",
"in": "query",
"description": "The page number.",
"explode": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Returns all contracts",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffers200"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"post": {
"tags": [
"Offers"
],
"summary": "Create Offer",
"description": "Creates a new offer for a customer.\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffersInput"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffers200"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/offer/{guid}": {
"get": {
"tags": [
"Offers"
],
"summary": "Get Offer",
"description": "Returns the offer with the specified ID.",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The offer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_Offer"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetOffer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"put": {
"tags": [
"Offers"
],
"summary": "Replace Offer",
"description": "Replaces the specified offer with the values provided in the request body.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The offer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffersInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "User error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffers400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Duplicate request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"500": {
"description": "DBError",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PostOffers500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/offer/{guid}/abandon": {
"post": {
"tags": [
"Offers"
],
"summary": "Cancel Offer",
"description": "Cancels the specified offer, preventing further processing.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The offer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOfferInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/offer/{guid}/erase": {
"post": {
"tags": [
"Offers"
],
"summary": "Delete Offer",
"description": "Permanently erases the specified offer and its associated data.\n",
"parameters": [
{
"name": "guid",
"in": "path",
"description": "The offer ID.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOfferInput"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_202Default"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_403Default"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer_404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_EraseOffer500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/product/{id}": {
"get": {
"tags": [
"Product Offerings"
],
"summary": "Get Product Offering",
"description": "Retrieves a single Product Offering by its ID.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the Product Offering",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProduct200"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"404": {
"description": "Product not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProduct404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProduct500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
},
"patch": {
"tags": [
"Product Offerings"
],
"summary": "Update Product Offering",
"description": "Updates one or more fields on a Product Offering.\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the Product Offering to update.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchProductRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchProduct400"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_PatchProduct500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/v1/cm/products": {
"get": {
"tags": [
"Product Offerings"
],
"summary": "List Product Offerings",
"description": "Returns a paginated list of all Product Offerings for the tenant.",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProducts200"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_401Default"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_contract_cm_GetProducts500"
}
}
}
}
},
"x-uc-meta": "From cm-contract¤uc-m2m.json; tweaked 2026-09-07T07:08:09Z."
}
},
"/cm/servicetypes/v2/validationrules": {
"get": {
"tags": [
"Service Types"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ValidationRulesList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/validationrules/servicetypes/{serviceTypeKey}": {
"get": {
"tags": [
"Service Types"
],
"parameters": [
{
"name": "serviceTypeKey",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_FieldValidationRule"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/validationrules/countries/{countryCode}": {
"get": {
"tags": [
"Service Types"
],
"parameters": [
{
"name": "countryCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_FieldValidationRule"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes": {
"get": {
"tags": [
"Service Types"
],
"summary": "List Service Types",
"description": "Gets all service types for a tenant; both enabled system service types and custom service types.",
"parameters": [
{
"name": "includeSystem",
"in": "query",
"description": "Whether to return system service types or not. Default is true.",
"explode": false,
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "includeCustom",
"in": "query",
"description": "Whether to return custom service types or not. Default is true.",
"explode": false,
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"post": {
"tags": [
"Service Types"
],
"summary": "Create Custom Service Type",
"description": "Creates a new custom service type for a tenant.",
"requestBody": {
"description": "The custom service type definition to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes/{serviceTypeKey}": {
"get": {
"tags": [
"Service Types"
],
"summary": "Get Service Type",
"description": "Gets one service types for a tenant. Can get both enabled system service types and custom service types.",
"parameters": [
{
"name": "serviceTypeKey",
"in": "path",
"description": "The unique key of the service type.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"put": {
"tags": [
"Service Types"
],
"summary": "Replace Custom Service Type",
"description": "Updates an existing custom service type (a full update, a replacement) for a tenant.",
"parameters": [
{
"name": "serviceTypeKey",
"in": "path",
"description": "The unique key of the custom service type.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The request body containing the complete custom service type definition to replace the existing service type with.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"patch": {
"tags": [
"Service Types"
],
"summary": "Update Custom Service Type",
"description": "Partially updates a custom service type using a JSON Patch request (RFC 6902).\nThe request body is an array of operations (changes to apply), each with type of operation, path to element to update, and the new value.\nIf any operation in the array fails, none of the operations are applied.\n\nOperation (`op`) can be one of these:\n\n- `add`: adds a property to the object or an element to an array; for an existing property it sets a value\n- `remove`: removes a property or an array element\n- `replace`: same as remove followed by add at the same location\n- `test`: returns success status code if the value at the specified path equals the specified value\n \nPath (`path`) starts with a slash (`/`) and has slashes between levels. Use zero-based index to specify array elements, e.g. `/addresses/0`. Use hyphen (`-`) to add to the end of an array, e.g. `/addresses/-`.\n\nValue (`value`) can be any JSON object (string, etc).\n\nSee [learn.microsoft.com](https://learn.microsoft.com/en-us/aspnet/core/web-api/jsonpatch?view=aspnetcore-7.0#json-patch) for syntax and examples. \nMore details in [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902).",
"parameters": [
{
"name": "serviceTypeKey",
"in": "path",
"description": "The unique key of the custom service type.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The JSON Patch operations to apply to the custom service type.",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_Operation`1"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_Operation`1"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"delete": {
"tags": [
"Service Types"
],
"summary": "Delete Custom Service Type",
"description": "Deletes a custom service type for a tenant.\n\nThis operation is idempotent. It returns a successful response even if no\ncustom service type exists with the specified key.",
"parameters": [
{
"name": "serviceTypeKey",
"in": "path",
"description": "The unique key of the custom service type.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes/query": {
"get": {
"tags": [
"Service Types"
],
"summary": "List Available Service Types",
"description": "Retrieves the system and custom service types available for a tenant and country.\nQuerying by country code also returns service types which are available in all countries.",
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "Country code according to ISO 3166-1 alpha-2, e.g. NO, FI.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes/systemkeys": {
"get": {
"tags": [
"Service Types"
],
"summary": "List System Service Type Keys",
"description": "Retrieves the keys for all system service types.\n\nNote: Not all system service type keys are available for all tenants.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes/systemtypes": {
"get": {
"tags": [
"Service Types"
],
"summary": "List System Service Types",
"description": "Retrieves all system service types.\n\nNote: Not all system service types are available for all tenants.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ServiceType"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/servicetypes/v2/servicetypes/timezones": {
"get": {
"tags": [
"Service Types"
],
"summary": "List IANA Time Zones",
"description": "Retrieves the supported IANA time zone names.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_servicetypes_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-servicetypes¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/viewer/{signRequestGuid}/signatories/{signatoryId}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Sign Request for Signatory",
"description": "Returns the sign request or consent order for the specified signatory, including the data required to render the signing view.\n \nAccess is authorized using the signatory's bearer token.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequestView"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/viewer/{signRequestGuid}/signatories/{signatoryId}/files/{fileName}/download": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Download Sign Request File",
"description": "Downloads a file associated with the sign request or consent order for the specified signatory.\n \nAccess is authorized using the signatory's bearer token.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileName",
"in": "path",
"description": "The file name.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/texttemplates": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Text Templates",
"description": "Retrieves the text templates available for a tenant.\n \nUse this endpoint to list configured text templates that can be used to generate\ndocuments or signing content.",
"operationId": "GetAllTextTemplatesAsync",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Create Text Template",
"description": "Creates a text template for a tenant.",
"requestBody": {
"description": "The request body containing the text template details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateTextTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/texttemplates/{textTemplateGuid}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Text Template",
"description": "Retrieves a text template by ID.\n \nReturns `404 Not Found` if no text template exists with the specified ID.",
"parameters": [
{
"name": "textTemplateGuid",
"in": "path",
"description": "The unique ID of the text template to retrieve.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"put": {
"tags": [
"Signing and Consent"
],
"summary": "Replace Text Template",
"description": "Replaces an existing text template.\n \nUse this endpoint when the complete text template should be updated with a new\nversion of the template definition.",
"parameters": [
{
"name": "textTemplateGuid",
"in": "path",
"description": "The unique ID of the text template to replace.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the updated text template details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_UpdateTextTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Text Template",
"description": "Partially updates a text template using a JSON Patch request (RFC 6902).\nThe request body is an array of operations (changes to apply), each with type of operation, path to element to update, and the new value.\nIf any operation in the array fails, none of the operations are applied.\n\nOperation (`op`) can be one of these:\n\n- `add`: adds a property to the object or an element to an array; for an existing property it sets a value\n- `remove`: removes a property or an array element\n- `replace`: same as remove followed by add at the same location\n- `test`: returns success status code if the value at the specified path equals the specified value\n \nPath (`path`) starts with a slash (`/`) and has slashes between levels. Use zero-based index to specify array elements, e.g. `/addresses/0`. Use hyphen (`-`) to add to the end of an array, e.g. `/addresses/-`.\n\nValue (`value`) can be any JSON object (string, etc).\n\nSee [learn.microsoft.com](https://learn.microsoft.com/en-us/aspnet/core/web-api/jsonpatch?view=aspnetcore-7.0#json-patch) for syntax and examples. \nMore details in [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902).",
"parameters": [
{
"name": "textTemplateGuid",
"in": "path",
"description": "The unique ID of the text template to update.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The JSON Patch operations to apply to the text template.",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_UpdateTextTemplateRequestOperation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_UpdateTextTemplateRequestOperation"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"delete": {
"tags": [
"Signing and Consent"
],
"summary": "Delete Text Template",
"description": "Deletes a text template.",
"parameters": [
{
"name": "textTemplateGuid",
"in": "path",
"description": "The unique ID of the text template to delete.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/texttemplates/query": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Available Text Templates",
"description": "Retrieves the text templates available for a product.\n \nUse this endpoint to determine which text templates can be used for a specific\nproduct.\n \nTemplates that are not restricted to specific products are included in the\nresult and sorted after product-specific templates.",
"parameters": [
{
"name": "productId",
"in": "query",
"description": "The unique ID of the product to retrieve available text templates for.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_TextTemplateResponse"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/texttemplates/standards": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Standard Text Templates",
"description": "Retrieves the standard text templates available for a tenant.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_StandardTextTemplate"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/texttemplates/standards/{standardTextTemplateKey}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Standard Text Template",
"description": "Retrieves a standard text template by key.\n \nReturns `404 Not Found` if no standard text template exists with the specified key.",
"parameters": [
{
"name": "standardTextTemplateKey",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_StandardTextTemplate"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Sign Requests",
"description": "Retrieves sign requests for a tenant.\n \nResults are paged. The first page is `1`.",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "The number of sign requests to return per page. Default page size is `10`.",
"explode": false,
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number to retrieve. The first page is `1`, and the default value is `1`.",
"explode": false,
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Sign Request",
"description": "Retrieves a sign request by ID.\n \nReturns `404 Not Found` if no sign request exists with the specified ID.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to retrieve.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"delete": {
"tags": [
"Signing and Consent"
],
"summary": "Delete Sign Request",
"description": "Deletes a sign request.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to delete.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{referenceType}/{referenceId}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Sign Request by Reference",
"description": "Retrieves a sign request by reference type and reference ID.\n \nReturns `404 Not Found` if no sign request exists for the specified reference.",
"parameters": [
{
"name": "referenceType",
"in": "path",
"description": "The referenced resource type. Supported values are `Offer` and `Contract`.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_websign_ReferenceType"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The ID of the resource referenced by the sign request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{referenceType}/{referenceId}/slim": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Sign Request Summary by Reference",
"description": "Retrieves a sign request summary by reference type and reference ID.\n \nUse this endpoint when only the key sign request properties are needed, for\nexample in WebOrder flows.\n \nReturns `404 Not Found` if no sign request exists for the specified reference.",
"parameters": [
{
"name": "referenceType",
"in": "path",
"description": "The referenced resource type. Supported values are `Offer` and `Contract`.",
"required": true,
"schema": {
"$ref": "#/components/schemas/cm_websign_ReferenceType"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The ID of the referenced offer or contract.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequestSlim"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/attachedfiles": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Create Sign Request with Files",
"description": "Creates a sign request with JSON metadata and one or more documents to sign.\n \nUse this endpoint when the documents to be signed are uploaded together with\nthe sign request. The request must use `multipart/form-data`.\n \nThe multipart form data must contain:\n \n- `json`: A text field containing the sign request JSON.\n- `file`: One or more file fields containing the documents to sign.\n \nThe `json` field must use the same JSON model as the documented request body\nfor creating a sign request with attached files. \nSee `POST signrequests/docforattachedfiles` for documentation of the JSON model/DTO to use.\n \nMax size of a single file is ≈ 5 MB, and max total size of all files is ≈ 9 MB.\n\nNote: Swagger UI may not support sending this multipart request correctly. Use\nPostman or application code when testing this endpoint.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"json"
],
"type": "object",
"properties": {
"json": {
"type": "string",
"description": "Use key `json` of type `Text` containing JSON. Use Postman or code to send this. Swagger UI doesn't work."
},
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"json": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"required": [
"json"
],
"type": "object",
"properties": {
"json": {
"type": "string",
"description": "Use key `json` of type `Text` containing JSON. Use Postman or code to send this. Swagger UI doesn't work."
},
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"json": {
"style": "form"
},
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateSignRequestResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/signedfiles": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Create Sign Request with Signed Files",
"description": "Creates a sign request with JSON metadata and one or more already signed PDF files.\n \nUse this endpoint when the documents have already been signed outside UtilityCloud\nand should be registered as signed files. The request must use `multipart/form-data`.\n \nThe multipart form data must contain:\n \n- `json`: A text field containing the sign request JSON.\n- `file`: One or more file fields containing the signed PDF files.\n \nThe `json` field must use the documented sign request payload model for signed files. \nSee `POST signrequests/docforsignedfiles` for documentation of the JSON model/DTO to use.\n \nMax size of a single file is ≈ 5 MB, and max total size of all files is ≈ 9 MB.\n\nNote: Swagger UI may not support sending this multipart request correctly. Use\nPostman or application code when testing this endpoint.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"json"
],
"type": "object",
"properties": {
"json": {
"type": "string",
"description": "Use key `json` of type `Text` containing JSON. Use Postman or code to send this. Swagger UI doesn't work."
},
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"json": {
"style": "form"
},
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"required": [
"json"
],
"type": "object",
"properties": {
"json": {
"type": "string",
"description": "Use key `json` of type `Text` containing JSON. Use Postman or code to send this. Swagger UI doesn't work."
},
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"json": {
"style": "form"
},
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateSignRequestResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/texttemplates": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Create Sign Request from Text Templates",
"description": "Creates a sign request and generates the PDF documents to sign from text templates.",
"requestBody": {
"description": "The request body containing the sign request details and text template references.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateSignRequestWithTextTemplates"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateSignRequestResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/cancel": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Cancel Sign Request",
"description": "Cancels a sign request.\n \nOnly sign requests with status `Unknown`, `InProgress`, or `Error` can be cancelled.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to cancel.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/sync": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Sign Request",
"description": "Update sign request with the current statuses from Idura (fka Criipto) and retry Elhub errors.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to update.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/retrypdf": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Retry Sign Request PDF Generation",
"description": "Retries PDF generation for a sign request.\n \nUse this endpoint to restart PDF generation when the previous generation attempt\nfailed or did not complete successfully.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to retry PDF generation for.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/retryidura": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Retry sending Sign Request to Idura",
"description": "Retries sending the sign request to Idura. Will return BadRequest if the sign request has already been sent to Idura if PDFs have not been generated yet, if we have no Elhub PDF, or .",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request to retry Idura for.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_SignRequest"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/files": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Upload files to a Sign Request",
"description": "Upload PDF files to be associated with an existing sign request.\n \nUse this endpoint when the documents have already been signed outside UtilityCloud\nand should be registered as signed files. The request must use `multipart/form-data`.\n \nThe multipart form data must contain:\n \n- `file`: One or more file fields containing the signed PDF files.\n \nMax size of a single file is ≈ 5 MB, and max total size of all files is ≈ 9 MB.\n \nNote: Swagger UI may not support sending this multipart request correctly. Use\nPostman or application code when testing this endpoint.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "Use one or more files all with key `file` of type `File`."
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/files/{fileName}": {
"delete": {
"tags": [
"Signing and Consent"
],
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/files/{fileName}/download": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Download file from Sign Request",
"description": "Downloads a file associated with a sign request.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fileName",
"in": "path",
"description": "The name of the file to download.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/signrequests/{signRequestGuid}/resendcommunication": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Resend Sign Request Communication",
"description": "Resends email and/or SMS communication for a sign request.\n \nUse this endpoint when a recipient needs to receive the signing link again.\n \nIf the sign request has multiple signers, the request must include\n`SsnFirstSixDigits` to identify which signer should receive the communication.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The unique ID of the sign request.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the communication channel and recipient details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CommunicationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/mergedata/offers/{offerGuid}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Offer Merge Data",
"description": "Retrieves the JSON merge data used to generate offer documents.\n \nUse this endpoint when a client needs the data model used for rendering offer\nPDFs or previewing offer document templates.\n \nUse the empty GUID `00000000-0000-0000-0000-000000000000` to retrieve fake\npreview data instead of data for an existing offer.",
"parameters": [
{
"name": "offerGuid",
"in": "path",
"description": "The unique ID of the offer, or the empty GUID to retrieve fake preview data.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "fakeApsCount",
"in": "query",
"description": "The number of fake metering points to include when retrieving preview data.",
"explode": false,
"schema": {
"maximum": 10,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 1
}
},
{
"name": "previewProductId",
"in": "query",
"description": "The product ID to use when retrieving preview data.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/mergedata/offers/fields": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Offer Merge Fields",
"description": "Retrieves the available merge fields for offer document templates.\n \nUse this endpoint to show which fields can be used when rendering offer texts\nor offer documents. Field names and descriptions are returned in the requested\nlanguage when available.\n \nIf the language code is omitted, unknown, or not supported, English is used.",
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "The ISO 639-1 language code, using two lowercase letters, for example `en`, `no`, `fi`, or `sv`.",
"explode": false,
"schema": {
"pattern": "^[a-z]{2}$",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_MergeField"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/generators/text": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Generate Text from Template",
"description": "Merges a template with JSON data using Handlebars expressions. Can also be used to make sure the expressions in the template are valid. Returns 200-OK if the syntax is correct.\n\nThe use of HTML tags in property values in `jsonData` is not supported.\nFor more information on Handlebars expressions see its [language guide](https://handlebarsjs.com/guide/).",
"requestBody": {
"description": "The request body containing the template and JSON data used to generate the text.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_GenerateTextRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/generators/pdf": {
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Generate PDF from Template",
"description": "Generates a PDF document from an HTML template merged with JSON data using Handlebars expressions.\n\nThe use of HTML tags in property values in `jsonData` is not supported.\nIf setting `headerHtmlTemplate` and/or `footerHtmlTemplate`, also set `pdfOptions.margins.top` and/or `pdfOptions.margins.bottom`. \nAlso set a font-size for your header/footer (e.g. ` ...
`).\nFor more information on Handlebars expressions see its [language guide](https://handlebarsjs.com/guide/).\nWe're using Chrome (headless) which uses Skia to create PDFs. If the HTML looks good in Chrome, the PDF should look good too.\nUse CSS page-break to split the content into several pages ([details](https://css-tricks.com/almanac/properties/p/page-break/)).\nUse `PdfTitle` or a HTML `title` tag to set the PDF's title property. No other PDF properties can be set.\nThe `Content-Type` HTTP header of the response is `application/pdf`.",
"requestBody": {
"description": "The request body containing the HTML template, JSON data, and PDF options used to generate the PDF document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_GeneratePdfRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/generators/info": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Template Merge Information",
"description": "Returns information about how to use text templates for merging data, including the available merge fields.\n \nWhen the language code is omitted, unknown, or not supported, English is used.",
"parameters": [
{
"name": "languageCode",
"in": "query",
"description": "Language code must be two lowercase letters (a-z) used in ISO 639-1. If language code is unknown or we don't have a translation, \"en\" (english) is used.",
"explode": false,
"schema": {
"pattern": "^[a-z]{2}$",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ContentBlock"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/elhub/authorizationdocuments": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "List Authorization Documents",
"description": "Retrieves the authorization documents available for a tenant.\nUse this endpoint to get authorization documents that can be used in signing or consent workflows.\n \nPaging is not currently supported for this operation.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_AuthorizationDocumentResponse"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"post": {
"tags": [
"Signing and Consent"
],
"summary": "Create Authorization Document",
"description": "Creates an authorization document for a person and metering point.\n \nUse this endpoint when a signing or consent workflow requires an authorization\ndocument for a specific person and metering point. The request body contains\nthe person information, metering point data, language code, and time zone used to create the document.",
"requestBody": {
"description": "The request body containing the authorization document details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_CreateAuthorizationDocumentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_AuthorizationDocumentResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/elhub/authorizationdocuments/{authDocId}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Authorization Document",
"description": "Retrieves an authorization document by ID.\nUse this endpoint to get the details of a specific authorization document for\na tenant.\nReturns a 404 Not Found response if the specified authorization document does not exist for the given tenant.",
"parameters": [
{
"name": "authDocId",
"in": "path",
"description": "The unique identifier of the authorization document to retrieve.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_AuthorizationDocumentResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
},
"put": {
"tags": [
"Signing and Consent"
],
"summary": "Replace Authorization Document PDF",
"description": "Replaces the PDF file for an existing authorization document.\nOnly a single file upload is supported. The maximum allowed file size is approximately 500 KB. If more than one file is provided, the request will be rejected.",
"parameters": [
{
"name": "authDocId",
"in": "path",
"description": "The unique identifier of the authorization document to update.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "The collection of files uploaded with the request. Must contain exactly one PDF file to be used as the updated document."
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
},
"description": "The collection of files uploaded with the request. Must contain exactly one PDF file to be used as the updated document."
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/elhub/authorizationdocuments/{authDocId}.pdf": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Authorization Document PDF",
"description": "Retrieves an authorization document as a PDF file.\nUse this endpoint to download the PDF representation of a specific authorization\ndocument.\n \nNote: If the authorization document does not exist, Elhub return `406 Not Acceptable`.",
"parameters": [
{
"name": "authDocId",
"in": "path",
"description": "The unique identifier of the authorization document to retrieve. This value is required and must be provided in the route.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/elhub/marketparties": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Market Party",
"description": "Retrieves market party information by Global Location Number (GLN).\n \nReturns `404 Not Found` if no matching market party exists.",
"parameters": [
{
"name": "gln",
"in": "query",
"description": "The Global Location Number (GLN) of the market party to look up. Cannot be null.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_MarketPartyInfoResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Get Consent Order",
"description": "Returns the consent order for the specified signatory.\n \nAccess is authorized using the signatory key. When the consent order has already been accepted by all signatories, \nthe request is rejected with 451 unless view mode is used.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "mode",
"in": "query",
"description": "The retrieval mode. Use view mode to retrieve an already accepted consent order.",
"explode": false,
"schema": {
"$ref": "#/components/schemas/cm_websign_Mode"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ConsentOrder"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/files/{fileName}/download": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Download Consent Order File",
"description": "Downloads a file associated with the consent order for the specified signatory.\n \nAccess is authorized using the signatory key.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileName",
"in": "path",
"description": "The file name.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "mode",
"in": "query",
"description": "The retrieval mode. Use view mode to access a consent order that has already been accepted.",
"explode": false,
"schema": {
"$ref": "#/components/schemas/cm_websign_Mode"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/noop": {
"get": {
"tags": [
"Signing and Consent"
],
"summary": "Check Consent Order Access",
"description": "Validates signatory access to a consent order and returns the resulting status without \nreturning the consent order or any file content.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/opened": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Consent Order Status to Opened",
"description": "Records that the signatory has opened the consent order.\n \nThe status is updated only while the consent order is in progress.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/accepted": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Consent Order Status to Accepted",
"description": "Records that the signatory has accepted the consent order.\n \nThe status is updated only while the consent order is in progress. \nAuthentication details are captured from the bearer token when present.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/rejected": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Consent Order Status to Rejected",
"description": "Records that the signatory has rejected the consent order, including the rejection reason.\n \nThe status is updated only while the consent order is in progress.",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The request body containing the rejection reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_RejectRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/cm/websign/v1/consentorders/{signRequestGuid}/signatories/{signatoryId}/error": {
"patch": {
"tags": [
"Signing and Consent"
],
"summary": "Update Consent Order Status to Failed",
"parameters": [
{
"name": "signRequestGuid",
"in": "path",
"description": "The sign request ID.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "signatoryId",
"in": "path",
"description": "The signatory ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "key",
"in": "query",
"description": "The access key calculated for the signatory.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The request body containing the error message.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ErrorRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"451": {
"description": "Unavailable For Legal Reasons",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cm_websign_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From cm-websign¤uc-m2m.json; tweaked 2026-09-07T07:08:10Z."
}
},
"/se/api-pricelist/v1/backend/pricelist/createorupdate": {
"post": {
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025]",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/backend/pricelist",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListMessage"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListMessage"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListMessage"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v2/backend/pricelist": {
"post": {
"tags": [
"Price List Entries"
],
"summary": "Create or Update Price List Entries",
"description": "Creates or updates price list entries for one or more price lists in a single request.\n\nEntries are grouped by price list name. For each price list, new entries are merged with existing data. \nEntries with matching start times are replaced, and entries with non-overlapping start times are preserved. \nTags from the request are merged with existing tags on the stored price list.\n\nNote: All entry start times must be at 00:00 in the resolved timezone. \nIf a timezone is provided in the header property of the body, it is used; otherwise the tenant's default timezone applies. \nurrency must be NOK, SEK, or EUR if provided. \nA price list may not have more than one of the following tags at the same time: !montlyprice, !dailyprice, !monthlyconsumption.\n\nOn success, a service bus message is sent to notify downstream consumers of each changed price list. The response body is empty.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntriesDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntriesDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntriesDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string"
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v1/product/pricelist/{id}": {
"get": {
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025]",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/product/pricelist/{id}",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListResponse"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v1/product/pricelists": {
"get": {
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025]",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/product/pricelists/",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListListing"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListListing"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v2/product/pricelist/{id}": {
"get": {
"tags": [
"Price List"
],
"summary": "Get Price List",
"description": "Returns a single price list by ID, including all time-indexed price entries.\n\nThe response includes an acknowledgement envelope and the price list data. \nIf the price list is not found, a 200 response is returned with a NACK acknowledgement code rather than a 404. \nIf the price list does not have a stored timezone identifier, the tenant's default timezone is applied.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The price list ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListResponseDto"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListResponseDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v2/product/pricelist/priceareas": {
"get": {
"tags": [
"Price List"
],
"summary": "List Price Areas",
"description": "Returns the available market price areas, grouped by country code.\n\nIf a country code is provided, only price areas for that country are returned. \nIf omitted, all supported countries and their price areas are returned. The returned keys are ISO 3166-1 alpha-2 country codes.",
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "The ISO 3166-1 alpha-2 country code to filter by. If omitted, all countries are returned.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/api-pricelist/v2/product/pricelists": {
"get": {
"tags": [
"Price List"
],
"summary": "List Price Lists",
"description": "Returns all price lists available for the tenant.\n\nEach item in the response includes the price list ID, description, visibility status, tags, timezone identifier, and last-updated timestamp. \nPrice list entries are not included, use GET /v2/product/pricelist/{id} to retrieve the full price list with entries.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListListing"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListListing"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_pricelist_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-pricelist¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products": {
"get": {
"tags": [
"doc-product"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] List Products",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns all products available for the tenant, optionally filtered by price area, grid area, service type, or product tags.\n\nWhen `gridArea` is provided and `pricearea` is not, the price area is resolved from the grid area. \nWhen `requiretags` is provided, only products matching all specified tags are returned. \nWhen `tags` is provided, only products matching at least one of the specified tags are returned. \nWhen `primaryonly` is set to true, only primary products are returned.",
"parameters": [
{
"name": "uc-request-source",
"in": "header",
"description": "The request source identifier.",
"schema": {
"type": "string"
}
},
{
"name": "pricearea",
"in": "query",
"description": "Filters products by price area.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "gridArea",
"in": "query",
"description": "Filters products by grid area. The corresponding price area is resolved automatically.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "serviceType",
"in": "query",
"description": "Filters products by service type.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "requiretags",
"in": "query",
"description": "Comma-separated list of tags that all returned products must have.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tags where returned products must match at least one.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "primaryonly",
"in": "query",
"description": "When set to true, only primary products are returned.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_SearchResponseProductList"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_SearchResponseProductList"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/ap/information/{accountingPointId}": {
"get": {
"tags": [
"doc-product-price"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] List Metering Point Product Price Information",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns price information for each active product at the specified metering point (accounting point).\n\nOne result is returned per distinct product activated at the metering point. Each result includes flags indicating whether the product has spot pricing, hourly pricing, a monthly fee, or a fixed term, \nalong with the applicable price values. If a customer ID is provided, only products associated with that customer at the metering point are included.",
"parameters": [
{
"name": "accountingPointId",
"in": "path",
"description": "The metering point/accounting point ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerGuid",
"in": "query",
"description": "The customer ID. When provided, only products linked to this customer at the metering point are returned.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "vatCode",
"in": "query",
"description": "The VAT code to apply when calculating prices. Defaults to 'E' if not provided.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "servicetype",
"in": "query",
"description": "The service type used to resolve the timezone for price calculations.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/information/{productId}": {
"get": {
"tags": [
"doc-product-price"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] List Product Price Information",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns price information for the specified product, calculated for the given contract sign date and contract start date.\n\nResults include flags indicating whether the product has spot pricing, hourly pricing, a monthly fee, or a fixed term, along with the applicable price values. \nThe contract sign date and contract start date are used to determine which price list version applies.",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The product ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "signdate",
"in": "query",
"description": "The contract sign date used to determine the applicable price list version. Format: ISO 8601 (e.g. 2024-03-15T00:00:00Z).",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "startdate",
"in": "query",
"description": "The contract start date used to determine pricing. Format: ISO 8601 (e.g. 2024-03-15T00:00:00Z).",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "vatcode",
"in": "query",
"description": "The VAT code to apply when calculating prices.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "servicetype",
"in": "query",
"description": "The service type used to resolve the timezone for price calculations.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/slim": {
"get": {
"tags": [
"doc-product"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] List Product Summaries",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns a summary view of all products available for the tenant, optionally filtered by price area, grid area, service type, or product tags.\n\nEach result contains the key product fields (ID, name, tags, service type, visibility, and dynamic fields) without the full product element detail. Use this endpoint when only basic product catalogue information is needed.\n\nWhen `gridArea` is provided and `pricearea` is not, the price area is resolved from the grid area. \nWhen `requiretags` is provided, only products matching all specified tags are returned. \nWhen `tags` is provided, only products matching at least one of the specified tags are returned. \nWhen `primaryonly` is set to true, only primary products are returned.",
"parameters": [
{
"name": "uc-request-source",
"in": "header",
"description": "The request source identifier.",
"schema": {
"type": "string"
}
},
{
"name": "pricearea",
"in": "query",
"description": "Filters products by price area.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "gridArea",
"in": "query",
"description": "Filters products by grid area. The corresponding price area is resolved automatically.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "serviceType",
"in": "query",
"description": "Filters products by service type.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "requiretags",
"in": "query",
"description": "Comma-separated list of tags that all returned products must have.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "tags",
"in": "query",
"description": "Comma-separated list of tags where returned products must match at least one.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "primaryonly",
"in": "query",
"description": "When set to true, only primary products are returned.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductDtoSlim"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductDtoSlim"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/{id}": {
"get": {
"tags": [
"doc-product"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] Get Product",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns the product with the specified ID, including all product elements, pricing expressions, and configuration.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The product ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductDto"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductDto"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/{id}/slim": {
"get": {
"tags": [
"doc-product"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] Get Product Summary",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns a summary view of the specified product, containing the key product fields without the full product element detail.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The product ID.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductDtoSlim"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductDtoSlim"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v2/products/query": {
"post": {
"tags": [
"doc-product"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] Search Products",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns products matching the specified IDs or product names.\n\nAt least one ID or product name must be provided. When both `Ids` and `ProductNames` are provided, results from both are combined. \nEach product is returned only once, even if it matches both criteria.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductsQuery"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductsQuery"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProductsQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_Product"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_Product"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/pm/product/v3/products/information/{productId}": {
"get": {
"tags": [
"doc-product-price"
],
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025] List Product Price Information",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use /pm/product/v2 instead. Returns price information for the specified product, calculated for the given contract price lock timestamp and contract start date.\n\nResults include flags indicating whether the product has spot pricing, hourly pricing, a monthly fee, or a fixed term, along with the applicable price values. \nThe contract price lock timestamp and contract start date are used to determine which price list version applies.",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The product ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "pricelocktimestamp",
"in": "query",
"description": "The contract price lock timestamp used to determine the applicable price list version. Format: ISO 8601 (e.g. 2026-08-15T00:00:00Z).",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "startdate",
"in": "query",
"description": "The contract start date used to determine pricing. Format: ISO 8601 (e.g. 2024-03-15T00:00:00Z).",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "vatcode",
"in": "query",
"description": "The VAT code to apply when calculating prices.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "servicetype",
"in": "query",
"description": "The service type used to resolve the timezone for price calculations.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
},
"application/json; charset=utf-8": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductPriceInformationApResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_product_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-product¤uc-m2m.json; tweaked 2026-09-07T07:08:11Z."
}
},
"/se/settlement/v1/accountingpoint/priceinformation": {
"get": {
"tags": [
"Price Information"
],
"summary": "Get Current Metering Point Price",
"description": "Returns the current electricity price for the specified metering point.\n\nResolves all settlement products active at the specified date and time, defaulting to the current date and time. \nReturns the aggregate hourly price and monthly fee across all active products, together with a per-product breakdown. \nWhen multiple products are active, prices are summed.",
"parameters": [
{
"name": "accountingPointId",
"in": "query",
"description": "The metering point ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "dateTime",
"in": "query",
"description": "Date and time in ISO 8601 format with date, time and timezone. This is not required and will use current date and time if not provided.",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_CurrentTotalPriceResult"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_CurrentTotalPriceResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v1/billing/consumptions": {
"get": {
"tags": [
"Meter Values"
],
"summary": "List Consumption Values",
"description": "Returns metered consumption values for the specified metering point over the given date range.\n\nSupports optional aggregation of results via the `agg` parameter. \n\nNote: This endpoint is rate-limited per tenant.",
"parameters": [
{
"name": "meteringpoint",
"in": "query",
"description": "The metering point ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "firstDay",
"in": "query",
"description": "The start of the date range (inclusive), in ISO 8601 format.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "lastDay",
"in": "query",
"description": "The end of the date range (inclusive), in ISO 8601 format.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "customer",
"in": "query",
"description": "The customer ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "agg",
"in": "query",
"description": "The aggregation level for the results. Accepted values: h (hourly, default), d (daily), m (monthly), y (yearly).",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ConsumptionResults"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ConsumptionResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v1/billing/productions": {
"get": {
"tags": [
"Meter Values"
],
"summary": "List Production Values",
"description": "Returns metered production values for the specified metering point over the given date range.\n\nSupports optional aggregation of results via the `agg` parameter. \n\nNote: This endpoint is rate-limited per tenant.",
"parameters": [
{
"name": "meteringpoint",
"in": "query",
"description": "The metering point ID.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "firstDay",
"in": "query",
"description": "The start of the date range (inclusive), in ISO 8601 format.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "lastDay",
"in": "query",
"description": "The end of the date range (inclusive), in ISO 8601 format.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "customer",
"in": "query",
"description": "The customer ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "agg",
"in": "query",
"description": "The aggregation level for the results. Accepted values: h (hourly, default), d (daily), m (monthly), y (yearly).",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProductionResults"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProductionResults"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v4/accountingpoints/priceinformations/{accountingPointId}": {
"get": {
"tags": [
"Price Information"
],
"summary": "Get Metering Point Price Information",
"description": "Returns electricity price information for the specified metering point on a given date.\n\nIncludes the aggregate consumption price, monthly price, hourly and 15-minute price sequences, and per-part-product breakdown. \nWhen `getNordPoolPrices` is true, the response includes NordPool spot price sequences. \nWhen `addIndividualSequences` is true, individual part-product sequences are included in addition to the aggregated sequence. \nSubsidy calculations (e.g. Norgespris and Strømstøtte) are included in the response when applicable.",
"parameters": [
{
"name": "accountingPointId",
"in": "path",
"description": "The metering point ID.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerGuid",
"in": "query",
"description": "The customer ID.",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "getNordPoolPrices",
"in": "query",
"description": "Set to true to include NordPool spot prices in the response. Defaults to false.",
"explode": false,
"schema": {
"type": "boolean"
}
},
{
"name": "date",
"in": "query",
"description": "The date for which to retrieve price information, in ISO 8601 format.",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "addIndividualSequences",
"in": "query",
"description": "Set to true to include individual sub-product price sequences in addition to the aggregated sequence. Defaults to false.",
"explode": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV4"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV4"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v2/GetPriceInformation": {
"get": {
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025]",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /settlement/v4/accountingpoints/priceinformations/{accountingPointId}. Retrieves price information based on the specified parameters.",
"parameters": [
{
"name": "ap",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "customer",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "nordpoolprices",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v3/accountingpoints/priceinformations/{accountingPointId}": {
"get": {
"summary": "🕚 [DEPRECATED Sunset on 31-August-2026]",
"description": "[DEPRECATED Sunset on 31-August-2026] Please use the new endpoint /v4/accountingpoints/priceinformations/{accountingPointId}.",
"parameters": [
{
"name": "accountingPointId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerGuid",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "nordpoolprices",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
},
"/se/settlement/v1/GetPriceInformation": {
"get": {
"summary": "🕚 [DEPRECATED Sunset on 31-March-2025]",
"description": "[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /settlement/v4/accountingpoints/priceinformations/{accountingPointId}. Retrieves price information based on the specified parameters.",
"parameters": [
{
"name": "ap",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "query",
"required": true,
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "customer",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
},
{
"name": "nordpoolprices",
"in": "query",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_PriceInformationV2"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
},
"application/json; charset=utf-8": {
"schema": {
"$ref": "#/components/schemas/se_settlement_ProblemDetails"
}
}
}
}
},
"deprecated": true,
"x-uc-meta": "From se-settlement¤uc-m2m.json; tweaked 2026-09-07T07:08:12Z."
}
}
},
"components": {
"schemas": {
"be_api_v3_ReportFileNamesDto": {
"required": [
"reportFileName"
],
"type": "object",
"properties": {
"reportFileName": {
"type": "string"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_KeyValueDtoString"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"be_api_v3_ErpMappingType": {
"enum": [
0,
1,
2,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
63,
70,
80,
81,
83,
84,
90,
91
],
"type": "integer",
"description": "0 (Unknown), 1 (DefaultAccount), 2 (DefaultBankAccount), 30 (PtiProduct), 31 (PrintfeeProduct), 32 (CreditProduct), 33 (FeeProduct), 34 (DownpaymentsProduct), 35 (ReminderFeeProduct), 36 (PowerProduct), 37 (OpenPostProduct), 38 (AdministrationfeeProduct), 39 (AllProductFilter), 40 (RoundingProduct), 41 (FixedDueDateProduct), 42 (PrintfeePrivateProduct), 43 (ServiceProduct), 44 (InterestProduct), 45 (PurchaseProduct), 46 (LossProduct), 63 (DownpaymentsVatCode), 70 (CostPrintFee), 80 (CustomerNumberSerieId), 81 (CustomerTemplate), 83 (PrivateCustomerDimensionId), 84 (CorporateCustomerDimensionId), 90 (DimensionForCustomer), 91 (AccountDownpayment). ",
"format": "int32"
},
"be_api_v3_ProductDto": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"productElementId": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productMappingId": {
"type": "string",
"nullable": true,
"readOnly": true
},
"productElementName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"account": {
"type": "string",
"nullable": true
},
"availableFront": {
"type": "boolean",
"nullable": true
},
"isProduction": {
"type": "boolean",
"nullable": true
},
"lineType": {
"type": "string",
"nullable": true
},
"vatCodeId": {
"type": "string",
"nullable": true
},
"vatCodeOverride": {
"type": "boolean",
"nullable": true
},
"mainSortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32",
"nullable": true
},
"quantityUnit": {
"type": "string",
"nullable": true
},
"amountUnit": {
"type": "string",
"nullable": true
},
"accountNumberVatExcempt": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"number": {
"type": "string",
"nullable": true
},
"mappingType": {
"$ref": "#/components/schemas/be_api_v3_ErpMappingType"
},
"isPreliminary": {
"type": "boolean",
"nullable": true
},
"productNameEdit": {
"type": "boolean"
},
"sourceIdentification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_SourceIdentification"
},
"nullable": true
},
"dimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_api_v3_DimensionKeyValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_GridOwnerGetDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"gln": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"organizationNumber": {
"type": "string",
"nullable": true
},
"priceArea": {
"type": "string",
"nullable": true
},
"priceAreaName": {
"type": "string",
"nullable": true
},
"ptiPrivate": {
"type": "boolean",
"nullable": true
},
"ptiCorporate": {
"type": "boolean",
"nullable": true
},
"sourceIdentification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_SourceIdentification"
},
"nullable": true
},
"usingEndDateStart": {
"type": "boolean",
"nullable": true
},
"eventTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"manuallyUpdated": {
"type": "boolean",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"includeEmailOnInvoice": {
"type": "boolean",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"includePhoneOnInvoice": {
"type": "boolean",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
},
"includeWebsiteOnInvoice": {
"type": "boolean",
"nullable": true
},
"gridOwnerInformation": {
"type": "string",
"nullable": true
},
"gridOwnerInformationStart": {
"type": "string",
"format": "date",
"nullable": true
},
"gridOwnerInformationEnd": {
"type": "string",
"format": "date",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/be_api_v3_Address"
},
"bankAccount": {
"type": "string",
"nullable": true
},
"iban": {
"type": "string",
"nullable": true
},
"taxVatCompanyId": {
"type": "string",
"nullable": true
},
"taxCompanyId": {
"type": "string",
"nullable": true
},
"bicCode": {
"type": "string",
"nullable": true
},
"paymentRestricted": {
"type": "boolean",
"nullable": true
},
"paymentNeglectNegative": {
"type": "boolean",
"nullable": true
},
"isVisibleFrontend": {
"type": "boolean",
"nullable": true
},
"dimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_api_v3_DimensionKeyValue"
},
"nullable": true
},
"invoicesExpectedThisMonth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoicesImportedThisMonth": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoicesPaidThisMonth": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_GridOwnerPtiDto": {
"type": "object",
"properties": {
"imported": {
"type": "integer",
"format": "int32"
},
"importedAmount": {
"type": "number",
"format": "double"
},
"paid": {
"type": "integer",
"format": "int32"
},
"paidAmount": {
"type": "number",
"format": "double"
},
"expected": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"be_api_v3_RecordFilter": {
"type": "object",
"properties": {
"RequestID": {
"type": "string",
"nullable": true
},
"RecordIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"Aggregate": {
"$ref": "#/components/schemas/be_api_v3_RecordsAggregate"
},
"Events": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"FromDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"ToDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Page": {
"type": "integer",
"format": "int32"
},
"Limit": {
"type": "integer",
"format": "int32"
},
"SortAscending": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_api_v3_RecordsResponse": {
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_Record"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_InvoiceConfigDto": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"description": "The unique identifier for the invoice collection associated with this invoice configuration.",
"format": "uuid",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"erpId": {
"type": "string",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"dueDaySettingType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceIntervalDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceIntervalDaysType": {
"$ref": "#/components/schemas/be_api_v3_InvoiceIntervalDaysType"
},
"invoiceMark": {
"type": "string",
"nullable": true
},
"printFee": {
"type": "boolean",
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"manualApproval": {
"type": "string",
"nullable": true
},
"invoiceDesign": {
"type": "string",
"nullable": true
},
"otherPayer": {
"type": "string",
"format": "uuid",
"nullable": true
},
"yourReference": {
"type": "string",
"nullable": true
},
"invoiceInterval": {
"type": "integer",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"postingInfo": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/be_api_v3_LifeTimeStatus"
},
"principle": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceMinLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceOpenJournalEntries": {
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationfee": {
"type": "boolean",
"nullable": true
},
"customerOnHold": {
"type": "boolean",
"nullable": true
},
"accountOnHold": {
"type": "boolean",
"nullable": true
},
"onHoldReason": {
"type": "string",
"nullable": true
},
"secretLocation": {
"type": "boolean",
"nullable": true
},
"standardMessageChannel": {
"type": "string",
"nullable": true
},
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_BankAccountDto"
},
"nullable": true
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CommunicationDto"
},
"nullable": true
},
"recognitionCode": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"cell": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"stateMessage": {
"type": "string",
"nullable": true
},
"localizedLastAccountStateMessage": {
"$ref": "#/components/schemas/be_api_v3_LocalizedMessage"
},
"lastInvoiceDay": {
"type": "string",
"format": "date-time",
"nullable": true
},
"otherPayerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"automaticRefund": {
"type": "boolean",
"nullable": true
},
"restAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"dimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_api_v3_DimensionKeyValue"
},
"nullable": true
},
"channelPrint": {
"type": "boolean",
"nullable": true
},
"eInvoiceReference": {
"type": "string",
"nullable": true
},
"eInvoiceBankOperatorInfo": {
"type": "string",
"nullable": true
},
"noDirectDebit": {
"type": "boolean",
"nullable": true
},
"internal": {
"type": "boolean",
"nullable": true
},
"customerStateMessage": {
"type": "string",
"nullable": true
},
"localizedLastCustomerStateMessage": {
"$ref": "#/components/schemas/be_api_v3_LocalizedMessage"
},
"customerDimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_api_v3_DimensionKeyValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_DimensionIdDto": {
"type": "object",
"properties": {
"dimensionId": {
"type": "string"
},
"dimensionEntryId": {
"type": "string"
},
"dimensionEntryValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_InvoiceConfigPatchDto": {
"type": "object",
"properties": {
"accountGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"printFee": {
"type": "boolean",
"nullable": true
},
"secretLocation": {
"type": "boolean",
"nullable": true
},
"accountOnHold": {
"type": "boolean",
"nullable": true
},
"onHoldReason": {
"type": "string",
"nullable": true
},
"invoiceMinLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"postingInfo": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"dueDaySettingType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceDesign": {
"type": "string",
"nullable": true
},
"invoiceMark": {
"type": "string",
"nullable": true
},
"yourReference": {
"type": "string",
"nullable": true
},
"invoiceInterval": {
"type": "integer",
"format": "int32",
"nullable": true
},
"principle": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceOpenJournalEntries": {
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationfee": {
"type": "boolean",
"nullable": true
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CommunicationDto"
},
"nullable": true
},
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_BankAccountDto"
},
"nullable": true
},
"standardMessageChannel": {
"type": "string",
"nullable": true
},
"recognitionCode": {
"type": "string",
"nullable": true
},
"automaticRefund": {
"type": "boolean",
"nullable": true
},
"manualApproval": {
"type": "string",
"nullable": true
},
"eInvoiceReference": {
"type": "string",
"nullable": true
},
"eInvoiceBankOperatorInfo": {
"type": "string",
"nullable": true
},
"noDirectDebit": {
"type": "boolean",
"nullable": true
},
"internal": {
"type": "boolean",
"nullable": true
},
"customerOnHold": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_InvoiceConfigListDto": {
"type": "object",
"properties": {
"accountConfigs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_InvoiceConfigPatchDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_AccountSearchParameters": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_SearchParameter"
}
}
},
"additionalProperties": false
},
"be_api_v3_InvoiceConfigGroupDto": {
"type": "object",
"properties": {
"guid": {
"type": "string",
"format": "uuid",
"nullable": true,
"readOnly": true
},
"name": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"description": "The unique identifier for the invoice collection associated with this invoice configuration.",
"format": "uuid",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"erpId": {
"type": "string",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"dueDaySettingType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceIntervalDays": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceIntervalDaysType": {
"$ref": "#/components/schemas/be_api_v3_InvoiceIntervalDaysType"
},
"invoiceMark": {
"type": "string",
"nullable": true
},
"printFee": {
"type": "boolean",
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"manualApproval": {
"type": "string",
"nullable": true
},
"invoiceDesign": {
"type": "string",
"nullable": true
},
"otherPayer": {
"type": "string",
"format": "uuid",
"nullable": true
},
"yourReference": {
"type": "string",
"nullable": true
},
"invoiceInterval": {
"type": "integer",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"postingInfo": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/be_api_v3_LifeTimeStatus"
},
"principle": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceMinLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"invoiceOpenJournalEntries": {
"type": "integer",
"format": "int32",
"nullable": true
},
"administrationfee": {
"type": "boolean",
"nullable": true
},
"customerOnHold": {
"type": "boolean",
"nullable": true
},
"accountOnHold": {
"type": "boolean",
"nullable": true
},
"onHoldReason": {
"type": "string",
"nullable": true
},
"secretLocation": {
"type": "boolean",
"nullable": true
},
"standardMessageChannel": {
"type": "string",
"nullable": true
},
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_BankAccountDto"
},
"nullable": true
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CommunicationDto"
},
"nullable": true
},
"recognitionCode": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"cell": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"stateMessage": {
"type": "string",
"nullable": true
},
"localizedLastAccountStateMessage": {
"$ref": "#/components/schemas/be_api_v3_LocalizedMessage"
},
"lastInvoiceDay": {
"type": "string",
"format": "date-time",
"nullable": true
},
"otherPayerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"automaticRefund": {
"type": "boolean",
"nullable": true
},
"restAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"dimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_api_v3_DimensionKeyValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_RopoCallbackData": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/be_api_v3_CallBackData"
}
},
"additionalProperties": false
},
"be_api_v3_KeyValueDtoString": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_SourceIdentification": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"identification": {
"type": "string"
},
"source": {
"type": "string"
}
},
"additionalProperties": false
},
"be_api_v3_DimensionKeyValue": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int32"
},
"value": {
"$ref": "#/components/schemas/be_api_v3_DimensionEntry"
}
},
"additionalProperties": false
},
"be_api_v3_Address": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"poBox": {
"type": "string",
"nullable": true
},
"careOf": {
"type": "string",
"nullable": true
},
"attentionOf": {
"type": "string",
"nullable": true
},
"onBehalfOf": {
"type": "string",
"nullable": true
},
"roomIdentification": {
"type": "string",
"nullable": true
},
"floorIdentification": {
"type": "string",
"nullable": true
},
"buildingNumber": {
"type": "string",
"nullable": true
},
"streetName": {
"type": "string",
"nullable": true
},
"streetCode": {
"type": "string",
"nullable": true
},
"citySubDivisionName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_RecordsAggregate": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_Record": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"User": {
"type": "string"
},
"EventName": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"Type": {
"type": "string",
"nullable": true
},
"CorrelationID": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_InvoiceIntervalDaysType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (AfterDayOfMonth), 1 (WeekDays). ",
"format": "int32"
},
"be_api_v3_LifeTimeStatus": {
"enum": [
0,
-1
],
"type": "integer",
"description": "0 (Active), -1 (Ended). ",
"format": "int32"
},
"be_api_v3_BankAccountDto": {
"required": [
"bankAccountNumber"
],
"type": "object",
"properties": {
"bankAccountNumber": {
"type": "string"
},
"bankBic": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_CommunicationDto": {
"type": "object",
"properties": {
"channel": {
"type": "string"
},
"value": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"useForDistribution": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_api_v3_LocalizedMessage": {
"required": [
"defaultMessage",
"key"
],
"type": "object",
"properties": {
"key": {
"type": "string"
},
"defaultMessage": {
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_SearchParameter": {
"required": [
"searchValue"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true
},
"supportedOperators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_SearchOperator"
},
"readOnly": true
},
"valueTypeName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"searchOperator": {
"$ref": "#/components/schemas/be_api_v3_SearchOperator"
},
"searchValue": { }
},
"additionalProperties": false
},
"be_api_v3_CallBackData": {
"type": "object",
"properties": {
"created_at": {
"type": "string",
"nullable": true
},
"delivery": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CallBackDelivery"
},
"nullable": true
},
"payment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CallBackPayment"
},
"nullable": true
},
"lcstatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CallBackLcStatus"
},
"nullable": true
},
"duedateUpdate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CallBackDuedateUpdate"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_DimensionEntry": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"customValue": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_SearchOperator": {
"enum": [
0,
1,
2,
3,
-1
],
"type": "integer",
"description": "0 (Equal), 1 (Exists), 2 (LessThen), 3 (GreaterThen), -1 (NotEqual). ",
"format": "int32"
},
"be_api_v3_CallBackDelivery": {
"type": "object",
"properties": {
"jobid": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cid": {
"type": "integer",
"format": "int32",
"nullable": true
},
"distributionchannel": {
"type": "string",
"nullable": true
},
"documentid": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"statustime": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"invoicenumber": {
"type": "string",
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_api_v3_CallBackError"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_CallBackPayment": {
"type": "object",
"properties": {
"jobid": {
"type": "integer",
"format": "int32",
"nullable": true
},
"time": {
"type": "string",
"nullable": true
},
"paydate": {
"type": "string",
"nullable": true
},
"paymentdate": {
"type": "string",
"nullable": true
},
"accountdate": {
"type": "string",
"nullable": true
},
"settlementdate": {
"type": "string",
"nullable": true
},
"documentid": {
"type": "string",
"nullable": true
},
"reference": {
"type": "string",
"nullable": true
},
"openAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"originalamount": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"invoicenumber": {
"type": "string",
"nullable": true
},
"amountbreakdown": {
"$ref": "#/components/schemas/be_api_v3_CallBackPaymentAmountBreakdown"
}
},
"additionalProperties": false
},
"be_api_v3_CallBackLcStatus": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"time": {
"type": "string",
"nullable": true
},
"documentid": {
"type": "string",
"nullable": true
},
"jobid": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paydate": {
"type": "string",
"nullable": true
},
"currentpaydate": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"invoicenumber": {
"type": "string",
"nullable": true
},
"interest": {
"type": "number",
"format": "double",
"nullable": true
},
"expenses": {
"type": "number",
"format": "double",
"nullable": true
},
"opencapital": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_CallBackDuedateUpdate": {
"type": "object",
"properties": {
"jobid": {
"type": "integer",
"format": "int32",
"nullable": true
},
"time": {
"type": "string",
"nullable": true
},
"documentid": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"currentpaydate": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"code": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_CallBackError": {
"type": "object",
"properties": {
"error": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_api_v3_CallBackPaymentAmountBreakdown": {
"type": "object",
"properties": {
"capital": {
"type": "number",
"format": "double",
"nullable": true
},
"interest": {
"type": "number",
"format": "double",
"nullable": true
},
"expenses": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"be_import_v3_ImportInvoice": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"description": "mandatory - the Tenant id"
},
"importId": {
"type": "string",
"description": "mandatory - The id of the import - mandatory. Will be used to check if the import has been imported before"
},
"customerName": {
"type": "string",
"description": "optional/mandatory - name of the customer - used to look up customer. If IsSupplierInvoice=true then this is a mandatory field",
"nullable": true
},
"customerGuid": {
"type": "string",
"description": "optional - UC guid of the customer - used to look up customer",
"nullable": true
},
"customerSSNorg": {
"type": "string",
"description": "optional/mandatory - UC ssnorg of the customer - used to look up customer. If IsSupplierInvoice=true then this is a mandatory field",
"nullable": true
},
"customerBirth": {
"type": "string",
"description": "optional - Birt of the customer - used to look up customer. Date only ex. 2001-12-31",
"nullable": true
},
"customerExternalIdentifier": {
"$ref": "#/components/schemas/be_import_v3_ImportExternalIdentifier"
},
"customerAddress": {
"$ref": "#/components/schemas/be_import_v3_ImportAddress"
},
"serviceTypeName": {
"type": "string",
"description": "mandatory - service type name. Ex is NO_EL, FI_EL, SE_EL, DH_FO, DC_FO, NO_DP",
"nullable": true
},
"supplier": {
"$ref": "#/components/schemas/be_import_v3_ImportSupplier"
},
"supplierBillingType": {
"$ref": "#/components/schemas/be_import_v3_BillingType"
},
"paymentIdentification": {
"type": "string",
"description": "optional - The Payment identification (KID). If IsSupplierInvoice=true then this is a mandatory field",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "optional - Any invoice due date",
"format": "date-time",
"nullable": true
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_import_v3_ImportInvoiceLine"
},
"description": "Array of lines to import",
"nullable": true
},
"pdfFile": {
"type": "string",
"description": "optional - Pdf file as Base64String",
"nullable": true
},
"email": {
"type": "string",
"description": "optional - Used in distribution to better identify customer",
"nullable": true
},
"phone": {
"type": "string",
"description": "optional - Used in distribution to better identify customer",
"nullable": true
},
"mobile": {
"type": "string",
"description": "optional - Used in distribution to better identify customer",
"nullable": true
},
"customerCommunication": {
"$ref": "#/components/schemas/be_import_v3_ImportCommunication"
}
},
"additionalProperties": false,
"description": "Import payload for custom invoice lines. Also supports creation of supplier of the invoice"
},
"be_import_v3_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"be_import_v3_ImportExternalIdentifier": {
"type": "object",
"properties": {
"referenceSource": {
"type": "string",
"nullable": true
},
"referenceIdentification": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_import_v3_ImportAddress": {
"type": "object",
"properties": {
"address": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"poBox": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_import_v3_ImportSupplier": {
"type": "object",
"properties": {
"supplierOrgnr": {
"type": "string",
"nullable": true
},
"supplierName": {
"type": "string",
"nullable": true
},
"supplierId": {
"type": "string",
"nullable": true
},
"supplierType": {
"type": "string",
"nullable": true
},
"supplierDepartment": {
"type": "string",
"nullable": true
},
"supplierAddress": {
"$ref": "#/components/schemas/be_import_v3_ImportAddress"
}
},
"additionalProperties": false
},
"be_import_v3_BillingType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Invoice), 1 (CreditNote). ",
"format": "int32"
},
"be_import_v3_ImportInvoiceLine": {
"type": "object",
"properties": {
"accountingPointId": {
"type": "string",
"description": "optional - Accounting point Id. Will be used for looking up contract",
"nullable": true
},
"accountGuid": {
"type": "string",
"description": "optional - UC guid of account. Can be used to look up account",
"nullable": true
},
"accountExternalIdentifier": {
"$ref": "#/components/schemas/be_import_v3_ImportExternalIdentifier"
},
"productId": {
"type": "string",
"description": "optional - UC product element id",
"nullable": true
},
"productExternalIdentifier": {
"$ref": "#/components/schemas/be_import_v3_ImportExternalIdentifier"
},
"contractGuid": {
"type": "string",
"description": "optional - UC guid of the contract",
"nullable": true
},
"lineType": {
"$ref": "#/components/schemas/be_import_v3_InvoiceLineType"
},
"quantity": {
"type": "number",
"description": "optional - 2 of qty, price, amount must be provided",
"format": "double",
"nullable": true
},
"unitOfMeasure": {
"type": "string",
"description": "mandantory - uom for the quantity",
"nullable": true
},
"price": {
"type": "number",
"description": "optional - 2 of qty, price, amount must be provided",
"format": "double",
"nullable": true
},
"priceIncVat": {
"type": "number",
"description": "optional - 2 of qty, price, amount must be provided",
"format": "double",
"nullable": true
},
"currency": {
"type": "string",
"description": "mandantory -iso currency like NOK, EUR, USD",
"nullable": true
},
"amount": {
"type": "number",
"description": "optional - 2 of qty, price, amount must be provided",
"format": "double",
"nullable": true
},
"amountIncVat": {
"type": "number",
"description": "optional - 2 of qty, price, amount must be provided",
"format": "double",
"nullable": true
},
"vatPercent": {
"type": "number",
"description": "optional - vat percent. Between 0 and 100. Can be ignore if Amount and AmountIncVat are provided",
"format": "double",
"nullable": true
},
"vatCode": {
"type": "string",
"description": "optional - vat code. S or E",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the line",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the line",
"nullable": true
},
"periodStartUtc": {
"type": "string",
"description": "optional - if not set, the invoice interval, contract etc is used. Date only ex. 2001-12-31",
"format": "date-time",
"nullable": true
},
"periodEndUtc": {
"type": "string",
"description": "optional - if not set, the invoice interval, contract etc is used. Date only ex. 2001-12-31",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_import_v3_ImportCommunication": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"mobile": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_import_v3_InvoiceLineType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
1000
],
"type": "integer",
"description": "0 (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). ",
"format": "int32"
},
"be_invoice_v3_CreditInvoicePayload": {
"type": "object",
"properties": {
"erpId": {
"type": "string",
"description": "Erp Id of the invoice",
"nullable": true
},
"toBeDistributed": {
"type": "boolean",
"description": "If credit note should be distributed to end customer",
"nullable": true
},
"comment": {
"type": "string",
"description": "Comment for the credit",
"nullable": true
},
"executeRefund": {
"type": "boolean",
"description": "End customer should be refund directly"
}
},
"additionalProperties": false
},
"be_invoice_v3_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"be_invoice_v3_WebhookPayloadAccountLifeTimeStatusUpdatePayload": {
"type": "object",
"properties": {
"eventId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"topic": {
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/be_invoice_v3_AccountLifeTimeStatusUpdatePayload"
}
},
"additionalProperties": false
},
"be_invoice_v3_WebhookPayloadInvoiceDunnedPaidPayload": {
"type": "object",
"properties": {
"eventId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"topic": {
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceDunnedPaidPayload"
}
},
"additionalProperties": false
},
"be_invoice_v3_WebhookPayloadInvoiceDunnedCreditedPayload": {
"type": "object",
"properties": {
"eventId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"topic": {
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceDunnedCreditedPayload"
}
},
"additionalProperties": false
},
"be_invoice_v3_DebtCollectionInvoiceDto": {
"type": "object",
"properties": {
"customerGuid": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string"
},
"customerSsnorg": {
"type": "string",
"nullable": true
},
"customerNumber": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"format": "uuid"
},
"accountAddress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_AddressDto"
},
"nullable": true
},
"accountContacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_CommunicationDto"
},
"nullable": true
},
"accountStatus": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string"
},
"invoiceIsCredited": {
"type": "boolean"
},
"invoiceCustomerIdentificationNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"invoiceCreatedDate": {
"type": "string",
"format": "date-time"
},
"invoiceCurrentDueDate": {
"type": "string",
"format": "date-time"
},
"invoiceOriginalDueDate": {
"type": "string",
"format": "date-time"
},
"invoiceCurrency": {
"type": "string"
},
"invoiceDistributionChannel": {
"type": "string"
},
"invoiceTotalAmountIncVat": {
"type": "number",
"format": "double"
},
"invoiceRestAmount": {
"type": "number",
"format": "double"
},
"invoiceTotalVatAmount": {
"type": "number",
"format": "double"
},
"invoicePaidAmount": {
"type": "number",
"format": "double"
},
"invoiceLossAmount": {
"type": "number",
"format": "double"
},
"invoiceClosedAmount": {
"type": "number",
"format": "double"
},
"invoiceIsClosedInLedger": {
"type": "boolean"
},
"invoiceIsDirectDebit": {
"type": "boolean"
},
"invoicePeriodStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoicePeriodEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceConsumptionTotal": {
"type": "number",
"format": "double"
},
"invoiceDebtCaseComment": {
"type": "string",
"nullable": true
},
"invoiceDebtCaseId": {
"type": "string",
"nullable": true
},
"invoiceDebtCaseUrl": {
"type": "string",
"nullable": true
},
"invoiceDebtCaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_DebtCollectionFeeDto": {
"required": [
"customerGuid",
"feeItems",
"invoiceNumber",
"newTotalAmountIncVat"
],
"type": "object",
"properties": {
"invoiceNumber": {
"minLength": 1,
"type": "string",
"description": "Invoice number"
},
"customerGuid": {
"type": "string",
"description": "UC Customer guid",
"format": "uuid"
},
"newTotalAmountIncVat": {
"type": "number",
"description": "Total invoice amount including new fees",
"format": "double"
},
"feeItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionFeeItemDto"
},
"description": "List of new fees"
}
},
"additionalProperties": false,
"description": "Debt collectetor invoice fees model"
},
"be_invoice_v3_DebtCollectionInvoiceLineDto": {
"required": [
"invoiceNumber",
"lines"
],
"type": "object",
"properties": {
"invoiceNumber": {
"minLength": 1,
"type": "string",
"description": "Invoice number"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_DebtCollectionInvoiceLineItemDto"
},
"description": "List of new invoice lines"
}
},
"additionalProperties": false,
"description": "Debt collectetor invoice line model"
},
"be_invoice_v3_DebtCollectionCasePostDto": {
"required": [
"invoiceNumber"
],
"type": "object",
"properties": {
"invoiceNumber": {
"type": "string"
},
"debtCaseId": {
"type": "string",
"nullable": true
},
"debtCaseUrl": {
"type": "string",
"nullable": true
},
"debtCaseComment": {
"type": "string",
"nullable": true
},
"debtCaseDate": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_DebtCollectionPatchDto": {
"required": [
"existingDebtCaseId",
"invoiceNumber"
],
"type": "object",
"properties": {
"invoiceNumber": {
"type": "string"
},
"existingDebtCaseId": {
"type": "string"
},
"newDebtCaseId": {
"type": "string",
"nullable": true
},
"debtCaseUrl": {
"type": "string",
"nullable": true
},
"debtCaseComment": {
"type": "string",
"nullable": true
},
"debtCaseDate": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_PublicInvoiceHeader": {
"type": "object",
"properties": {
"erpId": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accountErpId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"defaultAccount": {
"type": "boolean"
},
"balance": {
"type": "number",
"format": "double"
},
"stateMessage": {
"type": "string",
"nullable": true
},
"localizedStateMessage": {
"$ref": "#/components/schemas/be_invoice_v3_LocalizedMessage"
},
"accountTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"administrationFee": {
"type": "boolean",
"nullable": true
},
"customerOnHold": {
"type": "boolean"
},
"accountOnHold": {
"type": "boolean"
},
"invoiceInterval": {
"type": "integer",
"format": "int32"
},
"printfee": {
"type": "boolean",
"readOnly": true
},
"hasPrintFee": {
"type": "boolean"
},
"secretLocation": {
"type": "boolean"
},
"manualApproval": {
"type": "string",
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"principle": {
"type": "integer",
"format": "int32"
},
"pti": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"hasGridInvocing": {
"type": "boolean",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_PublicInvoice"
}
}
},
"additionalProperties": false
},
"be_invoice_v3_UCInvoiceDetails": {
"type": "object",
"properties": {
"invoicenumber": {
"type": "string",
"nullable": true
},
"invoiceId": {
"type": "string",
"nullable": true
},
"invoicedate": {
"type": "string",
"nullable": true
},
"duedate": {
"type": "string",
"nullable": true
},
"lastPaymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"originalduedate": {
"type": "string",
"nullable": true
},
"kid": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"originalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"vat": {
"type": "number",
"format": "double"
},
"balance": {
"type": "number",
"format": "double"
},
"paidAmount": {
"type": "number",
"format": "double"
},
"loss": {
"type": "number",
"format": "double",
"nullable": true
},
"closedOut": {
"type": "number",
"format": "double",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32"
},
"distributionStatus": {
"$ref": "#/components/schemas/be_invoice_v3_DistributionStatus"
},
"erpStatus": {
"type": "string",
"nullable": true
},
"distributionchannel": {
"type": "string",
"nullable": true
},
"distributiondate": {
"type": "string",
"nullable": true
},
"receiverEndpoint": {
"type": "string",
"nullable": true
},
"isCredit": {
"type": "boolean"
},
"erpIdCanceled": {
"type": "string",
"nullable": true
},
"invoiceNumberCanceled": {
"type": "string",
"nullable": true
},
"distributionLog": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"directDebit": {
"type": "boolean",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"erpCustomerId": {
"type": "string",
"nullable": true
},
"debtCaseId": {
"type": "string",
"nullable": true
},
"debtCaseSent": {
"type": "string",
"nullable": true
},
"debtCaseLink": {
"type": "string",
"nullable": true
},
"debtCaseComment": {
"type": "string",
"nullable": true
},
"reminderStep": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overDueStatus": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceOverDueStatus"
},
"journalEntryId": {
"type": "string",
"nullable": true
},
"invoicelines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceItem"
},
"nullable": true
},
"paymentAgreement": {
"$ref": "#/components/schemas/be_invoice_v3_AgreementStatus"
},
"creditComment": {
"type": "string",
"nullable": true
},
"stopReminders": {
"type": "boolean",
"nullable": true
},
"stopInterest": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_ChangeInvoiceDueDateRequest": {
"type": "object",
"properties": {
"erpId": {
"type": "string",
"nullable": true
},
"dueDate": {
"type": "string",
"nullable": true
},
"stopInterest": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceOverDueRequest": {
"type": "object",
"properties": {
"erpId": {
"type": "string"
},
"stopOverdue": {
"type": "boolean"
},
"comment": {
"type": "string",
"nullable": true
},
"numberOfDays": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceCreditCheckPayloadDto": {
"type": "object",
"properties": {
"ssnorg": {
"type": "string",
"nullable": true
},
"customerGuid": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceCreditCheckDto": {
"type": "object",
"properties": {
"numberOfOverdueInvoices": {
"type": "integer",
"description": "Number of invoices past their due date and still unpaid.",
"format": "int32"
},
"amountOfOverdueInvoices": {
"type": "number",
"description": "Total amount outstanding across all overdue invoices.",
"format": "double"
},
"numberOfDunnedInvoices": {
"type": "integer",
"description": "Number of invoices sent to debt collection.",
"format": "int32"
},
"numberOfLossInvoices": {
"type": "integer",
"description": "Number of invoices written off as a loss, meaning the company no longer expects to recover the amount.",
"format": "int32"
},
"amountOfLossInvoices": {
"type": "number",
"description": "Total amount written off across all loss invoices.",
"format": "double"
},
"creditCheckPassed": {
"type": "boolean",
"description": "Indicates whether the customer has breached the tenant's configured payment history thresholds. False means the customer has overdue, dunned, or written-off invoices that exceed the configured limits."
}
},
"additionalProperties": false
},
"be_invoice_v3_PaymentAgreement": {
"type": "object",
"properties": {
"erpId": {
"type": "string",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid"
},
"created": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"interest": {
"type": "boolean"
},
"status": {
"$ref": "#/components/schemas/be_invoice_v3_AgreementStatus"
},
"stopReminders": {
"type": "boolean"
},
"paid": {
"type": "number",
"format": "double"
},
"totalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalRemainingAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPaidAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalOverdueAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"numberOfTerms": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nextTermDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_invoice_v3_PaymentAgreementLine"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_PaymentAgreementPatchPayload": {
"type": "object",
"properties": {
"erpId": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/be_invoice_v3_AgreementStatus"
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceSearchPayload": {
"type": "object",
"properties": {
"startRow": {
"type": "integer",
"format": "int32"
},
"endRow": {
"type": "integer",
"format": "int32"
},
"customerGuid": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"customerIdentificationNumber": {
"type": "string",
"nullable": true
},
"dueDateFrom": {
"type": "string",
"nullable": true
},
"dueDateTo": {
"type": "string",
"nullable": true
},
"invoiceDayFrom": {
"type": "string",
"nullable": true
},
"invoiceDayTo": {
"type": "string",
"nullable": true
},
"distributionDayFrom": {
"type": "string",
"nullable": true
},
"distributionDayTo": {
"type": "string",
"nullable": true
},
"invoiceNumberFrom": {
"type": "string",
"nullable": true
},
"customerNumberFrom": {
"type": "string",
"nullable": true
},
"distributionStatus": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"invoiceStatus": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"overdueStatus": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"amountFrom": {
"type": "number",
"format": "double",
"nullable": true
},
"amountTo": {
"type": "number",
"format": "double",
"nullable": true
},
"directDebit": {
"type": "boolean",
"nullable": true
},
"isCredit": {
"type": "boolean",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"updatedFromUtc": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceDto": {
"type": "object",
"properties": {
"erpId": {
"type": "string"
},
"customerGuid": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"customerType": {
"$ref": "#/components/schemas/be_invoice_v3_CustomerType"
},
"accountGuid": {
"type": "string",
"format": "uuid"
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"isCredit": {
"type": "boolean",
"nullable": true
},
"creditComment": {
"type": "string",
"nullable": true
},
"erpIdCanceled": {
"type": "string",
"nullable": true
},
"isCanceled": {
"type": "boolean"
},
"customerIdentificationNumber": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"timestampUtc": {
"type": "string",
"format": "date-time"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"originalDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceStatus": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceStatus"
},
"distributionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"distributionLog": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"distributionStatus": {
"$ref": "#/components/schemas/be_invoice_v3_DistributionStatus"
},
"overDueStatus": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceOverDueStatus"
},
"statusMessage": {
"type": "string",
"nullable": true
},
"localizedStatusMessage": {
"$ref": "#/components/schemas/be_invoice_v3_LocalizedMessage"
},
"otherPayer": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accountPeriod": {
"type": "string",
"nullable": true
},
"totalAmountIncVat": {
"type": "number",
"format": "double",
"nullable": true
},
"invoicedAmountIncVat": {
"type": "number",
"format": "double",
"nullable": true
},
"restAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalVatAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"printFee": {
"type": "boolean",
"nullable": true
},
"customerNumber": {
"type": "string",
"nullable": true
},
"directDebit": {
"type": "boolean",
"nullable": true
},
"reminderRestAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"reminderTotalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"journalEntryId": {
"type": "string",
"nullable": true
},
"stopReminders": {
"type": "boolean",
"nullable": true
},
"stopInterest": {
"type": "boolean",
"nullable": true
},
"sentNotification": {
"type": "boolean",
"nullable": true
},
"sentNotificationUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created": {
"type": "string",
"format": "date-time"
},
"paymentAgreement": {
"$ref": "#/components/schemas/be_invoice_v3_InvoicePaymentAgreementDto"
},
"paid": {
"type": "number",
"format": "double",
"nullable": true
},
"lastPaymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"loss": {
"type": "number",
"format": "double",
"nullable": true
},
"closedOut": {
"type": "number",
"format": "double",
"nullable": true
},
"consumption": {
"type": "number",
"format": "double",
"nullable": true
},
"firstInvoice": {
"type": "boolean",
"nullable": true
},
"reminderStep": {
"type": "integer",
"format": "int32",
"nullable": true
},
"debtCaseId": {
"type": "string",
"nullable": true
},
"debtCaseUrl": {
"type": "string",
"nullable": true
},
"debtCaseComment": {
"type": "string",
"nullable": true
},
"debtCaseDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_AccountLifeTimeStatusUpdatePayload": {
"type": "object",
"properties": {
"accountGuid": {
"type": "string",
"format": "uuid"
},
"accountStatus": {
"type": "string",
"description": "Status 'Ended' or 'Active'",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"customerNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceDunnedPaidPayload": {
"type": "object",
"properties": {
"eventId": {
"type": "integer",
"format": "int64"
},
"invoiceNumber": {
"type": "string"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"customerName": {
"type": "string"
},
"customerNumber": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"format": "uuid"
},
"paidDay": {
"type": "string",
"format": "date",
"nullable": true
},
"paidAmount": {
"type": "number",
"format": "double"
},
"bankAccountId": {
"type": "string",
"nullable": true
},
"invoiceCurrency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceDunnedCreditedPayload": {
"type": "object",
"properties": {
"eventId": {
"type": "integer",
"format": "int64"
},
"invoiceNumber": {
"type": "string"
},
"invoiceTotalAmount": {
"type": "number",
"format": "double"
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"creditedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"customerName": {
"type": "string"
},
"customerNumber": {
"type": "string",
"nullable": true
},
"creditNoteInvoiceNumber": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"format": "uuid"
},
"invoiceCurrency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_AddressDto": {
"type": "object",
"properties": {
"addressType": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"postBox": {
"type": "string",
"nullable": true
},
"careOf": {
"type": "string",
"nullable": true
},
"attentionOf": {
"type": "string",
"nullable": true
},
"onBehalfOf": {
"type": "string",
"nullable": true
},
"roomIdentification": {
"type": "string",
"nullable": true
},
"floorIdentification": {
"type": "string",
"nullable": true
},
"buildingNumber": {
"type": "string",
"nullable": true
},
"streetName": {
"type": "string",
"nullable": true
},
"streetCode": {
"type": "string",
"nullable": true
},
"citySubDivisionName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_CommunicationDto": {
"type": "object",
"properties": {
"channel": {
"type": "string"
},
"value": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
},
"useForDistribution": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_invoice_v3_DebtCollectionFeeItemDto": {
"required": [
"feeAmount",
"identifier",
"productId"
],
"type": "object",
"properties": {
"identifier": {
"minLength": 1,
"type": "string",
"description": "External unique identifier for the fee item"
},
"productId": {
"minLength": 1,
"type": "string",
"description": "UC product Id to be assigned to the new fee item"
},
"feeAmount": {
"type": "number",
"description": "Fee item amount",
"format": "double"
},
"description": {
"type": "string",
"description": "Any description for the fee item",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_DebtCollectionInvoiceLineItemDto": {
"required": [
"amount",
"financialDay",
"identifier"
],
"type": "object",
"properties": {
"identifier": {
"minLength": 1,
"type": "string",
"description": "External unique identifier for the invoice line"
},
"financialDay": {
"type": "string",
"description": "Financial day for the open amount",
"format": "date"
},
"amount": {
"type": "number",
"description": "Invoice amount to be invoiced",
"format": "double"
},
"description": {
"type": "string",
"description": "Any description for the line",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_LocalizedMessage": {
"required": [
"defaultMessage",
"key"
],
"type": "object",
"properties": {
"key": {
"type": "string"
},
"defaultMessage": {
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_PublicInvoice": {
"type": "object",
"properties": {
"erpid": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"postPeriod": {
"type": "string",
"nullable": true
},
"kid": {
"type": "string",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"dueDate": {
"type": "string",
"format": "date-time"
},
"invoiceDay": {
"type": "string",
"format": "date",
"readOnly": true
},
"dueDay": {
"type": "string",
"format": "date",
"readOnly": true
},
"originalDueDay": {
"type": "string",
"format": "date-time",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"restAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"paidAmount": {
"type": "number",
"format": "double"
},
"lastPaymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"loss": {
"type": "number",
"format": "double",
"nullable": true
},
"closedOut": {
"type": "number",
"format": "double",
"nullable": true
},
"vat": {
"type": "number",
"format": "double",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32"
},
"overDueStatus": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceOverDueStatus"
},
"pdfToken": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"distributionStatus": {
"$ref": "#/components/schemas/be_invoice_v3_DistributionStatus"
},
"distributionChannel": {
"type": "string",
"nullable": true
},
"receiverEndpoint": {
"type": "string",
"nullable": true
},
"distributionDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"directDebit": {
"type": "boolean",
"nullable": true
},
"yourReference": {
"type": "string",
"nullable": true
},
"paymentAgreement": {
"$ref": "#/components/schemas/be_invoice_v3_AgreementStatus"
},
"creditComment": {
"type": "string",
"nullable": true
},
"stopReminders": {
"type": "boolean",
"nullable": true
},
"stopInterest": {
"type": "boolean",
"nullable": true
},
"reminderStep": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isCredit": {
"type": "boolean"
},
"isCanceled": {
"type": "boolean"
},
"isOverdue": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"exportId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_DistributionStatus": {
"enum": [
0,
10,
20,
30,
40,
50,
60,
70
],
"type": "integer",
"description": "0 (Unknown), 10 (Initialized), 20 (New), 30 (Sent), 40 (Trying), 50 (Failed), 60 (Rejected), 70 (NotToBeDistributed). ",
"format": "int32"
},
"be_invoice_v3_InvoiceOverDueStatus": {
"enum": [
0,
1,
2,
3,
5,
6,
7,
10
],
"type": "integer",
"description": "0 (Unknown), 1 (Loss), 2 (NextInvoice), 3 (Alert), 5 (Reminder), 6 (Debt), 7 (DebtResolved), 10 (Dunned). ",
"format": "int32"
},
"be_invoice_v3_InvoiceItem": {
"type": "object",
"properties": {
"productid": {
"type": "string",
"nullable": true
},
"productname": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"cost": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"vatcode": {
"type": "string",
"nullable": true
},
"vatrate": {
"type": "string",
"nullable": true
},
"periode": {
"type": "string",
"nullable": true
},
"periodStart": {
"type": "string",
"nullable": true
},
"periodEnd": {
"type": "string",
"nullable": true
},
"ptiInvoiceNumber": {
"type": "string",
"nullable": true
},
"accountingpointid": {
"type": "string",
"nullable": true
},
"externalInterval": {
"type": "string",
"nullable": true
},
"externalIdentity": {
"type": "string",
"nullable": true
},
"netAmount": {
"type": "number",
"format": "double"
},
"lineType": {
"type": "string",
"nullable": true
},
"invoiceLineType": {
"$ref": "#/components/schemas/be_invoice_v3_InvoiceLineType"
}
},
"additionalProperties": false
},
"be_invoice_v3_AgreementStatus": {
"enum": [
0,
10,
20,
30,
-1
],
"type": "integer",
"description": "0 (Created), 10 (Active), 20 (Completed), 30 (Incompleted), -1 (Deleted). ",
"format": "int32"
},
"be_invoice_v3_PaymentAgreementLine": {
"type": "object",
"properties": {
"agreementAmount": {
"type": "number",
"format": "double"
},
"dueDate": {
"type": "string",
"format": "date-time"
},
"status": {
"$ref": "#/components/schemas/be_invoice_v3_PaymentAgreementStatus"
}
},
"additionalProperties": false
},
"be_invoice_v3_CustomerType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Private), 1 (Corporate). ",
"format": "int32"
},
"be_invoice_v3_InvoiceStatus": {
"enum": [
0,
1,
2,
5,
6,
7,
9,
10,
15,
16,
17,
20
],
"type": "integer",
"description": "0 (Unknown), 1 (InProcessing), 2 (Sent), 5 (Partial), 6 (Paid), 7 (Closed), 9 (Reminder), 10 (Dunned), 15 (Loss), 16 (PaymentLoss), 17 (PartialLoss), 20 (Draft). ",
"format": "int32"
},
"be_invoice_v3_InvoicePaymentAgreementDto": {
"type": "object",
"properties": {
"created": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"interest": {
"type": "boolean",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/be_invoice_v3_AgreementStatus"
},
"totalAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalRemainingAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalPaidAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"totalOverdueAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"numberOfTerms": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nextTermDueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_invoice_v3_InvoiceLineType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
1000
],
"type": "integer",
"description": "0 (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). ",
"format": "int32"
},
"be_invoice_v3_PaymentAgreementStatus": {
"enum": [
0,
10,
20
],
"type": "integer",
"description": "0 (Active), 10 (Overdue), 20 (Paid). ",
"format": "int32"
},
"be_ledger_v3_ReportAccountingLineDto": {
"type": "object",
"properties": {
"financialDay": {
"type": "string",
"format": "date"
},
"account": {
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/be_ledger_v3_LedgerAccountType"
},
"amount": {
"type": "number",
"format": "double"
},
"baseAccount": {
"type": "string",
"nullable": true
},
"baseAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"currency": {
"type": "string"
},
"vatCode": {
"type": "string",
"nullable": true
},
"dimension1": {
"type": "string",
"nullable": true
},
"dimension2": {
"type": "string",
"nullable": true
},
"dimension3": {
"type": "string",
"nullable": true
},
"dimension4": {
"type": "string",
"nullable": true
},
"dimension5": {
"type": "string",
"nullable": true
},
"dimension6": {
"type": "string",
"nullable": true
},
"dimension7": {
"type": "string",
"nullable": true
},
"dimension8": {
"type": "string",
"nullable": true
},
"dimension9": {
"type": "string",
"nullable": true
},
"dimension10": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_ledger_v3_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"be_ledger_v3_PaymentStatus": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
8,
11
],
"type": "integer",
"description": "0 (Unknown), 1 (InProcessing), 2 (ReadyForApproval), 3 (Received), 4 (Approved), 5 (Partial), 6 (Paid), 8 (Stopped), 11 (Failed). ",
"format": "int32"
},
"be_ledger_v3_PaymentType": {
"enum": [
0,
10,
20,
30
],
"type": "integer",
"description": "0 (Unknown), 10 (Pti), 20 (Invoice), 30 (Banktransaction). ",
"format": "int32"
},
"be_ledger_v3_PaymentJobDto": {
"type": "object",
"properties": {
"paymentId": {
"type": "string"
},
"transactionStatus": {
"type": "string",
"nullable": true
},
"paymentPosted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isPosted": {
"type": "boolean"
},
"paymentsType": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentType"
},
"paymentStatus": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentStatus"
},
"paymentStatusTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"matchedAgreed": {
"type": "boolean"
},
"batchId": {
"type": "string"
},
"reference": {
"type": "string",
"nullable": true
},
"referenceName": {
"type": "string",
"nullable": true
},
"bankAccountId": {
"type": "string",
"nullable": true
},
"bankAccountBic": {
"type": "string",
"nullable": true
},
"dueDay": {
"type": "string",
"format": "date-time",
"nullable": true
},
"count": {
"type": "integer",
"description": "Total number of invoices",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "Total amount",
"format": "double",
"nullable": true
},
"curreny": {
"type": "string"
},
"amountToBePaid": {
"type": "number",
"description": "Payable amount",
"format": "double",
"readOnly": true
},
"countToBePaid": {
"type": "integer",
"description": "payable number of invoices",
"format": "int32",
"readOnly": true
},
"countReset": {
"type": "integer",
"description": "Number of invoices that as been reverted",
"format": "int32",
"nullable": true
},
"amountReset": {
"type": "number",
"description": "Reverted amount",
"format": "double",
"nullable": true
},
"countFailed": {
"type": "integer",
"description": "Number of invoices that has failed. Failed can be reverted.",
"format": "int32",
"nullable": true
},
"amountFailed": {
"type": "number",
"description": "Failed amount",
"format": "double",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Payments job object"
},
"be_ledger_v3_BankTransactionSearchDto": {
"type": "object",
"properties": {
"bookedDayFrom": {
"type": "string",
"format": "date",
"nullable": true
},
"bookedDayTo": {
"type": "string",
"format": "date",
"nullable": true
},
"amountFrom": {
"type": "number",
"format": "double",
"nullable": true
},
"amountTo": {
"type": "number",
"format": "double",
"nullable": true
},
"itemRef": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"onlyUnmatched": {
"type": "boolean"
},
"includeHidden": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_ledger_v3_BankTransactionDto": {
"type": "object",
"properties": {
"transactionKey": {
"type": "string"
},
"createdUtc": {
"type": "string",
"format": "date-time"
},
"itemRef": {
"type": "string",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"matchedMethod": {
"type": "string",
"nullable": true
},
"matchedDetails": {
"type": "string",
"nullable": true
},
"bookedDay": {
"type": "string",
"format": "date",
"nullable": true
},
"transactionCode": {
"type": "string",
"nullable": true
},
"issuer": {
"type": "string",
"nullable": true
},
"servicerRef": {
"type": "string",
"nullable": true
},
"paymentInfoId": {
"type": "string",
"nullable": true
},
"paymentInstrId": {
"type": "string",
"nullable": true
},
"payeerName": {
"type": "string",
"nullable": true
},
"accountId": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"bic": {
"type": "string",
"nullable": true
},
"customerIdentificationNumber": {
"type": "string",
"nullable": true
},
"additionalInformation": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"amountCcy": {
"type": "string",
"nullable": true
},
"payeerAddress": {
"type": "string",
"nullable": true
},
"payeerPostCode": {
"type": "string",
"nullable": true
},
"payeerCity": {
"type": "string",
"nullable": true
},
"payeerCountry": {
"type": "string",
"nullable": true
},
"filename": {
"type": "string",
"nullable": true
},
"sentToInterimLedgerUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"suggestedCustomers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentCustomerMatchSuggestion"
},
"nullable": true
},
"suggestedItemRefs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_ledger_v3_PaymentItemRefMatchSuggestion"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_ledger_v3_AccountingLineDto": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"reportFileRef": {
"type": "string",
"readOnly": true
},
"financialDay": {
"type": "string",
"format": "date"
},
"lineType": {
"$ref": "#/components/schemas/be_ledger_v3_LedgerLineType"
},
"journalEntryNumber": {
"type": "integer",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/be_ledger_v3_LedgerLineStatusType"
},
"account": {
"type": "string"
},
"accountType": {
"$ref": "#/components/schemas/be_ledger_v3_LedgerAccountType"
},
"amount": {
"type": "number",
"format": "double"
},
"journalEntryNumberClosedBy": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"restAmount": {
"type": "number",
"format": "double"
},
"providerId": {
"type": "string",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accountGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"itemReference": {
"type": "string",
"nullable": true
},
"accountReference": {
"type": "string",
"nullable": true
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"bankAccountId": {
"type": "string",
"nullable": true
},
"baseAccount": {
"type": "string",
"nullable": true
},
"baseAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"currency": {
"type": "string"
},
"comment": {
"type": "string",
"nullable": true
},
"vatCode": {
"type": "string",
"nullable": true
},
"dimension1": {
"type": "string",
"nullable": true
},
"dimension2": {
"type": "string",
"nullable": true
},
"dimension3": {
"type": "string",
"nullable": true
},
"dimension4": {
"type": "string",
"nullable": true
},
"dimension5": {
"type": "string",
"nullable": true
},
"dimension6": {
"type": "string",
"nullable": true
},
"dimension7": {
"type": "string",
"nullable": true
},
"dimension8": {
"type": "string",
"nullable": true
},
"dimension9": {
"type": "string",
"nullable": true
},
"dimension10": {
"type": "string",
"nullable": true
},
"isBalance": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_ledger_v3_LedgerAccountType": {
"enum": [
0,
2,
3,
100,
101,
102,
103,
104,
105,
106,
107,
200,
201,
203,
204,
300
],
"type": "integer",
"description": "0 (GeneralLedger), 2 (SupplierInvoicePurchase), 3 (LossAccount), 100 (AccountsReceivable), 101 (SupplierLedger), 102 (Vat), 103 (BankAccount), 104 (Downpayment), 105 (InterimAccountsReceivable), 106 (VatPurchase), 107 (Rounding), 200 (LossVat), 201 (LossPti), 203 (LossWithVat), 204 (LossExcVat), 300 (OpenPost). ",
"format": "int32"
},
"be_ledger_v3_PaymentCustomerMatchSuggestion": {
"type": "object",
"properties": {
"matchedMethod": {
"type": "string",
"nullable": true
},
"matchedDetails": {
"type": "string",
"nullable": true
},
"customerGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"be_ledger_v3_PaymentItemRefMatchSuggestion": {
"required": [
"itemRef"
],
"type": "object",
"properties": {
"matchedMethod": {
"type": "string",
"nullable": true
},
"matchedDetails": {
"type": "string",
"nullable": true
},
"itemRef": {
"type": "string"
},
"customerGuid": {
"type": "string",
"format": "uuid"
},
"accountGuid": {
"type": "string",
"format": "uuid"
},
"invoiceNumber": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_ledger_v3_LedgerLineType": {
"enum": [
0,
1,
2,
3,
10,
11,
13,
20,
21,
22,
23,
24,
25,
30
],
"type": "integer",
"description": "0 (Unknown), 1 (Loss), 2 (LossSimple), 3 (Manual), 10 (Pti), 11 (PtiPaid), 13 (PtiRevert), 20 (Invoice), 21 (InvoicePaid), 22 (InvoiceInterimPaid), 23 (InvoiceRefund), 24 (InvoiceInterimRefund), 25 (InterimPayment), 30 (DownPayment). ",
"format": "int32"
},
"be_ledger_v3_LedgerLineStatusType": {
"enum": [
0,
10,
100
],
"type": "integer",
"description": "0 (Open), 10 (PartlyOpen), 100 (Closed). ",
"format": "int32"
},
"be_lines_v3_PublicLinesResponse": {
"type": "object",
"properties": {
"customerGUI": {
"type": "string",
"format": "uuid"
},
"clientGLN": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"nullable": true
},
"lastAccountState": {
"type": "string",
"nullable": true
},
"lastAccountTimestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"localizedLastAccountStateMessage": {
"$ref": "#/components/schemas/be_lines_v3_LocalizedMessage"
},
"localizedLastCustomerStateMessage": {
"$ref": "#/components/schemas/be_lines_v3_LocalizedMessage"
},
"invoiceLines": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_lines_v3_PublicInvoiceLine"
}
}
},
"additionalProperties": false
},
"be_lines_v3_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"be_lines_v3_InvoiceLinesIdDto": {
"type": "object",
"properties": {
"invoiceLineIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_PostInvoiceLinesRequest": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"productElementId": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"price": {
"type": "number",
"format": "double"
},
"description": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"nullable": true
},
"vat": {
"type": "number",
"format": "double"
},
"vatCode": {
"type": "string",
"nullable": true
},
"customerIdErp": {
"type": "string",
"nullable": true
},
"accountingPointGuid": {
"type": "string",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"termStartDate": {
"type": "string",
"nullable": true
},
"termEndDate": {
"type": "string",
"nullable": true
},
"quantityUnit": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_PatchInvoiceLinesRequest": {
"type": "object",
"properties": {
"accountGuid": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"invoiceLine": {
"$ref": "#/components/schemas/be_lines_v3_PostInvoiceLinesRequest"
}
},
"additionalProperties": false
},
"be_lines_v3_PostInvoiceLineQuery": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"periodStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"periodEnd": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_InvoiceLineDto": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"erpId": {
"type": "string",
"nullable": true
},
"lineState": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineState"
},
"productId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"periodStart": {
"type": "string",
"format": "date-time"
},
"periodEnd": {
"type": "string",
"format": "date-time"
},
"quantity": {
"type": "number",
"format": "double",
"nullable": true
},
"quantityUnit": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"amount": {
"type": "number",
"format": "double",
"nullable": true
},
"vatAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"vatCodeId": {
"type": "string",
"nullable": true
},
"vatRate": {
"type": "number",
"format": "double",
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"accountPeriod": {
"type": "string",
"nullable": true
},
"vendor": {
"type": "string",
"nullable": true
},
"ptiInvoiceNumber": {
"type": "string",
"nullable": true
},
"lineType": {
"type": "string",
"nullable": true
},
"invoiceLineType": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineType"
},
"importType": {
"$ref": "#/components/schemas/be_lines_v3_ImportType"
},
"importTimeStamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_LineIdVatCode": {
"type": "object",
"properties": {
"lineId": {
"type": "string",
"nullable": true
},
"vatCodeId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_InvoiceLine": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/be_lines_v3_ObjectId"
},
"invoiceLineState": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineState"
},
"customerGUI": {
"type": "string",
"format": "uuid"
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"accountingPointGuid": {
"type": "string",
"nullable": true
},
"importedId": {
"type": "string",
"nullable": true
},
"contract": {
"type": "string",
"format": "uuid",
"nullable": true
},
"invoiceGuid": {
"type": "string",
"nullable": true
},
"prepaymentInvoiceGuid": {
"type": "string",
"nullable": true
},
"electricityInvoiceGuid": {
"type": "string",
"nullable": true
},
"termStartDate": {
"type": "string",
"format": "date-time"
},
"termEndDate": {
"type": "string",
"format": "date-time"
},
"lineType": {
"type": "string"
},
"invoiceLineType": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineType"
},
"description": {
"type": "string",
"nullable": true
},
"quantity": {
"type": "number",
"format": "double"
},
"unitPriceInCurrency": {
"type": "number",
"format": "double"
},
"discount": {
"type": "boolean",
"nullable": true
},
"vatCodeId": {
"type": "string",
"nullable": true
},
"vatCodeIdOverriden": {
"type": "boolean",
"nullable": true
},
"vatRate": {
"type": "number",
"format": "double",
"nullable": true
},
"erpVatCode": {
"type": "string",
"nullable": true
},
"vatAmount": {
"type": "number",
"format": "double"
},
"uom": {
"type": "string",
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"erpId": {
"type": "string",
"nullable": true
},
"productGuid": {
"type": "string",
"nullable": true
},
"product": {
"$ref": "#/components/schemas/be_lines_v3_Product"
},
"amount": {
"type": "number",
"format": "double"
},
"text": {
"type": "string",
"nullable": true
},
"vendor": {
"type": "string",
"nullable": true
},
"accountReference": {
"type": "string",
"nullable": true
},
"accountGuidReference": {
"type": "string",
"format": "uuid",
"nullable": true
},
"skipInvoiceControl": {
"type": "boolean",
"nullable": true
},
"ptiInvoiceNumber": {
"type": "string",
"nullable": true
},
"ptiInvoiceNumberCanceled": {
"type": "string",
"nullable": true
},
"isPrintFee": {
"type": "boolean",
"nullable": true
},
"notReimportable": {
"type": "boolean",
"nullable": true
},
"timeStamp": {
"type": "integer",
"format": "int64",
"nullable": true
},
"importTimeStamp": {
"type": "integer",
"format": "int64",
"nullable": true
},
"otherPayer": {
"type": "string",
"format": "uuid",
"nullable": true
},
"erpQuantity": {
"type": "number",
"format": "double"
},
"erpUnitPriceInCurrency": {
"type": "number",
"format": "double"
},
"erpAmount": {
"type": "number",
"format": "double"
},
"erpVatAmount": {
"type": "number",
"format": "double"
},
"exportGuid": {
"type": "string",
"nullable": true
},
"ptiApInformation": {
"type": "string",
"nullable": true
},
"accountGuid": {
"type": "string",
"nullable": true
},
"importType": {
"$ref": "#/components/schemas/be_lines_v3_ImportType"
},
"correlationLineMatch": {
"type": "string",
"nullable": true
},
"externalInterval": {
"type": "string",
"nullable": true
},
"externalIdentity": {
"type": "string",
"nullable": true
},
"rawAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"restAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"isPreliminary": {
"type": "boolean",
"nullable": true
},
"prelimPeriodEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"prelimPeriodStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hasNotMetered": {
"type": "boolean",
"nullable": true
},
"accountPeriod": {
"type": "string",
"nullable": true
},
"remainingTerms": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"hasTurnedNegativePrice": {
"type": "boolean"
}
},
"additionalProperties": false
},
"be_lines_v3_LocalizedMessage": {
"required": [
"defaultMessage",
"key"
],
"type": "object",
"properties": {
"key": {
"type": "string"
},
"defaultMessage": {
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_PublicInvoiceLine": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"productGuid": {
"type": "string",
"nullable": true
},
"erpId": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"uom": {
"type": "string",
"nullable": true
},
"vatAmount": {
"type": "number",
"format": "double"
},
"netAmount": {
"type": "number",
"format": "double"
},
"vatCodeId": {
"type": "string",
"nullable": true
},
"unitPriceInCurrency": {
"type": "number",
"format": "double"
},
"quantity": {
"type": "number",
"format": "double"
},
"description": {
"type": "string",
"nullable": true
},
"lineType": {
"type": "string",
"nullable": true
},
"invoiceLineType": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineType"
},
"importType": {
"$ref": "#/components/schemas/be_lines_v3_ImportType"
},
"termEndDate": {
"type": "string",
"format": "date-time"
},
"termStartDate": {
"type": "string",
"format": "date-time"
},
"invoiceGuid": {
"type": "string",
"nullable": true
},
"importedTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contract": {
"type": "string",
"format": "uuid"
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"accountingPointGuid": {
"type": "string",
"nullable": true
},
"vendor": {
"type": "string",
"nullable": true
},
"skipInvoiceControl": {
"type": "boolean",
"nullable": true
},
"ptiInvoiceNumber": {
"type": "string",
"nullable": true
},
"invoiceLineState": {
"$ref": "#/components/schemas/be_lines_v3_InvoiceLineState"
},
"exportGuid": {
"type": "string",
"nullable": true
},
"gridOwnerName": {
"type": "string",
"nullable": true
},
"gridOwnerGln": {
"type": "string",
"nullable": true
},
"pti": {
"type": "boolean",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"contractStatus": {
"type": "string",
"nullable": true
},
"contractStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contractEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deactivatedType": {
"type": "string",
"nullable": true
},
"meterNumber": {
"type": "string",
"nullable": true
},
"accountinPointAddress": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"productElementName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_InvoiceLineState": {
"enum": [
0,
10,
15,
20,
30,
-2,
-1
],
"type": "integer",
"description": "0 (Imported), 10 (ErpExporting), 15 (ErpExported), 20 (Distributed), 30 (Sent), -2 (Deleted), -1 (Abandoned). ",
"format": "int32"
},
"be_lines_v3_InvoiceLineType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
1000
],
"type": "integer",
"description": "0 (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). ",
"format": "int32"
},
"be_lines_v3_ImportType": {
"enum": [
0,
1,
2,
3,
4,
51,
61,
71,
81
],
"type": "integer",
"description": "0 (SettlementLines), 1 (PTI), 2 (NetAdmin), 3 (NetAdminWithAP), 4 (ScanVegt), 51 (Manually), 61 (FileImport), 71 (DownPayment), 81 (ErpSystem). ",
"format": "int32"
},
"be_lines_v3_ObjectId": {
"type": "object",
"properties": {
"timestamp": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"creationTime": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"additionalProperties": false
},
"be_lines_v3_Product": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"productElementId": {
"type": "string",
"nullable": true
},
"productName": {
"type": "string",
"nullable": true
},
"productElementName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"invoiceLineText": {
"type": "string",
"nullable": true
},
"resolution": {
"type": "string",
"nullable": true
},
"primaryProduct": {
"type": "boolean"
},
"amountUnit": {
"type": "string",
"nullable": true
},
"quantityUnit": {
"type": "string",
"nullable": true
},
"price": {
"type": "number",
"format": "double",
"nullable": true
},
"account": {
"type": "string",
"nullable": true
},
"accountNumberVatExcempt": {
"type": "string",
"nullable": true
},
"ledgerNoVatCalc": {
"type": "boolean"
},
"gln": {
"type": "string",
"nullable": true
},
"availableFront": {
"type": "boolean"
},
"isProduction": {
"type": "boolean"
},
"lineType": {
"type": "string",
"nullable": true
},
"number": {
"type": "string",
"nullable": true
},
"vatCodeId": {
"type": "string",
"nullable": true
},
"vatCodeOverride": {
"type": "boolean",
"nullable": true
},
"signDateLockMonths": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mappingType": {
"$ref": "#/components/schemas/be_lines_v3_ErpMappingType"
},
"sourceIdentification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/be_lines_v3_SourceIdentification"
},
"nullable": true
},
"master": {
"$ref": "#/components/schemas/be_lines_v3_ProductMasterType"
},
"timestamp": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mainSortOrder": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"useForConsSum": {
"type": "boolean",
"nullable": true
},
"groupId": {
"type": "string",
"nullable": true
},
"isParent": {
"type": "boolean",
"nullable": true
},
"isPreliminary": {
"type": "boolean",
"nullable": true
},
"dimensions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/be_lines_v3_DimensionKeyValue"
},
"nullable": true
},
"dynamicFields": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"be_lines_v3_ErpMappingType": {
"enum": [
0,
1,
2,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
63,
70,
80,
81,
83,
84,
90,
91
],
"type": "integer",
"description": "0 (Unknown), 1 (DefaultAccount), 2 (DefaultBankAccount), 30 (PtiProduct), 31 (PrintfeeProduct), 32 (CreditProduct), 33 (FeeProduct), 34 (DownpaymentsProduct), 35 (ReminderFeeProduct), 36 (PowerProduct), 37 (OpenPostProduct), 38 (AdministrationfeeProduct), 39 (AllProductFilter), 40 (RoundingProduct), 41 (FixedDueDateProduct), 42 (PrintfeePrivateProduct), 43 (ServiceProduct), 44 (InterestProduct), 45 (PurchaseProduct), 46 (LossProduct), 63 (DownpaymentsVatCode), 70 (CostPrintFee), 80 (CustomerNumberSerieId), 81 (CustomerTemplate), 83 (PrivateCustomerDimensionId), 84 (CorporateCustomerDimensionId), 90 (DimensionForCustomer), 91 (AccountDownpayment). ",
"format": "int32"
},
"be_lines_v3_SourceIdentification": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"identification": {
"type": "string"
},
"source": {
"type": "string"
}
},
"additionalProperties": false
},
"be_lines_v3_ProductMasterType": {
"enum": [
0,
1
],
"type": "integer",
"description": "0 (Erp), 1 (Settlement). ",
"format": "int32"
},
"be_lines_v3_DimensionKeyValue": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int32"
},
"value": {
"$ref": "#/components/schemas/be_lines_v3_DimensionEntry"
}
},
"additionalProperties": false
},
"be_lines_v3_DimensionEntry": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"customValue": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"cm_contract_cm_GetAccounts200": {
"type": "object",
"properties": {
"Count": {
"type": "number",
"example": 3
},
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
}
}
}
},
"cm_contract_cm_401Default": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Unauthorized",
"TokenExpired"
],
"type": "string",
"example": "Unauthorized"
}
}
},
"cm_contract_cm_GetAccounts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_guid": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"description": "UC Identifier",
"example": "ff175a44-90e6-4579-87f1-7e9aa07d57ac"
},
"cm_contract_cm_GetAccount200": {
"type": "object",
"properties": {
"Account": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
},
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
}
}
},
"cm_contract_cm_GetAccount400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_account_404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Account not found"
],
"type": "string",
"example": "Account not found"
}
}
},
"cm_contract_cm_GetAccount500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_UpdateAccountInput": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Addresses": {
"maxItems": 2,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"description": "The account's addresses"
},
"Communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Communication"
},
"description": "The account's communication objects"
},
"Name": {
"type": "string",
"example": "Co owned account"
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
}
},
"InvoiceTag": {
"type": "string",
"example": "Ask BE"
}
}
},
"cm_contract_cm_202Default": {
"type": "object",
"properties": {
"Message": {
"enum": [
"Request accepted"
],
"type": "string",
"example": "Request accepted"
}
}
},
"cm_contract_cm_PatchAccount400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_403Default": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Duplicate request"
],
"type": "string",
"example": "Duplicate request"
}
}
},
"cm_contract_cm_PatchAccount500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetCustomerAndAccounts200": {
"type": "object",
"properties": {
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
}
},
"Contacts": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_Contact"
}
]
}
}
}
},
"cm_contract_cm_GetCustomerAndAccounts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_GetCustomerAndAccounts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetAccountAccountingPointsDisplay200": {
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SimpleContract"
}
}
}
},
"cm_contract_cm_GetAccountAccountingPointsDisplay400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_GetAccountAccountingPointsDisplay500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetAccountAccountingPointContracts200": {
"type": "object",
"properties": {
"Contracts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Contract"
}
}
}
},
"cm_contract_cm_GetAccountAccountingPointContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_GetAccountAccountingPointContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_EraseAccountInput": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"description": "An explanation from the clerk"
},
"UserId": {
"type": "string",
"description": "The id of the user who requested the termination"
},
"DeleteInCRM": {
"type": "boolean"
},
"DeleteInBE": {
"type": "boolean"
}
}
},
"cm_contract_cm_EraseAccount400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing RequestId"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_EraseAccount500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetAccountingPoints200": {
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_AccountingPoint"
}
}
}
},
"cm_contract_cm_GetAccountingPoints400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetAccountingPoints500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostAccountingPointsRequestBody": {
"required": [
"RequestId",
"Identification"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Identification": {
"type": "string",
"description": "The accounting point identifier",
"example": "700050700700770005"
},
"VatCode": {
"type": "string"
},
"EstimatedAnnualConsumption": {
"type": "string"
},
"EstimatedAnnualProduction": {
"type": "string"
},
"APAddress": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"Details": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"GridOwnerData": {
"$ref": "#/components/schemas/cm_contract_GridOwnerData"
}
}
},
"cm_contract_cm_PostAccountingPoints400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Missing RequestId",
"Invalid RequestId",
"Missing Identification",
"Tenant missing in headers",
"Servicetype missing in headers",
"Failed to find service type in the database",
"Failed ap validation"
],
"type": "string",
"example": "Missing RequestId"
}
}
},
"cm_contract_cm_PostAccountingPoints500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Servicebus error",
"Failed to fetch service types from the database"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_SearchAccountingPointGuidsRequestBody": {
"required": [
"AccountingPoints"
],
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"type": "string",
"example": "703062000000003261"
}
}
}
},
"cm_contract_cm_SearchAccountingPointGuids200": {
"required": [
"AccountingPoints"
],
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Identification": {
"type": "string",
"example": "703062000000003261"
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
}
}
}
},
"cm_contract_cm_SearchAccountingPointGuids400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Empty Customers list"
],
"type": "string",
"example": "Empty Customers list"
}
}
},
"cm_contract_cm_SearchAccountingPointGuids500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetAccountingPoint200": {
"$ref": "#/components/schemas/cm_contract_cm_AccountingPoint"
},
"cm_contract_cm_GetAccountingPoint400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_GetAccountingPoint404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"AccountingPoint not found"
],
"type": "string",
"example": "AccountingPoint not found"
}
}
},
"cm_contract_cm_GetAccountingPoint500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PutAccountingPointRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"VatCode": {
"type": "string"
},
"EstimatedAnnualConsumption": {
"type": "string"
},
"EstimatedAnnualProduction": {
"type": "string"
},
"APAddress": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"Details": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"GridOwnerData": {
"$ref": "#/components/schemas/cm_contract_GridOwnerData"
}
}
},
"cm_contract_cm_PutAccountingPoint400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"ServiceType missing in headers",
"No update",
"Failed to find service type in the database",
"Failed to fetch service types from the database",
"Failed ap validation"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PutAccountingPoint404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"AccountingPoint not found"
],
"type": "string",
"example": "AccountingPoint not found"
}
}
},
"cm_contract_cm_PutAccountingPoint500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Connection Error",
"Servicebus error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PatchAccountingPointRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"VatCode": {
"type": "string"
},
"EstimatedAnnualConsumption": {
"type": "string"
},
"EstimatedAnnualProduction": {
"type": "string"
},
"APAddress": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"Details": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"GridOwnerData": {
"$ref": "#/components/schemas/cm_contract_GridOwnerData"
}
}
},
"cm_contract_cm_PatchAccountingPoint400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"ServiceType missing in headers",
"No update",
"Failed to find service type in the database",
"Failed to fetch service types from the database",
"Failed ap validation"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PatchAccountingPoint404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"AccountingPoint not found"
],
"type": "string",
"example": "AccountingPoint not found"
}
}
},
"cm_contract_cm_PatchAccountingPoint500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Connection Error",
"Servicebus error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PutTimeSeriesRequestBody": {
"required": [
"RequestId",
"TimeSeries"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"TimeSeries": {
"type": "object",
"properties": {
"VatCode": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_time_series_value"
}
},
"ElCertificateShare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_time_series_value"
}
}
}
}
}
},
"cm_contract_cm_PutTimeSeries400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Missing RequestId",
"Invalid RequestId",
"Super user permission required",
"Missing TimeSeries in request body",
"Missing TimeSeries.VatCode or TimeSeries.ElcertificateShare in request body"
],
"type": "string",
"example": "Missing RequestId"
}
}
},
"cm_contract_cm_GetAccountingPointContracts200": {
"type": "object",
"properties": {
"Contracts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Contract"
}
}
}
},
"cm_contract_cm_GetAccountingPointContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetAccountingPointContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PutAccountingPointWithIdRequestBody": {
"allOf": [
{
"type": "object",
"properties": {
"ServiceTypeKey": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPointRequestBody"
}
]
},
"cm_contract_cm_PatchAccountingPointWithIdRequestBody": {
"allOf": [
{
"type": "object",
"properties": {
"ServiceTypeKey": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_PatchAccountingPointRequestBody"
}
]
},
"cm_contract_cm_GetAccountingPointEvents200": {
"type": "object",
"properties": {
"CM": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SimpleEvent"
}
},
"MWE": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SimpleEvent"
}
}
}
},
"cm_contract_cm_GetAccountingPointEvents400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Invalid Accounting Point ID"
],
"type": "string",
"example": "Invalid Accounting Point ID"
}
}
},
"cm_contract_cm_GetAccountingPointEvents500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"StorageTableError"
],
"type": "string",
"example": "StorageTableError"
}
}
},
"cm_contract_cm_GetAccountingPointEventPayload200": {
"type": "object",
"properties": {
"Payload": {
"type": "object"
}
}
},
"cm_contract_cm_GetAccountingPointEventPayload400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Invalid Accounting Point ID"
],
"type": "string",
"example": "Invalid Accounting Point ID"
}
}
},
"cm_contract_cm_GetAccountingPointEventPayload404": {
"type": "object",
"properties": {
"Error": {
"type": "string",
"example": "No payload found for event: 172b4d7c-ebaa-4f82-8fae-2d8d94f12713"
}
}
},
"cm_contract_cm_GetAccountingPointEventPayload500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"StorageTableError"
],
"type": "string",
"example": "StorageTableError"
}
}
},
"cm_contract_cm_GetContracts200": {
"type": "object",
"properties": {
"Count": {
"type": "number",
"example": 3
},
"Contracts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Contract"
}
}
}
},
"cm_contract_cm_GetContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostContractsInput": {
"required": [
"RequestId",
"Customer",
"OwnerId",
"Products"
],
"type": "object",
"properties": {
"Options": {
"type": "object",
"properties": {
"SkipRequestStartOfSupplyFromMarket": {
"type": "boolean",
"example": false
},
"SkipRequestAccountingPointCharacteristicsFromMarket": {
"type": "boolean",
"example": false
},
"SkipRequestAccountingPointMeterValuesFromMarket": {
"type": "boolean",
"example": false
},
"SkipCustomerConfirmation": {
"type": "boolean",
"example": false
},
"SkipCustomerCreditCheck": {
"type": "boolean",
"example": false
}
}
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"StartDate": {
"type": "string",
"description": "If empty, then according to market requirements. Can be overriden according to market expectations and standards.",
"format": "date-time",
"default": "2019-10-14T22:00:00Z",
"example": "2019-10-14T22:00:00Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2019-10-14T22:00:00Z"
},
"StartOfSupplyDate": {
"type": "string",
"format": "date-time",
"example": "2019-10-14T22:00:00Z"
},
"StartOfSupplyRequestID": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"OwnerId": {
"type": "string",
"example": ""
},
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"CreateANewAccountForEachAccountingPoint": {
"type": "boolean"
},
"Account": {
"allOf": [
{
"$ref": "#/components/schemas/cm_contract_cm_Account"
},
{
"type": "object",
"properties": {
"InvoiceDetails": {
"$ref": "#/components/schemas/cm_contract_cm_Invoice_Details"
}
}
}
]
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
}
},
"AccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_pc_accounting_point"
}
},
"AccountingPoint": {
"$ref": "#/components/schemas/cm_contract_cm_pc_accounting_point"
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product_input"
}
},
"FIELProperties": {
"$ref": "#/components/schemas/cm_contract_fi_el_properties"
}
}
},
"cm_contract_cm_PostContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"RequestId not set",
"RequestId not valid",
"OwnerId not set",
"Customer missing",
"Customer.Identification missing",
"Customer.Identification must be a number of length 9 or 11",
"GivenName and FamilyName is required for a private customer",
"Name is required for a corporate customer",
"Customer.Account.SourceIdentification not set",
"Customer.Account.Addresses is empty or not found",
"SourceIdentification not set",
"AccountingPoint not set",
"AccountingPoint.Identification must be set",
"AccountingPoint.Identification must be of length 18",
"No Products found",
"Product.Identification missing"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PostContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetProcessAlternatives_RequestBody": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"ServiceType": {
"type": "string"
},
"AccountingPoint": {
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"type": "string"
}
}
},
"Customer": {
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"type": "string",
"description": "SSN/Org number",
"example": "11068911778"
}
}
}
}
},
"cm_contract_cm_GetProcessAlternatives_200": {
"type": "object",
"properties": {
"Process": {
"enum": [
"MoveIn",
"ProductChange"
],
"type": "string"
},
"EarliestDate": {
"type": "string"
},
"LatestDate": {
"type": "string"
},
"DateLocked": {
"type": "boolean"
}
}
},
"cm_contract_cm_GetProcessAlternatives_400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing RequestId"
],
"type": "string"
}
}
},
"cm_contract_cm_GetProcessAlternatives_500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"ConnectionError"
],
"type": "string"
}
}
},
"cm_contract_cm_TerminateContractsRequestBody": {
"required": [
"RequestId",
"CustomerIdentification",
"AccountingPointId",
"ServiceTypeKey"
],
"allOf": [
{
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"CustomerIdentification": {
"type": "string"
},
"AccountingPointId": {
"type": "string"
},
"ServiceTypeKey": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_TerminateContractRequestBody"
}
]
},
"cm_contract_cm_TerminateContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Missing EndDate",
"Invalid EndDate",
"Missing Reason",
"Addresses are mandatory for 'CustomerRequestedMove'"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_TerminateContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_RevertContractsRequestBody": {
"required": [
"RequestId",
"CustomerIdentification",
"AccountingPointId",
"ServiceTypeKey",
"Type"
],
"allOf": [
{
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"CustomerIdentification": {
"type": "string"
},
"AccountingPointId": {
"type": "string"
},
"ServiceTypeKey": {
"type": "string"
},
"Type": {
"enum": [
"RevertTermination",
"RevertActivation",
"RevertProductChange"
],
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_RevertContractRequestBody"
}
]
},
"cm_contract_cm_RevertContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Invalid Guid",
"Missing ReqeuestId",
"Invalid ReqeuestId"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_RevertContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetContract200": {
"$ref": "#/components/schemas/cm_contract_cm_Contract"
},
"cm_contract_cm_GetContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Invalid Guid"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_contract_404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Contract not found"
],
"type": "string",
"example": "Contract not found"
}
}
},
"cm_contract_cm_GetContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PatchContractsInput": {
"required": [
"RequestId",
"Commands"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Commands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_UpdateContractCommand"
}
}
}
},
"cm_contract_cm_PatchContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid guid",
"RequestId missing",
"Invalid RequestId",
"Tenant missing in headers",
"No valid commands found"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PatchContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings",
"Servicebus error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostForceActivateContractInput": {
"required": [
"RequestId",
"UserId",
"Comment"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"example": "Ended because..."
},
"UserId": {
"type": "string",
"example": "bob_hoskins@madeup.com"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"SkipRequestStartOfSupplyFromMarket": {
"type": "boolean",
"example": true
},
"SkipRequestEndOfSupplyRevertFromMarket": {
"type": "boolean",
"example": true
},
"StartOfSupplyDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"StartOfSupplyRequestID": {
"$ref": "#/components/schemas/cm_contract_cm_tp_id"
}
}
},
"cm_contract_cm_PostForceActivateContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_action_not_permitted": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Action not permitted"
],
"type": "string",
"example": "Action not permitted"
}
}
},
"cm_contract_cm_PostForceActivateContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostForceEndContractInput": {
"required": [
"RequestId",
"UserId",
"Comment"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"example": "Ended because..."
},
"UserId": {
"type": "string",
"example": "bob_hoskins@madeup.com"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"SkipRequestEndOfSupplyFromMarket": {
"type": "boolean",
"example": true
},
"DeactivatedType": {
"type": "string",
"example": "GridProviderNotifiesMoveOut"
}
}
},
"cm_contract_cm_PostForceEndContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PostForceEndContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostForceEraseContractInput": {
"required": [
"RequestId",
"UserId",
"Comment"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"example": "Erased because..."
},
"UserId": {
"type": "string",
"example": "bob_hoskins@madeup.com"
}
}
},
"cm_contract_cm_PostForceEraseContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PostForceEraseContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostForceRevertContractInput": {
"required": [
"RequestId",
"UserId",
"Comment"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"example": "Reverted because..."
},
"UserId": {
"type": "string",
"example": "bob_hoskins@madeup.com"
},
"SkipRequestStartOfSupplyRevertFromMarket": {
"type": "boolean",
"example": true
}
}
},
"cm_contract_cm_PostForceRevertContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PostForceRevertContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostForceTerminateContractInput": {
"required": [
"RequestId",
"UserId",
"Comment"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"example": "Terminated because..."
},
"Reason": {
"type": "string",
"example": ""
},
"UserId": {
"type": "string",
"example": "bob_hoskins@madeup.com"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"EndOfSupplyRequestID": {
"$ref": "#/components/schemas/cm_contract_cm_tp_id"
},
"SkipRequestEndOfSupplyFromMarket": {
"type": "boolean",
"example": true
},
"DeactivatedType": {
"type": "string",
"example": "GridProviderNotifiesMoveOut"
}
}
},
"cm_contract_cm_PostForceTerminateContract400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PostForceTerminateContract500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_TerminateContractRequestBody": {
"required": [
"RequestId",
"Reason",
"EndDate"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"Reason": {
"enum": [
"CustomerRequestedMove",
"CustomerRequestedMoveOut",
"RetailerTerminatesContract",
"CustomerTerminatesContract",
"CustomerReportedDeceased",
"CustomerReportedBankrupt"
],
"type": "string"
},
"Addresses": {
"maxItems": 2,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
}
},
"Comment": {
"type": "string",
"description": "An explanation from the clerk"
},
"UserId": {
"type": "string",
"description": "The id of the user who requested the termination"
},
"EndOfSupplyRequestID": {
"$ref": "#/components/schemas/cm_contract_cm_tp_id"
}
}
},
"cm_contract_cm_RevertContractRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"SkipRequestStartOfSupplyRevertFromMarket": {
"type": "boolean",
"example": false
},
"SkipRequestEndOfSupplyFromMarket": {
"type": "boolean",
"example": false
},
"SkipRequestEndOfSupplyRevertFromMarket": {
"type": "boolean",
"example": false
}
}
},
"cm_contract_cm_GetCustomers200": {
"type": "object",
"properties": {
"Count": {
"type": "number",
"example": 3
},
"Customers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
}
}
}
},
"cm_contract_cm_GetCustomers400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_customer_404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Customer not found"
],
"type": "string",
"example": "Customer not found"
}
}
},
"cm_contract_cm_GetCustomers500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PatchCustomerInput2": {
"required": [
"RequestId",
"Customer"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Customer": {
"required": [
"Identification"
],
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"pattern": "^[0-9]{9}$|^[0-9]{11}$",
"type": "string",
"example": "220099112"
},
"Name": {
"type": "string",
"example": "Vindkraft AS"
},
"GivenName": {
"type": "string",
"example": "Boris"
},
"FamilyName": {
"type": "string",
"example": "Johnsen"
},
"Tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"cm_contract_cm_PatchCustomer400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DefaultAccount missing",
"Invalid DefaultAccount",
"Invalid Customer Guid",
"Tenant missing in headers",
"Missing RequestId",
"Invalid RequestId",
"Customer type conversion is not allowed"
],
"type": "string",
"example": "Invalid Customer Guid"
}
}
},
"cm_contract_cm_PatchCustomer500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Connection Error",
"DBError",
"Missing servicebus settings",
"Servicebus error"
],
"type": "string",
"example": "Connection Error"
}
}
},
"cm_contract_cm_PostCustomersRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"Account": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
},
"InvoiceDetails": {
"$ref": "#/components/schemas/cm_contract_cm_Invoice_Details"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
}
}
},
"cm_contract_cm_PostCustomers400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"RequestId not set",
"RequestId not valid"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PostCustomers500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetCustomersSlim200": {
"type": "object",
"properties": {
"Count": {
"type": "number",
"example": 3
},
"Customers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SlimCustomer"
}
}
}
},
"cm_contract_cm_GetCustomersWithPhoneNumberRequestBody": {
"required": [
"PhoneNumber"
],
"type": "object",
"properties": {
"PhoneNumber": {
"type": "string",
"example": "+4711223344"
},
"Email": {
"type": "string",
"example": "svein_johnson@gmail.com"
}
}
},
"cm_contract_cm_GetCustomersWithPhoneNumber200": {
"type": "object",
"properties": {
"CustomerGuids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
}
},
"cm_contract_cm_GetCustomersWithPhoneNumber400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetCustomersWithPhoneNumber500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_SearchCustomerGuidsRequestBody": {
"required": [
"Customers"
],
"type": "object",
"properties": {
"Customers": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"cm_contract_cm_SearchCustomerGuids200": {
"required": [
"Customers"
],
"type": "object",
"properties": {
"Customers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Identification": {
"type": "string",
"example": "11068941778"
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
}
}
}
},
"cm_contract_cm_SearchCustomerGuids400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Empty Customers list"
],
"type": "string",
"example": "Empty Customers list"
}
}
},
"cm_contract_cm_SearchCustomerGuids500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetCustomer200": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"cm_contract_cm_GetCustomer400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetCustomer500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PatchCustomerInput": {
"required": [
"RequestId",
"Customer"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Customer": {
"required": [
"Guid"
],
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"pattern": "^[0-9]{9}$|^[0-9]{11}$",
"type": "string",
"example": "220099112"
},
"Name": {
"type": "string",
"example": "Vindkraft AS"
},
"GivenName": {
"type": "string",
"example": "Boris"
},
"FamilyName": {
"type": "string",
"example": "Johnsen"
},
"Tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"cm_contract_cm_PostContactsRequestBody": {
"required": [
"RequestId",
"GivenName",
"FamilyName"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cm_contract_cm_Contact"
},
{
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
}
}
}
]
},
"cm_contract_cm_PostContacts400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_PostContacts500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetOffers200": {
"type": "object",
"properties": {
"Count": {
"type": "number",
"example": 3
},
"Offers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Offer"
}
}
}
},
"cm_contract_cm_GetCustomerOffers400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetCustomerOffers500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetCustomerByRequestID200": {
"type": "object",
"properties": {
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"DefaultAccount": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
}
}
},
"cm_contract_cm_GetCustomerByRequestID400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetCustomerByRequestID500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetCustomerAccounts200": {
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
}
},
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"Contacts": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_Contact"
}
]
}
}
}
},
"cm_contract_cm_GetCustomerAccounts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_GetCustomerAccounts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostCustomerAccountsInput": {
"required": [
"RequestId",
"Addresses",
"Communication"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Name": {
"type": "string",
"description": "Account name",
"nullable": true,
"example": "Region east"
},
"Communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Communication"
}
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
}
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
}
},
"InvoiceTag": {
"type": "string",
"description": "Ask BE"
},
"CreateInCRM": {
"type": "boolean",
"description": "Whether to create a crm account or use the default crm account",
"example": false
},
"InvoiceDetails": {
"$ref": "#/components/schemas/cm_contract_cm_Invoice_Details"
}
}
},
"cm_contract_cm_PostCustomerAccounts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Customer Guid",
"Tenant missing in headers",
"Addresses missing",
"Communication missing",
"No valid address object found",
"Email|Mobile|Phone|Telefax missing in Customer.Communication"
],
"type": "string",
"example": "Invalid Customer Guid"
}
}
},
"cm_contract_cm_PostCustomerAccounts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetCustomerAccountingPointsDisplay200": {
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Guid": {
"type": "string"
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
}
},
"AccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SimpleContract2"
}
}
}
}
}
}
},
"cm_contract_cm_PostAccountingPointNicknameRequestBody": {
"required": [
"Nickname"
],
"type": "object",
"properties": {
"Nickname": {
"type": "string",
"example": "The garage"
},
"AccountingPointIdentification": {
"type": "string",
"description": "The accounting point identifier"
},
"AccountingPointGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
}
}
},
"cm_contract_cm_PostCustomerAccountingPoint400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Nickname missing in body",
"AccountingPoint identification missing in body",
"Invalid AccountingPoint identification",
"Customer not found",
"Accounting point not found"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PostCustomerAccountingPoint404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Customer not found",
"Accounting point not found"
],
"type": "string",
"example": "Customer not found"
}
}
},
"cm_contract_cm_PostCustomerAccountingPoint500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing Servicebus settings",
"Servicebus error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PostCustomerContractsRequestBody": {
"required": [
"AccountingPoint",
"RequestId",
"Products",
"StartDate",
"RequestedChannel"
],
"type": "object",
"properties": {
"AccountingPoint": {
"required": [
"Identification"
],
"type": "object",
"properties": {
"Identification": {
"type": "string",
"description": "The accounting point identifier",
"example": "700050700700770005"
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
"Account": {
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
"RequestedChannel": {
"enum": [
"Web",
"Organic Search",
"Email",
"Phone",
"Chat",
"Web Order Form",
"App",
"MyPage",
"Ticketing",
"Invoicing",
"Telemarketing",
"Elhub"
],
"type": "string",
"example": "Chat"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"StartDate": {
"type": "string",
"description": "Must be in the future",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"cm_contract_cm_PostCustomerContracts400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"Channel missing",
"AccountingPointIdentification missing",
"Invalid AccountingPointIdentification",
"Customer not found"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PostCustomerContracts500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing Servicebus settings",
"Servicebus error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_PatchCustomerAccountRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Name": {
"type": "string",
"example": "Main account"
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
}
},
"Communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Communication"
}
}
}
},
"cm_contract_cm_PatchCustomerAccount400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing Addresses and/or Communication"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_PatchCustomerAccount500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_EraseCustomer_RequestBody": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string"
}
}
},
"cm_contract_cm_EraseCustomer400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers",
"Missing RequestId",
"Invalid RequestId"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_EraseCustomer500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Connection Error",
"DBError"
],
"type": "string",
"example": "Connection Error"
}
}
},
"cm_contract_cm_change_customer_status_req_body": {
"type": "object",
"properties": {
"Status": {
"enum": [
"Deceased"
],
"type": "string",
"example": "Deceased"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Reason": {
"enum": [
"Deceased"
],
"type": "string",
"example": "Deceased"
},
"Inheritor": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
"cm_contract_cm_change_customer_status_400": {
"type": "object",
"properties": {
"Message": {
"enum": [
"Missing inheritor",
"Missing reason",
"Missing status",
"Invalid Customer Guid",
"Tenant missing in headers",
"Invalid RequestId",
"Missing RequestId"
],
"type": "string",
"example": "Missing reason"
}
}
},
"cm_contract_cm_change_customer_status_500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_SyncCustomerRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Casing": {
"enum": [
"AllCaps",
"TitleCase"
],
"type": "string",
"example": "TitleCase"
}
}
},
"cm_contract_cm_SyncCustomer400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_SyncCustomer500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Missing servicebus settings"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetOpportunity200": {
"type": "object",
"properties": {
"Opportunity": {
"type": "string",
"example": "13003469165"
}
}
},
"cm_contract_cm_GetOpportunity400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Invalid Guid",
"Tenant missing in headers"
],
"type": "string",
"example": "Invalid Guid"
}
}
},
"cm_contract_cm_GetOpportunity404": {
"type": "object",
"properties": {
"Error": {
"type": "string",
"example": "Opportunity not found"
}
}
},
"cm_contract_cm_tp_accept_offer_500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_SearchCustomersRequestBody": {
"required": [
"RequestId"
],
"type": "object",
"properties": {
"CountryCode": {
"type": "string"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"QueryString": {
"type": "string",
"description": "Phone numbers, Guid, etc",
"example": "99999999"
},
"SearchInCRM": {
"type": "boolean",
"description": "Search in the crm system",
"default": false,
"example": true
},
"SearchInBrReg": {
"type": "boolean",
"description": "Search in the entity registry",
"default": true,
"example": false
},
"SearchPhoneRegistries": {
"type": "boolean",
"description": "Search in the phone registries",
"default": true,
"example": false
},
"SearchInternally": {
"type": "boolean",
"description": "Search in uc databases",
"default": true,
"example": false
}
}
},
"cm_contract_cm_SearchCustomers200": {
"type": "object",
"properties": {
"Results": {
"title": "CM-SearchCustomers200",
"type": "array",
"items": {
"type": "object",
"properties": {
"MatchType": {
"enum": [
"Internal",
"InternalAP",
"PhoneRegistry",
"BrReg",
"CRM"
],
"type": "string"
},
"Score": {
"type": "number"
},
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"Account": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
},
"Status": {
"enum": [
"Active",
"Ended",
"Pending",
"Halted",
"UnderRevertion",
"UnderTermination",
"Reverted",
"UnderReactivation"
],
"type": "string"
}
}
}
}
}
},
"cm_contract_cm_SearchCustomers400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"RequestId missing",
"Invalid RequestId",
"QueryString missing"
],
"type": "string",
"example": "RequestId missing"
}
}
},
"cm_contract_cm_SearchCustomers404": {
"type": "object",
"properties": {
"Error": {
"enum": [
"No customer data found"
],
"type": "string",
"example": "No customer data found"
}
}
},
"cm_contract_cm_SearchCustomers500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError",
"Connection Error"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_SearchAccountingPointsRequestBody": {
"required": [
"RequestId",
"QueryString",
"ServiceTypeKey"
],
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"QueryString": {
"type": "string",
"description": "Identification, Guid, etc",
"example": "99999999"
},
"ServiceTypeKey": {
"type": "string"
},
"CheckStatus": {
"type": "boolean",
"default": false
}
}
},
"cm_contract_cm_SearchAccountingPoints200_a": {
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_AccountingPoint"
}
}
}
},
"cm_contract_cm_SearchAccountingPoints200_b": {
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AccountingPoint": {
"$ref": "#/components/schemas/cm_contract_cm_AccountingPoint"
},
"IsActive": {
"type": "boolean"
},
"CustomerGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
}
}
}
},
"cm_contract_cm_SearchAccountingPoints400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"RequestId missing",
"Invalid RequestId",
"QueryString missing",
"Invalid QueryString",
"Missing ServiceTypeKey"
],
"type": "string",
"example": "Invalid RequestId"
}
}
},
"cm_contract_cm_SearchAccountingPoints500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DB Error",
"Connection Error"
],
"type": "string",
"example": "DB Error"
}
}
},
"cm_contract_cm_archive_customer_req_body": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Reason": {
"enum": [
"Deceased",
"Forgotten",
"Merged"
],
"type": "string",
"example": "Deceased"
},
"Inheritor": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
"cm_contract_cm_archive_customer_status_400": {
"type": "object",
"properties": {
"Message": {
"enum": [
"Missing inheritor",
"Missing reason",
"Missing status",
"Invalid Customer Guid",
"Tenant missing in headers",
"Invalid RequestId",
"Missing RequestId"
],
"type": "string",
"example": "Missing reason"
}
}
},
"cm_contract_cm_archive_customer_status_500": {
"type": "object",
"properties": {
"Error": {
"enum": [
"DBError"
],
"type": "string",
"example": "DBError"
}
}
},
"cm_contract_cm_GetOffers400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetOffers500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_PostOffersInput": {
"allOf": [
{
"type": "object",
"properties": {
"TextTemplateGuid": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_PostContractsInput"
}
]
},
"cm_contract_cm_PostOffers200": {
"type": "object",
"properties": {
"OfferGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
}
}
},
"cm_contract_cm_PostOffers400": {
"type": "object",
"properties": {
"Error": {
"enum": [
"Tenant missing in headers",
"RequestId not set",
"RequestId not valid",
"OwnerId not set",
"Customer missing",
"Customer.Identification missing",
"Customer.Identification must be a number of length 9 or 11",
"GivenName and FamilyName is required for a private customer",
"Name is required for a corporate customer",
"Customer.Account.SourceIdentification not set",
"Customer.Account.Addresses is empty or not found",
"SourceIdentification not set",
"AccountingPoint not set",
"AccountingPoint.Identification must be set",
"AccountingPoint.Identification must be of length 18",
"No Products found",
"Product.Identification missing",
"Missing TextTemplateGuid"
],
"type": "string",
"example": "Tenant missing in headers"
}
}
},
"cm_contract_cm_PostOffers500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_Offer": {
"type": "object",
"properties": {
"AccountingPoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AccountGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"type": "string"
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product_input"
}
},
"RequestedType": {
"type": "string"
},
"ServiceType": {
"type": "string"
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"StartOfSupplyDate": {
"type": "string",
"format": "date-time"
},
"StartOfSupplyRequestID": {
"$ref": "#/components/schemas/cm_contract_cm_tp_id"
},
"Address": {
"type": "object",
"properties": {
"StreetName": {
"type": "string"
},
"BuildingNumber": {
"type": "string"
},
"PostCode": {
"type": "string"
},
"CityName": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"ICProduct": {
"type": "string"
}
}
}
},
"CustomerGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"RequestedChannel": {
"type": "string"
},
"Status": {
"type": "string"
}
}
},
"cm_contract_cm_GetOffer400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetOffer_404": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetOffer500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_EraseOfferInput": {
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Comment": {
"type": "string",
"description": "An explanation from the clerk"
},
"RequestedChannel": {
"type": "string"
}
}
},
"cm_contract_cm_EraseOffer400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_EraseOffer_404": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_EraseOffer500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetProduct200": {
"type": "object",
"properties": {
"Product": {
"$ref": "#/components/schemas/cm_contract_cm_internal_product"
}
}
},
"cm_contract_cm_GetProduct404": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetProduct500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_PatchProductRequestBody": {
"allOf": [
{
"type": "object",
"properties": {
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
}
}
},
{
"$ref": "#/components/schemas/cm_contract_cm_internal_product"
}
]
},
"cm_contract_cm_PatchProduct400": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_PatchProduct500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_GetProducts200": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_internal_product"
}
},
"cm_contract_cm_GetProducts500": {
"type": "object",
"properties": {
"Error": {
"type": "string"
}
}
},
"cm_contract_cm_Account": {
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"CustomerGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
},
"description": "Identifiers in other systems"
},
"Addresses": {
"maxItems": 2,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"description": "The account's addresses"
},
"Communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Communication"
},
"description": "The account's communication objects"
}
}
},
"cm_contract_cm_Customer": {
"type": "object",
"properties": {
"Identification": {
"type": "string",
"description": "SSN/Org number",
"example": "11068911778"
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"DefaultAccount": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"BirthDate": {
"type": "string"
},
"Name": {
"type": "string",
"description": "The name of the company",
"example": "Weyland-Yutani Corporation"
},
"FamilyName": {
"type": "string",
"description": "Last name",
"example": "Aandal"
},
"GivenName": {
"type": "string",
"description": "First name",
"example": "Carine"
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
}
},
"Tags": {
"type": "array",
"items": {
"type": "string"
}
},
"CreditRating": {
"type": "object",
"properties": {
"Date": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"Color": {
"enum": [
"blue",
"red",
"yellow",
"green"
],
"type": "string"
}
}
}
}
},
"cm_contract_cm_req_id": {
"pattern": "^([0-9A-Fa-f]{32}$|^[\\{][0-9A-Fa-f]{32}[\\}]$|^[0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12})$|^([\\{][0-9A-Fa-f]{8}([-][0-9A-Fa-f]{4}){3}[-][0-9A-Fa-f]{12}[\\}])$",
"type": "string",
"description": "Request ID, must be unique",
"example": "ff175a44-90e6-4579-87f1-7e9aa07d57ac"
},
"cm_contract_cm_Address": {
"required": [
"StreetName",
"BuildingNumber",
"PostCode",
"CityName",
"CountryCode"
],
"type": "object",
"properties": {
"Type": {
"enum": [
"postaladr",
"invoiceadr"
],
"type": "string",
"description": "Address type, either postaladr or invoiceadr",
"example": "postaladr"
},
"StreetName": {
"type": "string",
"example": "Wild Oats Drive"
},
"BuildingNumber": {
"type": "string",
"example": "1"
},
"FloorIdentification": {
"type": "string",
"example": "1"
},
"RoomIdentification": {
"type": "string",
"example": "1"
},
"PostCode": {
"type": "string",
"example": "1762"
},
"CityName": {
"type": "string",
"example": "Oslo"
},
"MunicipalityCode": {
"type": "string",
"example": "Klepp"
},
"CountryCode": {
"type": "string",
"example": "NO"
},
"FreeForm": {
"type": "string",
"example": ""
},
"PostofficeBox": {
"type": "string",
"example": ""
},
"CareOf": {
"type": "string",
"example": ""
},
"AttentionOf": {
"type": "string",
"example": ""
},
"OnBehalfOf": {
"type": "string",
"example": ""
},
"CitySubDivisionName": {
"type": "string"
},
"StreetCode": {
"type": "string"
}
}
},
"cm_contract_cm_Communication": {
"required": [
"Channel",
"Value"
],
"type": "object",
"properties": {
"Channel": {
"type": "string",
"description": "Communication channel types, e.g: email, mobile, phone, telefax",
"example": "Email"
},
"Value": {
"type": "string",
"description": "Value",
"example": "john_thomas_stevenson@gmail.com"
},
"Description": {
"type": "string",
"description": "Textual description from clerk",
"example": "Email address for customer"
}
}
},
"cm_contract_cm_SourceIdentification": {
"type": "object",
"properties": {
"Source": {
"type": "string",
"example": "FreshSales_Contact"
},
"Identification": {
"type": "string",
"example": "123456789"
},
"Description": {
"type": "string",
"example": "fs-contact"
}
}
},
"cm_contract_cm_Contact": {
"type": "object",
"properties": {
"CustomerGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_SourceIdentification"
},
"description": "Identifiers in other systems"
},
"GivenName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"cm_contract_cm_SimpleContract": {
"type": "object",
"properties": {
"Address": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"Status": {
"enum": [
"Active",
"Ended",
"Pending",
"Halted",
"UnderRevertion",
"UnderTermination",
"Reverted",
"UnderReactivation"
],
"type": "string"
},
"AccountingPointIdentification": {
"type": "string",
"description": "The accounting point identifier",
"example": "700050700700770005"
},
"TaxationProfile": {
"type": "object",
"properties": {
"VATCode": {
"type": "string"
},
"EnovaFeeType": {
"type": "string"
},
"EnovaFee": {
"type": "string"
},
"ElFee": {
"type": "string"
},
"ElCertificateShare": {
"type": "string"
},
"ConsumptionCode": {
"type": "string"
},
"NACE_DivisionCode": {
"type": "string"
}
}
},
"AccountGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"AccountingPointGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"AccountingPointNickname": {
"type": "string",
"description": "The customers nickname on the accounting point",
"example": "The lodge"
},
"ContractGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2019-12-14T23:00:00.000Z"
},
"MeterIdentification": {
"type": "string",
"example": "70306375",
"deprecated": true
},
"TotalAmount": {
"type": "number",
"example": 26799
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"UpcomingProductChange": {
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"EstimatedAnnualConsumption": {
"type": "string",
"format": "number",
"example": "10000"
},
"Characteristics": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"InstalledCapacity": {
"type": "string"
},
"MeterReadingStartDate": {
"type": "string"
},
"MeterReadingFrequencyDuration": {
"type": "string"
},
"MeteringPointType": {
"type": "string"
},
"MeteringPointSubTypeConsumption": {
"type": "string"
},
"MeterReadingCharacteristics": {
"type": "string"
},
"SettlementMethodType": {
"type": "string"
},
"PhysicalStatusType": {
"type": "string"
},
"ContractedConnectionCapacityValue": {
"type": "string"
},
"Description": {
"type": "string"
},
"Priority": {
"type": "string"
},
"BlockedForSwitching": {
"type": "boolean",
"example": false
}
}
},
"AddressCadastral": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Bnr": {
"type": "string"
},
"Fnr": {
"type": "string"
},
"Gnr": {
"type": "string"
},
"Snr": {
"type": "string"
}
}
},
"GeographicalCoordinate": {
"type": "object",
"properties": {
"Latitude": {
"type": "string"
},
"Longitude": {
"type": "string"
}
}
},
"GridOwnerData": {
"type": "object",
"properties": {
"GridOwnerGLN": {
"type": "string"
},
"GridOwnerNam": {
"type": "string"
},
"GridOwnerOrgNr": {
"type": "string"
},
"MGACode": {
"type": "string"
},
"MGAName": {
"type": "string"
},
"MGAType": {
"type": "string"
},
"PriceArea": {
"type": "string"
},
"PriceAreaName": {
"type": "string"
}
}
},
"MeteringInstallationMeterFacility": {
"type": "object",
"properties": {
"Constant": {
"type": "string"
},
"NumberOfDigits": {
"type": "string"
},
"MeterIdentification": {
"type": "string"
}
}
}
}
},
"cm_contract_cm_Contract": {
"required": [
"Account",
"AccountingPoint",
"Customer",
"Products"
],
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2019-12-14T23:00:00.000Z"
},
"Account": {
"$ref": "#/components/schemas/cm_contract_cm_Account"
},
"AccountingPoint": {
"$ref": "#/components/schemas/cm_contract_cm_AccountingPoint"
},
"Customer": {
"$ref": "#/components/schemas/cm_contract_cm_Customer"
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"Status": {
"enum": [
"Active",
"Ended",
"Pending",
"Halted",
"UnderRevertion",
"UnderTermination",
"Reverted",
"UnderReactivation"
],
"type": "string",
"example": "Active"
}
}
},
"cm_contract_cm_AccountingPoint": {
"type": "object",
"properties": {
"Schemes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Scheme"
}
},
"VatCode": {
"enum": [
"S",
"E"
],
"type": "string"
},
"Details": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"EstimatedAnnualProduction": {
"type": "string",
"description": "The estimated annual production",
"example": "10000"
},
"AddressCadastral": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Bnr": {
"type": "string"
},
"Fnr": {
"type": "string"
},
"Gnr": {
"type": "string"
},
"Snr": {
"type": "string"
}
}
},
"Identification": {
"type": "string",
"description": "The accounting point identifier",
"example": "700050700700770005"
},
"MeterIndices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_MeterIndex"
}
},
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"EstimatedAnnualConsumption": {
"type": "string",
"description": "The estimated annual consumption",
"example": "10000"
},
"MeteringGridAreaUsedDomainLocationIdentification": {
"type": "string",
"example": "50YELHUB1234575F"
},
"APAddress": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"GeographicalCoordinate": {
"type": "object",
"properties": {
"Latitude": {
"type": "number",
"example": 61.10887
},
"Longitude": {
"type": "number",
"example": 10.194
}
}
},
"Characteristics": {
"type": "object",
"properties": {
"InstalledCapacity": {
"type": "string"
},
"MeterReadingStartDate": {
"type": "string"
},
"MeterReadingFrequencyDuration": {
"type": "string"
},
"MeteringPointType": {
"type": "string"
},
"MeteringPointSubTypeConsumption": {
"type": "string"
},
"MeterReadingCharacteristics": {
"type": "string"
},
"MeteringPointSubTypeProduction": {
"type": "string"
},
"SettlementMethodType": {
"type": "string"
},
"PhysicalStatusType": {
"type": "string"
},
"ContractedConnectionCapacityValue": {
"type": "string"
},
"Description": {
"type": "string"
},
"Priority": {
"type": "string"
},
"BlockedForSwitching": {
"type": "boolean",
"example": false
}
}
},
"AnnualPeriodEstimatedMetrics": {
"type": "object",
"properties": {
"Total": {
"type": "string"
},
"CalculationMethod": {
"type": "string"
}
}
},
"MeteringInstallationMeterFacility": {
"type": "object",
"properties": {
"MeterIdentification": {
"type": "string"
},
"NumberOfDigits": {
"type": "string"
},
"Constant": {
"type": "string"
},
"MeterLocation": {
"type": "string"
}
}
},
"TaxationProfile": {
"type": "object",
"properties": {
"VATCode": {
"type": "string"
},
"EnovaFeeType": {
"type": "string"
},
"EnovaFee": {
"type": "string"
},
"ElFee": {
"type": "string"
},
"ElCertificateShare": {
"type": "string"
},
"ConsumptionCode": {
"type": "string"
},
"NACE_DivisionCode": {
"type": "string"
}
}
},
"MeasurementDefinition": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ProductIncludedProductCharacteristics": {
"type": "string"
},
"UnitType": {
"type": "string"
},
"Direction": {
"type": "string"
},
"Resolution": {
"type": "string"
}
}
}
},
"LastMeterReadingDate": {
"type": "string"
},
"GridOwner": {
"type": "string"
},
"GridOwnerData": {
"$ref": "#/components/schemas/cm_contract_GridOwnerData"
}
}
},
"cm_contract_GridOwnerData": {
"type": "object",
"properties": {
"GridOwnerGLN": {
"type": "string"
},
"GridOwnerNam": {
"type": "string"
},
"GridOwnerOrgNr": {
"type": "string"
},
"MGACode": {
"type": "string"
},
"MGAName": {
"type": "string"
},
"MGAType": {
"type": "string"
},
"PriceArea": {
"type": "string"
},
"PriceAreaName": {
"type": "string"
}
}
},
"cm_contract_cm_time_series_value": {
"required": [
"Value",
"From"
],
"type": "object",
"properties": {
"Value": {
"type": "string"
},
"From": {
"type": "string",
"format": "date-time"
},
"To": {
"type": "string",
"format": "date-time"
}
}
},
"cm_contract_cm_SimpleEvent": {
"type": "object",
"properties": {
"Category": {
"type": "string",
"example": "Contract"
},
"CorrelationID": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"EventID": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"EventName": {
"type": "string",
"description": "The name of the event",
"example": "ContractCreated"
},
"ReferenceEventID": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"RequestId": {
"$ref": "#/components/schemas/cm_contract_cm_req_id"
},
"Source": {
"type": "string",
"example": "CM"
},
"Timestamp": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"cm_contract_cm_Invoice_Details": {
"type": "object",
"properties": {
"InvoicePaymentTerms": {
"type": "number"
},
"InvoiceDistributionChannel": {
"type": "string"
},
"InvoiceYourReference": {
"type": "string"
},
"InvoicePostingInfo": {
"type": "string"
},
"PrintFee": {
"type": "boolean"
},
"ManualApproval": {
"type": "string"
},
"InvoiceDesign": {
"type": "string"
},
"InvoiceMinLimit": {
"type": "number"
},
"InvoiceInterval": {
"type": "number"
},
"Principle": {
"type": "number"
},
"InvoiceOpenJournalEntries": {
"type": "number"
},
"AdministrationFee": {
"type": "boolean"
},
"SecretLocation": {
"type": "boolean"
},
"DueDaySettingType": {
"type": "number"
}
}
},
"cm_contract_cm_pc_accounting_point": {
"type": "object",
"properties": {
"Identification": {
"type": "string",
"description": "707057500093637788",
"example": "Must be a verified accounting Point Id"
},
"EstimatedAnnualConsumption": {
"type": "string",
"example": ""
},
"MeterIndices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_MeterIndex"
}
}
}
},
"cm_contract_cm_Product_input": {
"required": [
"ProductName",
"ProductId"
],
"type": "object",
"properties": {
"ProductName": {
"type": "string",
"description": "The name of the product",
"example": "Green energy"
},
"ProductId": {
"type": "string",
"description": "Identifier",
"example": "f3eb38f8ff8b4612a9bbbfc2917fb851"
},
"PrimaryProduct": {
"type": "boolean",
"description": "Whether this is a primary product or supplementary product",
"example": true
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"InteractivePrices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Value": {
"type": "string"
}
}
}
}
}
},
"cm_contract_fi_el_properties": {
"type": "object",
"properties": {
"ContactType": {
"type": "string"
},
"CustomerNote": {
"type": "string"
},
"DeliveryContract": {
"type": "string"
},
"InvoicingChannel": {
"type": "string"
},
"InvoicingMethod": {
"type": "string"
},
"NoticeBasis": {
"type": "string"
},
"NoticeDays": {
"type": "string"
},
"TaxCategory": {
"type": "string"
},
"TimeLimited": {
"type": "string"
},
"TransferContractNeeded": {
"type": "string"
},
"OriginalBusinessDocumentReference": {
"type": "string"
},
"OriginalBusinessDocumentSender": {
"type": "string"
},
"ContractConfirm": {
"type": "string"
},
"NoticePeriodStart": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"NoticePeriodEnd": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"FixedContractEnd": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"FixedContractStart": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"ElectronicInvoiceAddress": {
"type": "object",
"properties": {
"ElectronicInvoiceTargetId": {
"type": "string"
},
"ElectronicInvoiceAddress": {
"type": "string"
},
"ElectronicInvoiceRouter": {
"type": "string"
}
}
}
}
},
"cm_contract_cm_UpdateContractCommand": {
"type": "object",
"properties": {
"CommandName": {
"enum": [
"RemoveProduct",
"AddProduct",
"MoveContract",
"SetEndDate",
"UpdateMoveInDate"
],
"type": "string"
},
"CommandData": {
"oneOf": [
{
"$ref": "#/components/schemas/cm_contract_cm_RemoveProductCommand"
},
{
"$ref": "#/components/schemas/cm_contract_cm_AddProductCommand"
},
{
"$ref": "#/components/schemas/cm_contract_cm_MoveContractCommand"
},
{
"$ref": "#/components/schemas/cm_contract_cm_SetEndDateCommand"
},
{
"$ref": "#/components/schemas/cm_contract_cm_UpdateMoveInDate"
},
{
"$ref": "#/components/schemas/cm_contract_cm_UpdateSubProduct"
}
]
}
}
},
"cm_contract_cm_tp_id": {
"type": "string",
"description": "Third party id",
"example": "ff175a44-90e6-4579-87f1-7e9aa07d57ac"
},
"cm_contract_cm_SlimCustomer": {
"type": "object",
"properties": {
"Guid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Identification": {
"type": "string",
"description": "SSN/Org number",
"example": "11068911778"
},
"FamilyName": {
"type": "string",
"description": "Last name",
"example": "Aandal"
},
"MiddleName": {
"type": "string",
"description": "Middle name",
"example": "Anne"
},
"GivenName": {
"type": "string",
"description": "First name",
"example": "Carine"
},
"Name": {
"type": "string",
"description": "Companyname",
"example": "UtilityCloud AS"
}
}
},
"cm_contract_cm_SimpleContract2": {
"type": "object",
"properties": {
"Address": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"Status": {
"enum": [
"Active",
"Ended",
"Pending",
"Halted",
"UnderRevertion",
"UnderTermination",
"Reverted",
"UnderReactivation"
],
"type": "string"
},
"Schemes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Scheme"
}
},
"AccountingPointIdentification": {
"type": "string",
"description": "The accounting point identifier"
},
"TaxationProfile": {
"type": "object",
"properties": {
"VATCode": {
"type": "string"
},
"EnovaFeeType": {
"type": "string"
},
"EnovaFee": {
"type": "string"
},
"ElFee": {
"type": "string"
},
"ElCertificateShare": {
"type": "string"
},
"ConsumptionCode": {
"type": "string"
},
"NACE_DivisionCode": {
"type": "string"
}
}
},
"AccountingPointGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"AccountingPointNickname": {
"type": "string",
"description": "The customers nickname on the accounting point",
"example": "The lodge"
},
"ContractGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2019-12-14T23:00:00.000Z"
},
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"MeterIdentification": {
"type": "string",
"example": "70306375",
"deprecated": true
},
"TotalAmount": {
"type": "number",
"example": 26799
},
"UpcomingProductChange": {
"type": "object",
"properties": {
"Products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Product"
}
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"EstimatedAnnualConsumption": {
"type": "string",
"format": "number",
"example": "10000"
},
"Characteristics": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"InstalledCapacity": {
"type": "string"
},
"MeterReadingStartDate": {
"type": "string"
},
"MeterReadingFrequencyDuration": {
"type": "string"
},
"MeteringPointType": {
"type": "string"
},
"MeteringPointSubTypeConsumption": {
"type": "string"
},
"MeterReadingCharacteristics": {
"type": "string"
},
"SettlementMethodType": {
"type": "string"
},
"PhysicalStatusType": {
"type": "string"
},
"ContractedConnectionCapacityValue": {
"type": "string"
},
"Description": {
"type": "string"
},
"Priority": {
"type": "string"
},
"BlockedForSwitching": {
"type": "boolean",
"example": false
}
}
},
"AddressCadastral": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Bnr": {
"type": "string"
},
"Fnr": {
"type": "string"
},
"Gnr": {
"type": "string"
},
"Snr": {
"type": "string"
}
}
},
"GeographicalCoordinate": {
"type": "object",
"properties": {
"Latitude": {
"type": "string"
},
"Longitude": {
"type": "string"
}
}
},
"GridOwnerData": {
"type": "object",
"properties": {
"GridOwnerGLN": {
"type": "string"
},
"GridOwnerNam": {
"type": "string"
},
"GridOwnerOrgNr": {
"type": "string"
},
"MGACode": {
"type": "string"
},
"MGAName": {
"type": "string"
},
"MGAType": {
"type": "string"
},
"PriceArea": {
"type": "string"
},
"PriceAreaName": {
"type": "string"
}
}
},
"MeteringInstallationMeterFacility": {
"type": "object",
"properties": {
"Constant": {
"type": "string"
},
"NumberOfDigits": {
"type": "string"
},
"MeterIdentification": {
"type": "string"
}
}
}
}
},
"cm_contract_cm_Product": {
"required": [
"ProductName",
"ProductId"
],
"type": "object",
"properties": {
"ProductName": {
"type": "string",
"description": "The name of the product",
"example": "Green energy"
},
"ProductId": {
"type": "string",
"description": "Identifier",
"example": "f3eb38f8ff8b4612a9bbbfc2917fb851"
},
"PrimaryProduct": {
"type": "boolean",
"description": "Whether this is a primary product or supplementary product",
"example": true
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"PriceValues": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"cm_contract_cm_internal_product": {
"type": "object",
"properties": {
"ID": {
"type": "string"
},
"Name": {
"type": "string"
},
"PrimaryProduct": {
"type": "boolean"
},
"EnabledForWebOrder": {
"type": "boolean"
},
"Visible": {
"type": "boolean"
},
"PriceAreas": {
"type": "array",
"items": {
"type": "string"
}
},
"InteractiveFields": {
"type": "array",
"items": {
"type": "string"
}
},
"EndDate": {
"type": "string",
"format": "date-time"
},
"ProductIdDefault": {
"type": "string"
},
"ValidPeriod": {
"type": "string"
},
"IsDisabled": {
"type": "boolean"
},
"DatePreRequisites": {
"type": "object",
"properties": {
"pre": {
"type": "string"
},
"post": {
"type": "string"
}
}
},
"WebOrderSubProducts": {
"type": "array",
"items": {
"type": "string"
}
},
"Translations": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
},
"ServiceTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"TextTemplateGuid": {
"type": "string"
}
}
},
"cm_contract_cm_Scheme": {
"type": "object",
"properties": {
"SchemeId": {
"type": "string"
},
"ValidFrom": {
"type": "string"
},
"ValidTo": {
"type": "string"
}
}
},
"cm_contract_cm_MeterIndex": {
"type": "object",
"properties": {
"TimeStamp": {
"type": "string",
"format": "date-time",
"example": "2017-07-21T17:32:28Z"
},
"Value": {
"type": "string",
"description": "",
"example": "1234567"
}
}
},
"cm_contract_cm_RemoveProductCommand": {
"required": [
"ProductId"
],
"type": "object",
"properties": {
"ProductId": {
"pattern": "^([0-9A-Fa-f]{32})$",
"example": "2312df4c8c124adc8221ddad84e2c247"
},
"_id": {
"type": "string",
"description": "The unique product id, in case there are multiple subproducts with the same id"
},
"Index": {
"type": "number",
"description": "index in the product array, in case there are multiple subproducts with the same id"
}
}
},
"cm_contract_cm_AddProductCommand": {
"required": [
"StartDate",
"ProductId",
"ProductName"
],
"type": "object",
"properties": {
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"StartDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"ProductId": {
"pattern": "^([0-9A-Fa-f]{32})$",
"type": "string",
"example": "2312df4c8c124adc8221ddad84e2c247"
},
"ProductName": {
"type": "string"
},
"InteractivePrices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Value": {
"type": "string"
}
}
}
}
}
},
"cm_contract_cm_MoveContractCommand": {
"type": "object",
"properties": {
"AccountGuid": {
"$ref": "#/components/schemas/cm_contract_cm_guid"
},
"Addresses": {
"maxItems": 2,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Address"
},
"description": "The account's addresses"
},
"Communication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_contract_cm_Communication"
},
"description": "The account's communication objects"
},
"Name": {
"type": "string",
"example": "Co-owned account"
},
"InvoiceTag": {
"type": "string",
"example": "Ask BE"
},
"Comment": {
"type": "string",
"format": "date-time"
}
}
},
"cm_contract_cm_SetEndDateCommand": {
"required": [
"EndDate"
],
"type": "object",
"properties": {
"EndDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"cm_contract_cm_UpdateMoveInDate": {
"required": [
"MoveInDate"
],
"type": "object",
"properties": {
"MoveInDate": {
"type": "string",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
}
}
},
"cm_contract_cm_UpdateSubProduct": {
"required": [
"ProductId"
],
"type": "object",
"properties": {
"ProductId": {
"pattern": "^([0-9A-Fa-f]{32})$",
"example": "2312df4c8c124adc8221ddad84e2c247"
},
"_id": {
"type": "string",
"description": "The unique product id, in case there are multiple subproducts with the same id"
},
"EndDate": {
"type": "string",
"description": "Optional end date, if missing, the contract's start date is used",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"StartDate": {
"type": "string",
"description": "Optional start date, if missing, the contract's start date is used",
"format": "date-time",
"example": "2019-11-14T23:00:00.000Z"
},
"Index": {
"type": "number",
"description": "index in the product array, in case there are multiple subproducts with the same id"
}
}
},
"cm_servicetypes_ValidationRulesList": {
"type": "object",
"properties": {
"defaultRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_FieldValidationRule"
},
"nullable": true
},
"countrySpecificRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ValidationRuleWithCountryCode"
},
"nullable": true
},
"serviceTypeSpecificRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ValidationRuleWithServiceType"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"cm_servicetypes_FieldValidationRule": {
"required": [
"fieldName",
"pattern"
],
"type": "object",
"properties": {
"fieldName": {
"$ref": "#/components/schemas/cm_servicetypes_FieldName"
},
"pattern": {
"minLength": 1,
"type": "string"
},
"examples": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"descriptions": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_ServiceType": {
"required": [
"accountingPointMasterFields",
"countryCode",
"currencyCode",
"serviceTypeKey",
"timeZone",
"translations"
],
"type": "object",
"properties": {
"serviceTypeKey": {
"minLength": 1,
"type": "string"
},
"countryCode": {
"minLength": 1,
"type": "string"
},
"timeZone": {
"minLength": 1,
"type": "string"
},
"currencyCode": {
"minLength": 1,
"type": "string"
},
"isSystemType": {
"type": "boolean"
},
"isAddonService": {
"type": "boolean"
},
"useExternalMarket": {
"type": "boolean"
},
"noSettlementInUC": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_Translation"
}
},
"iconCssClass": {
"type": "string",
"nullable": true
},
"accountingPointMasterFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_AccountingPointField"
}
},
"accountingPointDetailsFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_AccountingPointField"
},
"nullable": true
},
"invoiceLineType": {
"$ref": "#/components/schemas/cm_servicetypes_InvoiceLineType"
},
"contactRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ContactRole"
},
"nullable": true
},
"businessRules": {
"$ref": "#/components/schemas/cm_servicetypes_BusinessRules"
},
"uiConfig": {
"$ref": "#/components/schemas/cm_servicetypes_UiConfig"
},
"validationRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_FieldValidationRule"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_Operation`1": {
"type": "object",
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
},
"value": {
"type": "object",
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_ValidationRuleWithCountryCode": {
"required": [
"countryCode",
"fieldName",
"pattern"
],
"type": "object",
"properties": {
"fieldName": {
"$ref": "#/components/schemas/cm_servicetypes_FieldName"
},
"pattern": {
"minLength": 1,
"type": "string"
},
"examples": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"descriptions": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"countryCode": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"cm_servicetypes_ValidationRuleWithServiceType": {
"required": [
"fieldName",
"pattern",
"serviceTypeKey"
],
"type": "object",
"properties": {
"fieldName": {
"$ref": "#/components/schemas/cm_servicetypes_FieldName"
},
"pattern": {
"minLength": 1,
"type": "string"
},
"examples": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"descriptions": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"serviceTypeKey": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"cm_servicetypes_FieldName": {
"enum": [
"Email",
"PhoneNumber"
],
"type": "string"
},
"cm_servicetypes_Translation": {
"required": [
"languageCode",
"name"
],
"type": "object",
"properties": {
"languageCode": {
"minLength": 1,
"type": "string"
},
"name": {
"minLength": 1,
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_AccountingPointField": {
"required": [
"fieldKey",
"translations"
],
"type": "object",
"properties": {
"fieldKey": {
"minLength": 1,
"type": "string"
},
"fieldType": {
"$ref": "#/components/schemas/cm_servicetypes_FieldType"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_Translation"
}
},
"validationRegex": {
"type": "string",
"nullable": true
},
"defaultValue": {
"type": "string",
"nullable": true
},
"listItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_ListItem"
},
"nullable": true
},
"isRequiredInContract": {
"type": "boolean"
},
"isRequiredInOffer": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"requireUniqueValue": {
"type": "boolean"
},
"isRequired": {
"type": "boolean",
"deprecated": true
}
},
"additionalProperties": false
},
"cm_servicetypes_InvoiceLineType": {
"enum": [
"Unknown",
"SE",
"Pti",
"Broadband",
"TV",
"DistrictHeating",
"DistrictCooling",
"WasteManagement",
"InterestAmount",
"Services",
"Custom",
"Fee",
"DownPayment",
"ReminderFee",
"RestAmount",
"Generic",
"PrePayment",
"ChargingAgreement",
"RevenueShare",
"Information"
],
"type": "string"
},
"cm_servicetypes_ContactRole": {
"required": [
"roleCode",
"translations"
],
"type": "object",
"properties": {
"roleCode": {
"minLength": 1,
"type": "string"
},
"translations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_servicetypes_Translation"
}
},
"isDefaultRole": {
"type": "boolean"
}
},
"additionalProperties": false
},
"cm_servicetypes_BusinessRules": {
"type": "object",
"properties": {
"allowCustomersFromOtherCountries": {
"type": "boolean"
},
"accountingPointPolicy": {
"$ref": "#/components/schemas/cm_servicetypes_AccountingPointPolicy"
},
"requireSocialSecurityNumber": {
"type": "boolean"
},
"requireCreditCheck": {
"type": "boolean"
},
"enableOpportunity": {
"type": "boolean"
},
"requireSignatureForChangeOfSupplier": {
"type": "boolean"
},
"requireSignatureForChangeOfProduct": {
"type": "boolean"
}
},
"additionalProperties": false
},
"cm_servicetypes_UiConfig": {
"type": "object",
"properties": {
"communicationRule": {
"$ref": "#/components/schemas/cm_servicetypes_CommunicationRule"
},
"showCreateAccountingPoint": {
"type": "boolean"
},
"showGenerateIdentification": {
"type": "boolean"
},
"showSearchForAccountingPoint": {
"type": "boolean"
},
"showAddressFields": {
"type": "boolean"
},
"showGridOwnerDataFields": {
"type": "boolean"
},
"showGridOwnerPriceAreaName": {
"type": "boolean"
},
"showEstmatedAnnualConsumption": {
"type": "boolean"
},
"showEstmatedAnnualProduction": {
"type": "boolean"
},
"hideCreateContract": {
"type": "boolean"
}
},
"additionalProperties": false
},
"cm_servicetypes_FieldType": {
"enum": [
"Text",
"Number",
"Date",
"Boolean",
"List"
],
"type": "string"
},
"cm_servicetypes_ListItem": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"translationsDict": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_servicetypes_AccountingPointPolicy": {
"enum": [
"Both",
"New",
"Existing"
],
"type": "string"
},
"cm_servicetypes_CommunicationRule": {
"enum": [
"NoneRequired",
"EmailRequired",
"MobileRequired",
"EmailOrMobileRequired"
],
"type": "string"
},
"cm_websign_SignRequestView": {
"type": "object",
"properties": {
"signRequestGuid": {
"type": "string",
"format": "uuid"
},
"signRequestType": {
"type": "string",
"nullable": true
},
"referencesView": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_ReferenceView"
},
"nullable": true
},
"languageCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string",
"nullable": true
},
"signAfter": {
"type": "string",
"format": "date-time",
"nullable": true
},
"signBefore": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"personsToSignView": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_PersonToSignView"
},
"nullable": true
},
"documentsToSignView": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_DocumentToSignView"
},
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"cm_websign_TextTemplateResponse": {
"required": [
"contentTemplate",
"documentTitle",
"mediaType",
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of the text template."
},
"description": {
"type": "string",
"nullable": true
},
"mediaType": {
"minLength": 1,
"type": "string",
"description": "Media type (aka MIME type) of the template, e.g. `text/plain`, `text/html`."
},
"documentTitle": {
"minLength": 1,
"type": "string",
"description": "Title for the PDF document generated from the template. Also used in PDF filename."
},
"contentTemplate": {
"minLength": 1,
"type": "string",
"description": "Template using Handlebars expressions. Use period (.) for nested objects."
},
"onlyForProductIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of product IDs of products which can use this text template. Empty list is available for all products.",
"nullable": true
},
"textTemplateGuid": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CreateTextTemplateRequest": {
"required": [
"contentTemplate",
"documentTitle",
"mediaType",
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of the text template."
},
"description": {
"type": "string",
"nullable": true
},
"mediaType": {
"minLength": 1,
"type": "string",
"description": "Media type (aka MIME type) of the template, e.g. `text/plain`, `text/html`."
},
"documentTitle": {
"minLength": 1,
"type": "string",
"description": "Title for the PDF document generated from the template. Also used in PDF filename."
},
"contentTemplate": {
"minLength": 1,
"type": "string",
"description": "Template using Handlebars expressions. Use period (.) for nested objects."
},
"onlyForProductIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of product IDs of products which can use this text template. Empty list is available for all products.",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_UpdateTextTemplateRequest": {
"required": [
"contentTemplate",
"documentTitle",
"mediaType",
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of the text template."
},
"description": {
"type": "string",
"nullable": true
},
"mediaType": {
"minLength": 1,
"type": "string",
"description": "Media type (aka MIME type) of the template, e.g. `text/plain`, `text/html`."
},
"documentTitle": {
"minLength": 1,
"type": "string",
"description": "Title for the PDF document generated from the template. Also used in PDF filename."
},
"contentTemplate": {
"minLength": 1,
"type": "string",
"description": "Template using Handlebars expressions. Use period (.) for nested objects."
},
"onlyForProductIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of product IDs of products which can use this text template. Empty list is available for all products.",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_UpdateTextTemplateRequestOperation": {
"type": "object",
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
},
"value": {
"type": "object",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_StandardTextTemplate": {
"type": "object",
"properties": {
"standardTextTemplateKey": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"mediaType": {
"type": "string",
"nullable": true
},
"documentTitle": {
"type": "string",
"nullable": true
},
"contentTemplate": {
"type": "string",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_SignRequest": {
"type": "object",
"properties": {
"signRequestGuid": {
"type": "string",
"format": "uuid"
},
"signRequestType": {
"$ref": "#/components/schemas/cm_websign_SignRequestType"
},
"textTemplateGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_Reference"
},
"nullable": true
},
"languageCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string",
"nullable": true
},
"signAfter": {
"type": "string",
"format": "date-time",
"nullable": true
},
"signBefore": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/cm_websign_SignRequestStatus"
},
"externalSignOrderId": {
"type": "string",
"nullable": true
},
"externalStatus": {
"type": "string",
"nullable": true
},
"personsToSign": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_PersonToSign"
},
"nullable": true
},
"documentsToSign": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_DocumentToSign"
},
"nullable": true
},
"consent": {
"$ref": "#/components/schemas/cm_websign_Consent"
},
"history": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_HistoryRecord"
},
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_ReferenceType": {
"enum": [
"Offer",
"Contract"
],
"type": "string"
},
"cm_websign_SignRequestSlim": {
"type": "object",
"properties": {
"signRequestGuid": {
"type": "string",
"description": "The unique identifier for the sign request.",
"format": "uuid"
},
"signUrl": {
"type": "string",
"description": "The short URL if available, otherwise the long URL.",
"nullable": true
},
"signUrlLong": {
"type": "string",
"description": "The long URL.",
"nullable": true
},
"ssoParameters": {
"type": "string",
"description": "Single sign-on parameter(s) which can be appended to the query string of SignUrlLong. Based on the JWT token in the request.",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CreateSignRequestResponse": {
"type": "object",
"properties": {
"signRequestGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"cm_websign_CreateSignRequestWithTextTemplates": {
"required": [
"countryCode",
"languageCode",
"personsToSign",
"references",
"signRequestType",
"textTemplateGuids",
"timeZone"
],
"type": "object",
"properties": {
"signRequestType": {
"$ref": "#/components/schemas/cm_websign_SignRequestType"
},
"isPerson": {
"type": "boolean"
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_CreateReference"
}
},
"languageCode": {
"minLength": 1,
"type": "string"
},
"countryCode": {
"minLength": 1,
"type": "string"
},
"timeZone": {
"minLength": 1,
"type": "string"
},
"personsToSign": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_CreatePersonToSign"
}
},
"signAfter": {
"type": "string",
"format": "date-time",
"nullable": true
},
"signBefore": {
"type": "string",
"format": "date-time",
"nullable": true
},
"consent": {
"$ref": "#/components/schemas/cm_websign_CreateConsent"
},
"textTemplateGuids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"additionalProperties": false
},
"cm_websign_CommunicationRequest": {
"type": "object",
"properties": {
"communicationStage": {
"$ref": "#/components/schemas/cm_websign_CommunicationStage"
},
"mailAddress": {
"type": "string",
"nullable": true
},
"mobileNumber": {
"type": "string",
"nullable": true
},
"ssnFirstSixDigits": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_MergeField": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_GenerateTextRequest": {
"required": [
"template"
],
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Optional. Data as a JSON object. Use as an alternative to `JsonData`.",
"nullable": true
},
"jsonData": {
"type": "string",
"description": "Optional. Data as a JSON object serialized to string. Only used if `Data` is null.",
"nullable": true
},
"mergeParameters": {
"$ref": "#/components/schemas/cm_websign_MergeParameters"
},
"template": {
"minLength": 1,
"type": "string",
"description": "Template using Handlebars expressions. Use period (.) for nested objects."
},
"contentType": {
"type": "string",
"description": "Optional. MIME type of the response, e.g. `text/html`. Will be returned as a `Content-Type` HTTP header. Default is `text/plain`.",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_GeneratePdfRequest": {
"required": [
"contentHtmlTemplate",
"pdfTitle"
],
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Optional. Data as a JSON object. Use as an alternative to `JsonData`.",
"nullable": true
},
"jsonData": {
"type": "string",
"description": "Optional. Data as a JSON object serialized to string. Only used if `Data` is null.",
"nullable": true
},
"mergeParameters": {
"$ref": "#/components/schemas/cm_websign_MergeParameters"
},
"contentHtmlTemplate": {
"minLength": 1,
"type": "string",
"description": "HTML template for the content using Handlebars expressions. Use period (.) for nested objects.\nThe HTML will be prefixed with `` and suffixed with `` if either part is missing."
},
"pdfTitle": {
"minLength": 1,
"type": "string",
"description": "Title of the generated PDF. Will be used in the HTML `` tag, if `title` is not set in the `ContentHtmlTemplate`."
},
"filename": {
"type": "string",
"description": "Optional. Filename of the generated PDF. Default is no filename (null). Will be returned in a `Content-Disposition` HTTP header.",
"nullable": true
},
"headerHtmlTemplate": {
"type": "string",
"description": "HTML template for the page header using Handlebars expressions.\nRemember to set `pdfOptions.margins.top`.\nUse HTML tags with these CSS classes to get special values:\n `date` - formatted print date,\n `title` - document title,\n `url` - document location,\n `pageNumber` - current page number,\n `totalPages` - total pages in the document.\nMore [details](https://github.com/puppeteer/puppeteer/issues/5345#issuecomment-747325977) on setting header/footer.",
"nullable": true
},
"footerHtmlTemplate": {
"type": "string",
"description": "HTML template for the page footer using Handlebars expressions.\nRemember to set `pdfOptions.margins.bottom`.\nSimilar to the template for header. See it for details.",
"nullable": true
},
"pdfOptions": {
"$ref": "#/components/schemas/cm_websign_PdfOptions"
}
},
"additionalProperties": false
},
"cm_websign_ContentBlock": {
"type": "object",
"properties": {
"heading": {
"type": "string",
"nullable": true
},
"content": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_AuthorizationDocumentResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentType": {
"$ref": "#/components/schemas/cm_websign_AuthorizationType"
},
"status": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"validTo": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestedBy": {
"$ref": "#/components/schemas/cm_websign_AuthorizationParty"
},
"requestedFrom": {
"$ref": "#/components/schemas/cm_websign_AuthorizationParty"
},
"requestedTo": {
"$ref": "#/components/schemas/cm_websign_AuthorizationParty"
},
"signedBy": {
"$ref": "#/components/schemas/cm_websign_AuthorizationParty"
},
"authorizationGrant": {
"$ref": "#/components/schemas/cm_websign_AuthorizationParty"
},
"requestedFromName": {
"type": "string",
"nullable": true
},
"requestedForMeteringPointId": {
"type": "string",
"nullable": true
},
"requestedForMeteringPointAddress": {
"type": "string",
"nullable": true
},
"balanceSupplierName": {
"type": "string",
"nullable": true
},
"balanceSupplierContractName": {
"type": "string",
"nullable": true
},
"moveInDate": {
"type": "string",
"description": "Use a date in format \"yyyy-MM-dd\"",
"nullable": true
},
"language": {
"$ref": "#/components/schemas/cm_websign_AuthorizationLanguage"
}
},
"additionalProperties": false
},
"cm_websign_CreateAuthorizationDocumentRequest": {
"required": [
"documentType",
"languageCode",
"meteringPointAddress",
"meteringPointId",
"personName",
"personSsn",
"productName",
"startDateTime",
"timeZone"
],
"type": "object",
"properties": {
"personName": {
"minLength": 1,
"type": "string"
},
"personSsn": {
"minLength": 1,
"type": "string"
},
"languageCode": {
"$ref": "#/components/schemas/cm_websign_AuthorizationLanguage"
},
"timeZone": {
"minLength": 1,
"type": "string",
"description": "Time zone identifier, e.g. Europe/Oslo, according to tz/IANA time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. Europe/Oslo (which is +01:00 or +02:00)."
},
"documentType": {
"$ref": "#/components/schemas/cm_websign_AuthorizationType"
},
"productName": {
"minLength": 1,
"type": "string"
},
"meteringPointId": {
"minLength": 1,
"type": "string"
},
"meteringPointAddress": {
"minLength": 1,
"type": "string"
},
"startDateTime": {
"type": "string",
"description": "In ISO 8601 format. For example: \"2024-06-30T12:34:56Z\" or \"2024-06-30T14:34:56+02:00\".\nNote: will be converted to a date in the specified time zone before sending to Elhub.",
"format": "date-time"
}
},
"additionalProperties": false
},
"cm_websign_MarketPartyInfoResponse": {
"type": "object",
"properties": {
"gln": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_Mode": {
"enum": [
"Standard",
"View"
],
"type": "string"
},
"cm_websign_ConsentOrder": {
"type": "object",
"properties": {
"signRequestGuid": {
"type": "string",
"format": "uuid"
},
"signRequestType": {
"$ref": "#/components/schemas/cm_websign_SignRequestType"
},
"isPerson": {
"type": "boolean"
},
"languageCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string",
"nullable": true
},
"signAfter": {
"type": "string",
"format": "date-time",
"nullable": true
},
"signBefore": {
"type": "string",
"format": "date-time",
"nullable": true
},
"personNamesToSign": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"documentFileNamesToSign": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_RejectRequest": {
"type": "object",
"properties": {
"rejectReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_ErrorRequest": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_ReferenceView": {
"type": "object",
"properties": {
"referenceType": {
"type": "string",
"nullable": true
},
"referenceId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_PersonToSignView": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"externalStatus": {
"type": "string",
"nullable": true
},
"externalStatusReason": {
"type": "string",
"nullable": true
},
"acceptedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_DocumentToSignView": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_SignRequestType": {
"enum": [
"Unknown",
"ConsentNoAuth",
"ConsentWithAuth",
"SignNoAuth",
"SignWithAuth",
"AlreadySigned"
],
"type": "string"
},
"cm_websign_Reference": {
"type": "object",
"properties": {
"referenceType": {
"$ref": "#/components/schemas/cm_websign_ReferenceType"
},
"referenceId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_SignRequestStatus": {
"enum": [
"Unknown",
"InProgress",
"AcceptedByAll",
"RejectedByOneOrMore",
"Error",
"Expired",
"Cancelled"
],
"type": "string"
},
"cm_websign_PersonToSign": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"notificationMobileNumber": {
"type": "string",
"nullable": true
},
"notificationMailAddress": {
"type": "string",
"nullable": true
},
"signUrlLong": {
"type": "string",
"nullable": true
},
"signUrlShort": {
"type": "string",
"nullable": true
},
"viewUrlLong": {
"type": "string",
"nullable": true
},
"viewUrlShort": {
"type": "string",
"nullable": true
},
"externalSignatoryId": {
"type": "string",
"nullable": true
},
"externalStatus": {
"type": "string",
"nullable": true
},
"externalStatusReason": {
"type": "string",
"nullable": true
},
"acceptedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"areDocumentsSent": {
"type": "boolean"
}
},
"additionalProperties": false
},
"cm_websign_DocumentToSign": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"nullable": true
},
"contentType": {
"type": "string",
"nullable": true
},
"length": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"cm_websign_Consent": {
"type": "object",
"properties": {
"consentAccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_ConsentAccountingPoint"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_HistoryRecord": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"status": {
"$ref": "#/components/schemas/cm_websign_SignRequestStatus"
},
"activity": {
"type": "string",
"nullable": true
},
"who": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CreateReference": {
"required": [
"referenceId",
"referenceType"
],
"type": "object",
"properties": {
"referenceType": {
"$ref": "#/components/schemas/cm_websign_ReferenceType"
},
"referenceId": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"cm_websign_CreatePersonToSign": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"notificationMobileNumber": {
"type": "string",
"nullable": true
},
"notificationMailAddress": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CreateConsent": {
"type": "object",
"properties": {
"consentAccountingPoints": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cm_websign_CreateConsentAccountingPoint"
},
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CommunicationStage": {
"enum": [
"LinkWillCome",
"Link",
"Documents"
],
"type": "string"
},
"cm_websign_MergeParameters": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"description": "Optional. Which country's date separator, decimal separator, etc to use. Default is 'NO'. Use two uppercase letters used in ISO 3166-1 alpha-2.",
"nullable": true
},
"decimals": {
"type": "integer",
"description": "Optional. Number of decimals to round floating-pint numbers to. Default is 4.",
"format": "int32"
},
"timeZone": {
"type": "string",
"description": "Optional. Timezone to convert date-time properties to. Use IANA format. Default is 'Europe/Oslo'.",
"nullable": true
},
"dateTimeFormat": {
"type": "string",
"description": "Optional. Format of date-time properties. Default is 'dd.MM.yyyy', e.g. '22.11.2024'. See https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_PdfOptions": {
"type": "object",
"properties": {
"format": {
"$ref": "#/components/schemas/cm_websign_PaperFormat"
},
"landscape": {
"type": "boolean",
"description": "Paper orientation.. Defaults to `false`.",
"nullable": true
},
"margins": {
"$ref": "#/components/schemas/cm_websign_PdfMargins"
}
},
"additionalProperties": false
},
"cm_websign_AuthorizationType": {
"enum": [
"ChangeOfBalanceSupplierForPerson",
"MoveInAndChangeOfBalanceSupplierForPerson"
],
"type": "string"
},
"cm_websign_AuthorizationParty": {
"type": "object",
"properties": {
"entityType": {
"$ref": "#/components/schemas/cm_websign_AuthorizationPartyEntity"
},
"identifierType": {
"$ref": "#/components/schemas/cm_websign_AuthorizationPartyIdentifier"
},
"id": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_AuthorizationLanguage": {
"enum": [
"nb",
"nn",
"en"
],
"type": "string"
},
"cm_websign_ConsentAccountingPoint": {
"type": "object",
"properties": {
"marketProcess": {
"$ref": "#/components/schemas/cm_websign_ConsentMarketProcess"
},
"productName": {
"type": "string",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"accountingPointAddress": {
"type": "string",
"nullable": true
},
"startDateTime": {
"type": "string",
"format": "date-time"
},
"authorizationDocumentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorizationRequestId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"consentId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_CreateConsentAccountingPoint": {
"type": "object",
"properties": {
"marketProcess": {
"$ref": "#/components/schemas/cm_websign_ConsentMarketProcess"
},
"productName": {
"type": "string",
"nullable": true
},
"accountingPointId": {
"type": "string",
"nullable": true
},
"accountingPointAddress": {
"type": "string",
"nullable": true
},
"startDateTime": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"cm_websign_PaperFormat": {
"enum": [
"A4",
"A5"
],
"type": "string"
},
"cm_websign_PdfMargins": {
"type": "object",
"properties": {
"top": {
"type": "string",
"description": "Top margin with unit, e.g. \"20mm\", \"10px\", \"1.5cm\".",
"nullable": true
},
"left": {
"type": "string",
"description": "Left margin with unit, e.g. \"20mm\", \"10px\", \"1.5cm\".",
"nullable": true
},
"bottom": {
"type": "string",
"description": "Bottom margin with unit, e.g. \"20mm\", \"10px\", \"1.5cm\".",
"nullable": true
},
"right": {
"type": "string",
"description": "Right margin with units, e.g. \"20mm\", \"10px\", \"1.5cm\".",
"nullable": true
}
},
"additionalProperties": false
},
"cm_websign_AuthorizationPartyEntity": {
"enum": [
"Organization",
"OrganizationEntity",
"Person",
"AuthorizationGrant"
],
"type": "string"
},
"cm_websign_AuthorizationPartyIdentifier": {
"enum": [
"NationalIdentityNumber",
"OrganizationNumber",
"GlobalLocationNumber"
],
"type": "string"
},
"cm_websign_ConsentMarketProcess": {
"enum": [
"Other",
"ChangeOfSupply",
"MoveIn",
"ProductChange"
],
"type": "string"
},
"se_pricelist_CreatePriceListMessage": {
"type": "object",
"properties": {
"header": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListMessageHeader"
},
"createPriceListEntries": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListEntries"
}
},
"additionalProperties": false
},
"se_pricelist_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"se_pricelist_PriceListEntriesDto": {
"required": [
"header",
"priceListEntries"
],
"type": "object",
"properties": {
"header": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntriesDtoHeader"
},
"priceListEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntryDtoV2"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceListResponse": {
"type": "object",
"properties": {
"acknowledge": {
"$ref": "#/components/schemas/se_pricelist_Acknowledge"
},
"priceList": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceList"
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceListListing": {
"type": "object",
"properties": {
"listItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListListItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceListResponseDto": {
"type": "object",
"properties": {
"acknowledge": {
"$ref": "#/components/schemas/se_pricelist_Acknowledge"
},
"priceList": {
"$ref": "#/components/schemas/se_pricelist_CustomPriceListDto"
}
},
"additionalProperties": false
},
"se_pricelist_CreatePriceListMessageHeader": {
"type": "object",
"properties": {
"source": {
"type": "string",
"nullable": true
},
"receiver": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
},
"tenantID": {
"type": "string",
"nullable": true
},
"correlationID": {
"type": "string",
"nullable": true
},
"eventCreatedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"tzIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CreatePriceListEntries": {
"type": "object",
"properties": {
"header": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListEntriesHeader"
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_pricelist_CreatePriceListEntriePayload"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_PriceListEntriesDtoHeader": {
"type": "object",
"properties": {
"eventCreatedDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"tzIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_PriceListEntryDtoV2": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double"
},
"priceArea": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_Acknowledge": {
"type": "object",
"properties": {
"responseCode": {
"type": "string",
"nullable": true
},
"responseText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceList": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastUpdatedBy": {
"type": "string",
"nullable": true
},
"visible": {
"type": "boolean"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tzIdentifier": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"hasPriceAreas": {
"type": "boolean"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntry"
},
"nullable": true
},
"currency": {
"type": "string",
"nullable": true
},
"market": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceListListItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastUpdatedBy": {
"type": "string",
"nullable": true
},
"visible": {
"type": "boolean"
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"tzIdentifier": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CustomPriceListDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the price list.",
"nullable": true
},
"description": {
"type": "string",
"description": "A human-readable description of the price list. Null if not set.",
"nullable": true
},
"lastUpdatedBy": {
"type": "string",
"description": "The name or identifier of the user or system that last updated the price list. Null if not recorded.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "Indicates whether the price list is visible."
},
"lastUpdated": {
"type": "string",
"description": "The date and time the price list was last updated, in UTC. Null if the price list has never been updated.",
"format": "date-time",
"nullable": true
},
"tzIdentifier": {
"type": "string",
"description": "The IANA timezone identifier used to interpret entry start times (for example, 'Europe/Oslo'). Null if not explicitly set, the tenant default applies.",
"nullable": true
},
"currency": {
"type": "string",
"description": "The currency of the price values. Accepted values: NOK, SEK, EUR. Null if not set.",
"nullable": true
},
"market": {
"type": "string",
"description": "The ISO 3166-1 alpha-2 country code identifying the electricity market, derived from the price area. Null if the price list does not use price areas.",
"nullable": true
},
"currentPriceAreaPrices": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double",
"nullable": true
},
"description": "The current price per price area, keyed by price area identifier (for example, 'NO1'). Null if the price list does not use price areas.",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags associated with the price list. Whitespace is trimmed and duplicates are removed.",
"nullable": true
},
"hasPriceAreas": {
"type": "boolean",
"description": "Indicates whether the price list contains entries with price area assignments.",
"readOnly": true
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_pricelist_PriceListEntryDto"
},
"description": "The list of time-indexed price entries.",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CreatePriceListEntriesHeader": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_CreatePriceListEntriePayload": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"value": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"se_pricelist_PriceListEntry": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"priceListName": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"value": {
"type": "number",
"format": "double"
},
"priceArea": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_pricelist_PriceListEntryDto": {
"required": [
"startTime"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"priceListName": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"value": {
"type": "number",
"format": "double"
},
"priceArea": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_SearchResponseProductList": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"visible": {
"type": "boolean"
},
"lastChanged": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastChangedBy": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"interactiveFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_InteractivePriceEntry"
},
"nullable": true
},
"isSubProduct": {
"type": "boolean"
},
"isMainProduct": {
"type": "boolean"
},
"dynamicFields": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"validPeriod": {
"type": "string",
"nullable": true
},
"productIdDefault": {
"type": "string",
"nullable": true
},
"productNameDefault": {
"type": "string",
"nullable": true
},
"serviceType": {
"type": "string",
"nullable": true
},
"expirationInfo": {
"$ref": "#/components/schemas/se_product_ExpirationInfoDto"
},
"hasProduction": {
"type": "boolean"
}
},
"additionalProperties": false
},
"se_product_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"se_product_ProductPriceInformationApResult": {
"type": "object",
"properties": {
"productId": {
"type": "string",
"nullable": true
},
"productPriceInformation": {
"$ref": "#/components/schemas/se_product_ProductPriceInformation"
}
},
"additionalProperties": false
},
"se_product_ProductDtoSlim": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"primaryProduct": {
"type": "boolean"
},
"serviceType": {
"type": "string",
"nullable": true
},
"dynamicFields": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"visible": {
"type": "boolean"
},
"validPeriod": {
"type": "string",
"nullable": true
},
"productIdDefault": {
"type": "string",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"hasProduction": {
"type": "boolean"
}
},
"additionalProperties": false
},
"se_product_ProductDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"productElements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductElementDto"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isMainProduct": {
"type": "boolean"
},
"isSubProduct": {
"type": "boolean"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastChangedBy": {
"type": "string",
"nullable": true
},
"lastChanged": {
"type": "string",
"format": "date-time",
"nullable": true
},
"visible": {
"type": "boolean"
},
"validPeriod": {
"type": "string",
"nullable": true
},
"productIdDefault": {
"type": "string",
"nullable": true
},
"dynamicFields": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"reportCons": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"reportProd": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"elCertExpression": {
"type": "string",
"nullable": true
},
"renewableExpression": {
"type": "string",
"nullable": true
},
"usedPriceListNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"serviceType": {
"type": "string",
"nullable": true
},
"expirationInfo": {
"$ref": "#/components/schemas/se_product_ExpirationInfoDto"
},
"prePaymentValues": {
"$ref": "#/components/schemas/se_product_PrePaymentValues"
}
},
"additionalProperties": false
},
"se_product_ProductsQuery": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"productNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_product_Product": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"invoiceMessageProductName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"productElements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductElement"
},
"nullable": true
},
"primaryProduct": {
"type": "boolean"
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdTime": {
"type": "string",
"format": "date-time"
},
"lastChangedBy": {
"type": "string",
"nullable": true
},
"lastChanged": {
"type": "string",
"format": "date-time"
},
"visible": {
"type": "boolean"
},
"productElementsDefault": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_product_ProductElement"
},
"nullable": true
},
"validPeriod": {
"type": "string",
"nullable": true
},
"migration": {
"type": "boolean"
},
"productIdDefault": {
"type": "string",
"nullable": true
},
"dynamicFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"reportCons": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"reportProd": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"elCertExpression": {
"type": "string",
"nullable": true
},
"renewableExpression": {
"type": "string",
"nullable": true
},
"usedPriceListNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"serviceType": {
"type": "string",
"nullable": true
},
"expirationInfo": {
"$ref": "#/components/schemas/se_product_ExpirationInfoRecord"
},
"translations": {
"$ref": "#/components/schemas/se_product_ProductTranslationsRecord"
},
"customerSpecificVariableDefaultValues": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"se_product_InteractivePriceEntry": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"defaultValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ExpirationInfoDto": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"followUpProductId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ProductPriceInformation": {
"type": "object",
"properties": {
"costsCanBeCalculated": {
"type": "boolean"
},
"hasSpot": {
"type": "boolean",
"nullable": true
},
"hasHourlyPrice": {
"type": "boolean",
"nullable": true
},
"hourlyPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"hasMonthlyFee": {
"type": "boolean",
"nullable": true
},
"monthlyFee": {
"type": "number",
"format": "double",
"nullable": true
},
"isFixedTerm": {
"type": "boolean",
"nullable": true
},
"fixedTermMonths": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ProductElementDto": {
"type": "object",
"properties": {
"productElementName": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"invoiceLineText": {
"type": "string",
"nullable": true
},
"invoiceLineGroup": {
"type": "integer",
"format": "int32",
"nullable": true
},
"expressionSet": {
"$ref": "#/components/schemas/se_product_ExpressionSet"
},
"resolution": {
"$ref": "#/components/schemas/se_product_ProductElementResolution"
},
"productElementType": {
"$ref": "#/components/schemas/se_product_ProductElementType"
},
"elCertRule": {
"type": "integer",
"format": "int32",
"nullable": true
},
"groupId": {
"type": "string",
"nullable": true
},
"isParent": {
"type": "boolean",
"nullable": true
},
"isElcert": {
"type": "boolean",
"nullable": true
},
"reportingCategory": {
"$ref": "#/components/schemas/se_product_StandardReportingCategory"
},
"isConsumptionComponent": {
"type": "boolean",
"nullable": true
},
"isProductionComponent": {
"type": "boolean",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"quantityUnit": {
"type": "string",
"nullable": true
},
"amountUnit": {
"type": "string",
"nullable": true
},
"account": {
"type": "string",
"nullable": true
},
"altElcert": {
"type": "string",
"nullable": true
},
"hasInteractiveVariable": {
"type": "boolean"
},
"usedPriceListNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isPreliminary": {
"type": "boolean"
},
"preliminaryRule": {
"type": "integer",
"format": "int32"
},
"skipAveragePrelimPrice": {
"type": "boolean",
"nullable": true
},
"usedConstantValues": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_product_PrePaymentValues": {
"type": "object",
"properties": {
"profileId": {
"type": "string",
"nullable": true
},
"profileName": {
"type": "string",
"nullable": true
},
"useEyc": {
"type": "boolean"
},
"consumption": {
"type": "number",
"format": "double",
"nullable": true
},
"prePaymentPlan": {
"$ref": "#/components/schemas/se_product_PrePaymentPlan"
}
},
"additionalProperties": false
},
"se_product_ProductElement": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"productElementName": {
"type": "string",
"nullable": true
},
"product": {
"type": "string",
"nullable": true
},
"invoiceLineText": {
"type": "string",
"nullable": true
},
"invoiceLineGroup": {
"type": "integer",
"format": "int32",
"nullable": true
},
"expressionSet": {
"$ref": "#/components/schemas/se_product_ExpressionSet"
},
"resolution": {
"$ref": "#/components/schemas/se_product_ProductElementResolution"
},
"productElementType": {
"$ref": "#/components/schemas/se_product_ProductElementType"
},
"primaryProduct": {
"type": "boolean"
},
"quantityUnit": {
"type": "string",
"nullable": true
},
"amountUnit": {
"type": "string",
"nullable": true
},
"account": {
"type": "string",
"nullable": true
},
"altElcert": {
"type": "string",
"nullable": true
},
"isPreliminary": {
"type": "boolean"
},
"preliminaryRule": {
"type": "integer",
"format": "int32"
},
"elCertRule": {
"type": "integer",
"format": "int32"
},
"skipAveragePrelimPrice": {
"type": "boolean",
"nullable": true
},
"groupId": {
"type": "string",
"nullable": true
},
"isParent": {
"type": "boolean",
"nullable": true
},
"hasInteractiveVariable": {
"type": "boolean"
},
"isElcert": {
"type": "boolean"
},
"reportingCategory": {
"$ref": "#/components/schemas/se_product_StandardReportingCategory"
},
"isConsumptionComponent": {
"type": "boolean"
},
"isProductionComponent": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"usedPriceListNames": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"prePaymentValues": {
"$ref": "#/components/schemas/se_product_PrePaymentValues"
},
"translations": {
"$ref": "#/components/schemas/se_product_ProductElementTranslationsRecord"
}
},
"additionalProperties": false
},
"se_product_ExpirationInfoRecord": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"followUpProductId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ProductTranslationsRecord": {
"type": "object",
"properties": {
"name": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"description": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ExpressionSet": {
"type": "object",
"properties": {
"quantityExpression": {
"type": "string",
"nullable": true
},
"priceExpression": {
"type": "string",
"nullable": true
},
"quantityResultName": {
"type": "string",
"nullable": true
},
"priceResultName": {
"type": "string",
"nullable": true
},
"amountExpression": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_product_ProductElementResolution": {
"enum": [
"H",
"D",
"M",
"Y",
"NA"
],
"type": "string"
},
"se_product_ProductElementType": {
"enum": [
"Metered",
"Amount",
"Migration"
],
"type": "string"
},
"se_product_StandardReportingCategory": {
"enum": [
"NotDefined",
"Spot",
"Variable",
"Fixed"
],
"type": "string"
},
"se_product_PrePaymentPlan": {
"enum": [
"Monthly2MonthPrepaid",
"Monthly1MonthPrepaid",
"TwoMonthly",
"Quarter",
"HalfYear",
"Yearly"
],
"type": "string"
},
"se_product_ProductElementTranslationsRecord": {
"type": "object",
"properties": {
"productElementName": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
},
"invoiceLineText": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_CurrentTotalPriceResult": {
"type": "object",
"properties": {
"costsCanBeCalculated": {
"type": "boolean"
},
"costsCanBePartiallyCalculated": {
"type": "boolean"
},
"hasSpot": {
"type": "boolean",
"nullable": true
},
"totalHourlyPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"totalMonthlyFee": {
"type": "number",
"format": "double",
"nullable": true
},
"currentPriceResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_CurrentPriceResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"se_settlement_ConsumptionResults": {
"type": "object",
"properties": {
"acknowledge": {
"$ref": "#/components/schemas/se_settlement_Acknowledge"
},
"consumptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_ConsumptionEntryResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_ProductionResults": {
"type": "object",
"properties": {
"acknowledge": {
"$ref": "#/components/schemas/se_settlement_Acknowledge"
},
"productions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_ProductionEntryResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_PriceInformationV4": {
"required": [
"fifteeMinConsumptionPriceSequenceAggregated",
"fifteenMinConsumptionPriceSequence",
"hourlyConsumptionPriceSequence",
"hourlyConsumptionPriceSequenceAggregated",
"subsidiaries"
],
"type": "object",
"properties": {
"productName": {
"type": "string",
"nullable": true
},
"subProducts": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"consumptionPrice": {
"type": "number",
"format": "double"
},
"monthlyPrice": {
"type": "number",
"format": "double"
},
"hourlyConsumptionPriceSequenceAggregated": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItemV4"
},
"nullable": true
},
"hourlyConsumptionPriceSequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceV4"
},
"nullable": true
},
"fifteenMinConsumptionPriceSequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceV4"
},
"nullable": true
},
"fifteeMinConsumptionPriceSequenceAggregated": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItemV4"
},
"nullable": true
},
"subsidiaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_Subsidiary"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_PriceInformationV2": {
"type": "object",
"properties": {
"productName": {
"type": "string",
"nullable": true
},
"subProducts": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"priceExpression": {
"type": "string",
"nullable": true
},
"consumptionPrice": {
"type": "number",
"format": "double"
},
"monthlyPrice": {
"type": "number",
"format": "double"
},
"consumptionPriceSequenceAggregated": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItem"
},
"nullable": true
},
"consumptionPriceSequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItemV2"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_CurrentPriceResult": {
"type": "object",
"properties": {
"costsCanBeCalculated": {
"type": "boolean"
},
"hasSpot": {
"type": "boolean",
"nullable": true
},
"hourlyPrice": {
"type": "number",
"format": "double",
"nullable": true
},
"monthlyFee": {
"type": "number",
"format": "double",
"nullable": true
},
"priceComponents": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double"
},
"nullable": true
},
"productId": {
"type": "string",
"nullable": true
},
"productElementId": {
"type": "string",
"nullable": true
},
"product": {
"type": "string",
"nullable": true
},
"productElementName": {
"type": "string",
"nullable": true
},
"reason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_Acknowledge": {
"type": "object",
"properties": {
"responseCode": {
"type": "string",
"nullable": true
},
"responseText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_ConsumptionEntryResult": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"consumption": {
"type": "number",
"format": "double"
},
"consumptionStatus": {
"$ref": "#/components/schemas/se_settlement_BillingConsumptionStatus"
}
},
"additionalProperties": false
},
"se_settlement_ProductionEntryResult": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"production": {
"type": "number",
"format": "double"
},
"productionStatus": {
"$ref": "#/components/schemas/se_settlement_BillingConsumptionStatus"
}
},
"additionalProperties": false
},
"se_settlement_PriceSequenceItemV4": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"price": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"se_settlement_PriceSequenceV4": {
"type": "object",
"properties": {
"partProduct": {
"type": "string",
"nullable": true
},
"priceSequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItemV4"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_Subsidiary": {
"required": [
"subsidiaryPrices"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/se_settlement_SubsidiaryType"
},
"subsidiaryPrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItemV4"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_PriceSequenceItem": {
"type": "object",
"properties": {
"sequence": {
"type": "integer",
"format": "int32"
},
"price": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"se_settlement_PriceSequenceItemV2": {
"type": "object",
"properties": {
"partProduct": {
"type": "string",
"nullable": true
},
"priceSequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/se_settlement_PriceSequenceItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"se_settlement_BillingConsumptionStatus": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"se_settlement_SubsidiaryType": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"description": "JWT Authorization header using the Bearer scheme.",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"security": [
{
"bearerAuth": [ ]
}
],
"tags": [
{
"name": "Accounting",
"description": "Retrieve accounting lines by item reference or as a date-range balance report.",
"x-displayName": "Accounting"
},
{
"name": "Bank Transactions",
"description": "Search and retrieve bank transaction records.",
"x-displayName": "Bank Transactions"
},
{
"name": "Contracts",
"description": "Manage contracts lifecycle, create, update, and terminate.",
"x-displayName": "Contracts"
},
{
"name": "Customers",
"description": "Create, search, retrieve, and update customer records.",
"x-displayName": "Customers"
},
{
"name": "Debt Collection",
"description": "Manage debt collection cases, fees, and invoice line imports.",
"x-displayName": "Debt Collection"
},
{
"name": "Dimensions",
"description": "Assign and remove dimension values on invoice groups, customers, and products.",
"x-displayName": "Dimensions"
},
{
"name": "doc-product",
"x-displayName": "doc-product"
},
{
"name": "doc-product-price",
"x-displayName": "doc-product-price"
},
{
"name": "Events",
"description": "Query lifecycle events and receive external provider callbacks.",
"x-displayName": "Events"
},
{
"name": "Freshsales",
"description": "Offer acceptance and opportunity handling via the Freshsales CRM integration.",
"x-displayName": "Freshsales"
},
{
"name": "Grid Owners",
"description": "Retrieve grid owner records and PTI invoice statistics.",
"x-displayName": "Grid Owners"
},
{
"name": "Idura",
"description": "Endpoints for the Idura integration.",
"x-displayName": "Idura"
},
{
"name": "Imports",
"description": "Upload invoice data files for import processing.",
"x-displayName": "Imports"
},
{
"name": "Invoice Groups",
"description": "Create, retrieve, configure, and manage invoice groups (accounts) and their contacts.",
"x-displayName": "Invoice Groups"
},
{
"name": "Invoice Lines",
"description": "Manage invoice lines through their full lifecycle.",
"x-displayName": "Invoice Lines"
},
{
"name": "Invoices",
"description": "Access and manage invoices, PDFs, credits, and payment risk.",
"x-displayName": "Invoices"
},
{
"name": "Meter Values",
"description": "Retrieve metered consumption and production values for metering points.",
"x-displayName": "Meter Values"
},
{
"name": "Metering Points",
"description": "Create, retrieve, update, and search metering points.",
"x-displayName": "Metering Points"
},
{
"name": "Offers",
"description": "Create, retrieve, replace, and cancel customer offers.",
"x-displayName": "Offers"
},
{
"name": "Payment Agreements",
"description": "Create, retrieve, update, and delete payment agreements.",
"x-displayName": "Payment Agreements"
},
{
"name": "Payments",
"description": "List and monitor payment jobs by status and type.",
"x-displayName": "Payments"
},
{
"name": "Price Areas",
"description": "List market price areas grouped by country.",
"x-displayName": "Price Areas"
},
{
"name": "Price Information",
"description": "Retrieve current and dated electricity price information for metering points, including subsidies.",
"x-displayName": "Price Information"
},
{
"name": "Price List",
"description": "Retrieve price lists and their time-indexed price entries.",
"x-displayName": "Price List"
},
{
"name": "Price List Entries",
"description": "Create and update price list entries in bulk.",
"x-displayName": "Price List Entries"
},
{
"name": "Product Offerings",
"description": "Operations related to Product Offerings.",
"x-displayName": "Product Offerings"
},
{
"name": "Products",
"description": "List, search, and retrieve products in full or summary form.",
"x-displayName": "Products"
},
{
"name": "PTI",
"description": "Manage pass-through invoicing (PTI) supplier invoice imports and PDFs.",
"x-displayName": "PTI"
},
{
"name": "Reports",
"description": "List and download generated report files, and retrieve detailed accounting-line data for reconciliation and ERP integration.",
"x-displayName": "Reports"
},
{
"name": "Ropo",
"description": "Receive inbound debt-collection callbacks from the Ropo integration.",
"x-displayName": "Ropo"
},
{
"name": "Service Types",
"description": "List and manage the service types available for a tenant, used to classify metering points and contracts.",
"x-displayName": "Service Types"
},
{
"name": "Signing and Consent",
"description": "Create and manage sign requests, consent orders, text templates, and authorization documents.",
"x-displayName": "Signing and Consent"
},
{
"name": "Unimicro",
"description": "Receive invoice reminder lines from the Unimicro integration.",
"x-displayName": "Unimicro"
},
{
"name": "Webhooks",
"description": "Reference payload models for outbound webhook events.",
"x-displayName": "Webhooks"
}
],
"x-tagGroups": [
{
"name": "Accounting",
"tags": [
"Accounting",
"Dimensions"
]
},
{
"name": "Billing & Payments",
"tags": [
"Bank Transactions",
"Debt Collection",
"Dimensions",
"Imports",
"Invoice Groups",
"Invoice Lines",
"Invoices",
"Payment",
"Payment Agreements",
"PTI"
]
},
{
"name": "Configuration & Reference",
"tags": [
"Grid Owners",
"Price Areas",
"Service Types"
]
},
{
"name": "Core Resources",
"tags": [
"Contracts",
"Customers",
"Meter Values",
"Metering Points",
"Offers",
"Price Areas",
"Price Information",
"Price List",
"Price List Entries",
"Product Offerings",
"Products"
]
},
{
"name": "Integrations",
"tags": [
"Freshsales",
"Idura",
"Ropo",
"Unimicro"
]
},
{
"name": "Operational",
"tags": [
"Events",
"Webhooks"
]
},
{
"name": "Reports",
"tags": [
"Dimensions",
"Reports"
]
},
{
"name": "Signing and Consent",
"tags": [
"Signing and Consent"
]
}
]
}