API docs by Redocly

OCS.io OpenAPI (1.1.0)

Download OpenAPI specification:Download

E-mail: [email protected]

OCS.io OpenAPI specification.

Common

Common Operations.

Common POST Request

This is common POST request specification.

Authorizations:
(appIdapiKey)
header Parameters
X-Ocs-Io-API-Key
string

API Key, provided by admin.

X-Ocs-Io-Application-Id
string

Application ID, provided by admin.

Request Body schema: application/json
required

Payload of the request

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Customer

Customer Management related APIs.

Create Customer

Creates Customer based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customerProfile
string <= 60 characters

Profile of the Customer to be used for creation. REF to 'CustomerProfile.internalCode'.

externalId
string <= 255 characters

External ID of the Customer.

customerSegment
string <= 60 characters

Segment of the Customer. REF to 'CustomerSegment.internalCode'.

customName
string <= 255 characters

Custom Customer name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

object (StateType)

State complex type.

testCustomer
boolean

Indicates whether Customer is a Test Customer.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "externalId": "cust-test",
  • "customName": "Test Customer",
  • "customAttributes": {
    },
  • "state": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Update Customer External Id

Updates Customer's External ID for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalId
string <= 255 characters

New External ID of the Customer.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "customer": {
    },
  • "externalId": "cust-test-updated"
}

Response samples

Content type
application/json
{
  • "customName": "Test Customer updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "refId": "nPOA6bzMLW6FAD",
  • "externalId": "cust-test-updated"
}

Update Customer State

Updates Customer's State for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (StateType)

State complex type.

subordinateUpdated
boolean

Indicates whether update states for subordinate entities (Accounts with all Subordinate Accounts, Subscribers and all Subscriptions).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Customer Custom Name

Updates Customer's Custom Name for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

customName
string <= 255 characters

New Custom Name of the Customer.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "customer": {
    },
  • "customName": "Test Customer updated"
}

Response samples

Content type
application/json
{
  • "customName": "Test Customer updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "refId": "nPOA6bzMLW6FAD",
  • "externalId": "cust-test"
}

Update Customer Custom Attributes

Updates Customer's Custom Attribute(s) for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

merge
boolean

Indicates whether provided custom attributes shall be merged with already stored.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "customer": {
    },
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "customName": "Test Customer",
  • "customAttributes": {
    },
  • "state": {
    },
  • "refId": "nPOA6bzMLW6FAD",
  • "externalId": "cust-test"
}

Update Customer Segment

Update Customer's Segment for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

customerSegment
string <= 60 characters

Segment of the Customer. REF to 'CustomerSegment.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "customer": {
    },
  • "customerSegment": "resident"
}

Response samples

Content type
application/json
{
  • "customerSegment": {
    },
  • "customName": "Test Customer updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "refId": "nPOA6bzMLW6FAD",
  • "externalId": "cust-test"
}

Create Subscription On Customer

Creates Subscription on Customer level based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Read Customer

Reads Customer for given Customer's Ref ID / External ID.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Customer.

externalId
string

External ID of the Customer.

stateHistory
boolean

Indicates whether reads also State History belonging to the Customer.

accounts
boolean

Indicates whether reads also Accounts belonging to the Customer.

offers
boolean

Indicates whether reads also Subscriptions belonging to the Customer.

Responses

Response samples

Content type
application/json
{ }

Account

Account Management related APIs.

Create Account

Creates Account based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

accountProfile
string <= 60 characters

Profile of the Account to be used for creation. REF to 'AccountProfile.internalCode'.

externalId
string <= 255 characters

External ID of the Account.

accountType
string <= 60 characters

Type of the Account to be used for creation. REF to 'AccountType.internalCode'.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

accountSegment
string <= 60 characters

Segment of the Account. REF to 'AccountSegment.internalCode'.

billCycle
string <= 60 characters

BillCycle to be assigned. REF to 'BillCycle.internalCode'.

billingDay
integer <int64>

Day of the Billing in case Billing Cycle per Account is Individual.

billingMonth
integer <int64>

Month of the Billing in case Billing Cycle per Account is Individual.

billingYear
integer <int64>

Year of the Billing in case Billing Cycle per Account is Individual.

currency
string = 3 characters

Currency ISO 4217 code (3 letters). REF to 'Currency.code'.

object (StateType)

State complex type.

paymentResponsible
boolean

Indicates whether Account is Payment Responsible.

testAccount
boolean

Indicates whether Account is a Test Account.

customName
string <= 255 characters

Custom Account name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

taxExemption
boolean

Indicates whether Account is subject of Tax exemption.

taxResidence
string <= 255 characters

Tax Residence or the Payment Responsible Account.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "customer": {
    },
  • "externalId": "acc-test",
  • "accountType": "paymResp",
  • "billCycle": "mnt01",
  • "currency": "EUR",
  • "paymentResponsible": true,
  • "customName": "Test Account",
  • "customAttributes": {
    },
  • "state": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Update Account External Id

Updates Account's External ID for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalId
string <= 255 characters

New External ID of the Account.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "externalId": "acc-test-updated"
}

Response samples

Content type
application/json
{
  • "accountType": {
    },
  • "customName": "Test Account",
  • "customAttributes": {
    },
  • "paymentResponsible": true,
  • "state": {
    },
  • "customer": {
    },
  • "refId": "nPhheZUlkfgwzj",
  • "externalId": "acc-test-updated"
}

Update Account State

Updates Account's State for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (StateType)

State complex type.

subordinateUpdated
boolean

Indicates whether update States for subordinate entities (Subordinate Accounts, Subscribers and all Subscriptions).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Account Custom Name

Updates Account's Custom Name for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

customName
string <= 255 characters

New Custom Name of the Account.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "customName": "Test Account updated"
}

Response samples

Content type
application/json
{
  • "accountType": {
    },
  • "customName": "Test Account updated",
  • "paymentResponsible": true,
  • "state": {
    },
  • "customer": {
    },
  • "refId": "nPhheZUlkfgwzj",
  • "externalId": "acc-test"
}

Update Account Custom Attributes

Updates Account's Custom Attribute(s) for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

merge
boolean

Indicates whether provided custom attributes shall be merged with already stored.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "accountType": {
    },
  • "customName": "Test Account",
  • "customAttributes": {
    },
  • "paymentResponsible": true,
  • "state": {
    },
  • "customer": {
    },
  • "refId": "nPhheZUlkfgwzj",
  • "externalId": "acc-test"
}

Update Account Segment

Update Account's Segment for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

accountSegment
string <= 60 characters

New Segment of the Account. REF to 'AccountSegment.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "accountSegment": "goodPayer"
}

Response samples

Content type
application/json
{
  • "accountType": {
    },
  • "accountSegment": {
    },
  • "customName": "Test Account",
  • "customAttributes": {
    },
  • "paymentResponsible": true,
  • "state": {
    },
  • "customer": {
    },
  • "refId": "nPhheZUlkfgwzj",
  • "externalId": "acc-test"
}

Update Account Bill Cycle

Updates Account's Bill Cycle for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

billCycle
required
string <= 60 characters

New Bill Cycle. REF to 'BillCycle.internalCode'.

billingDay
integer <int64>

Day of the Billing in case Billing Cycle per Account is individual.

billingMonth
integer <int64>

Month of the Billing in case Billing Cycle per Account is individual.

billingYear
integer <int64>

Year of the Billing in case Billing Cycle per Account is individual.

validFrom
string <date-time>

Timestamp from when the new Bill Cycle is valid. If null, change is immediate.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Account Tax Exemption

Updates Account's Tax Exemption for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

taxExemption
boolean

Indicates whether Account is subject of Tax exemption.

taxResidence
string <= 255 characters

Tax Residence or the Payment Responsible Account.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "taxExemption": true,
  • "taxResidence": "CZ"
}

Response samples

Content type
application/json
{
  • "accountType": {
    },
  • "taxExemption": true,
  • "taxResidence": "CZ",
  • "paymentResponsible": true,
  • "state": {
    },
  • "customer": {
    },
  • "refId": "nPhheZUlkfgwzj",
  • "externalId": "acc-test"
}

Create Subscription On Account

Creates Subscription on Account level based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Read Account

Reads Account for given Account's Ref ID / External ID.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Account.

externalId
string

External ID of the Account.

billCycleHistory
boolean

Indicates whether reads also Bill Cycle History belonging to the Account.

stateHistory
boolean

Indicates whether reads also State History belonging to the Account.

subscribers
boolean

Indicates whether reads also Subscribers belonging to the Account.

subordinates
boolean

Indicates whether reads also Sub-ordinate Accounts belonging to the Account.

offers
boolean

Indicates whether reads also Subscriptions belonging to the Account.

Responses

Response samples

Content type
application/json
{ }

Read Billing Info

Reads Account's Billing Info.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Account (Payer)

externalId
string

External ID of the Account (Payer)

Responses

Response samples

Content type
application/json
{ }

Perform Account Bill Cycle Change

Performs scheduled Account's Bill Cycle Change for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Cancel Account Bill Cycle Change

Cancels scheduled Account's Bill Cycle Change for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Subscriber

Subscriber Management related APIs.

Create Subscriber

Creates Subscriber based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriberProfile
string <= 60 characters

Profile of the Subscriber to be used for creation. REF to 'SubscriberProfile.internalCode'.

externalId
string <= 255 characters

External ID of the Subscriber.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

primaryResourceType
string <= 60 characters

Type of the Primary Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

primaryResource
string <= 255 characters

Value of the Primary Resource which will be used for guiding to Subscriber.

subscriberSegment
string <= 60 characters

Segment of the Subscriber. REF to 'SubscriberSegment.internalCode'.

customName
string <= 255 characters

Custom Subscriber name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

object (StateType)

State complex type.

Responses

Request samples

Content type
application/json
Example
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "externalId": "subs-test",
  • "primaryResourceType": "imsi",
  • "primaryResource": "230029999999901",
  • "customName": "Test Subscriber",
  • "customAttributes": {
    },
  • "state": {
    }
}

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Update Subscriber External Id

Updates Subscriber's External ID for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalId
string <= 255 characters

New External ID of the Subscriber.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "subscriber": {
    },
  • "externalId": "subs-test-updated"
}

Response samples

Content type
application/json
{
  • "customName": "Test Subscriber updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "230029999999901",
  • "refId": "nPrCnLm1cDJ8eQ",
  • "externalId": "subs-test-updated"
}

Update Subscriber State

Updates Subscriber's State for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (StateType)

State complex type.

subordinateUpdated
boolean

Indicates whether update states for subordinate entities (all Subscriptions).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Subscriber Custom Name

Updates Subscriber's Custom Name for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

customName
string <= 255 characters

New Custom Name of the Subscriber.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "subscriber": {
    },
  • "customName": "Test Subscriber updated"
}

Response samples

Content type
application/json
{
  • "customName": "Test Subscriber updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "230029999999901",
  • "refId": "nPrCnLm1cDJ8eQ",
  • "externalId": "subs-test"
}

Update Subscriber Custom Attributes

Updates Subscriber's Custom Attribute(s) for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

merge
boolean

Indicates whether provided custom attributes shall be merged with already stored.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "subscriber": {
    },
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "customName": "Test Subscriber updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "230029999999901",
  • "refId": "nPrCnLm1cDJ8eQ",
  • "externalId": "subs-test"
}

Update Subscriber Segment

Updates Subscriber's Segment for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

subscriberSegment
string <= 60 characters

Segment of the Subscriber. REF to 'SubscriberSegment.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "subscriber": {
    },
  • "subscriberSegment": "dataAddicted"
}

Response samples

Content type
application/json
{
  • "subscriberSegment": {
    },
  • "customName": "Test Subscriber updated",
  • "customAttributes": {
    },
  • "state": {
    },
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "230029999999901",
  • "refId": "nPrCnLm1cDJ8eQ",
  • "externalId": "subs-test"
}

Create Subscription On Subscriber

Creates Subscription on Subscriber leved based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

subscriptionExternalId
string <= 255 characters

External ID of the Subscription.

customName
string

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Subscriber Resource

Creates Subscriber Resource based on provided attributes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

resourceType
required
string [ 1 .. 60 ] characters

Type of the Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

resource
required
string [ 1 .. 255 ] characters

Value of the Resource which will be used for guiding to Subscriber.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Swap Subscriber Resource

Swap Subscriber Resource.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

resourceType
required
string [ 1 .. 60 ] characters

Type of the Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

swapResource
required
string [ 1 .. 255 ] characters

Value of the Resource which will be swaped.

resource
required
string [ 1 .. 255 ] characters

New value of the Resource which will be used for guiding to Subscriber.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Read Subscriber Resource

Reads Subscriber Resource(s) for given Subscriber's ID/External ID.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Subscriber.

externalId
string

External ID of the Subscriber.

resourceType
string

Type of the Resource which will be used for guiding to Subscriber. If not provided, all Resources will be retrieved.

historyIncluded
boolean

Indicates whether Historical Resources are included in the response. By default, only Valid Resources are retrieved.

Responses

Response samples

Content type
application/json
{ }

Read Subscriber

Reads Subscriber for given Subscriber's Ref ID / External ID.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Subscriber.

externalId
string

External ID of the Subscriber.

stateHistory
boolean

Indicates whether reads also State History belonging to the Subscriber.

resources
boolean

Indicates whether reads also Resources belonging to the Subscriber.

offers
boolean

Indicates whether reads also Subscriptions belonging to the Subscriber.

Responses

Response samples

Content type
application/json
{ }

Subscription

Subscription Management related APIs.

Update Subscription External Id

Updates Subscriptions's External ID for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalId
string <= 255 characters

New External ID of the Subscription.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Subscription State

Updates Subscription's State for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (StateType)

State complex type.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Subscription Custom Name

Updates Subscriptions's Custom Name for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

customName
string <= 255 characters

New Custom Name of the Subscription.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Subscription Custom Attributes

Updates Subscriptions's Custom Attribute(s) for given Ref ID / External ID.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

merge
boolean

Indicates whether provided custom attributes shall be merged with already stored.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Read Subscription

Reads Subscription for given Subscription's Ref ID / External ID.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Subscription.

externalId
string

External ID of the Subscription.

stateHistory
boolean

Indicates whether reads also State History belonging to the Subscription.

Responses

Response samples

Content type
application/json
{ }

Individual Offer

Individual Offer Management related APIs.

Create Individual Offer Subscription

Creates Individual Offer subscription in generic way.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (ServiceValues)

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "offer": "printInvoiceFree",
  • "state": {
    },
  • "services": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Create Balance Subscription

Creates Individual Offer subscription of Balance service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

grantedBalance
required
integer <int64>

Granted Balance

unitsOfMeasurement
required
string <= 60 characters

Units Of Measurement

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "account": {
    },
  • "offer": "printInvoiceFree",
  • "state": {
    },
  • "grantedBalance": "5",
  • "unitsOfMeasurement": "EVENT"
}

Response samples

Content type
application/json
[
  • {
    }
]

Create Monetary Balance Subscription

Creates Individual Offer subscription of Monetary Balance service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

grantedBalance
required
integer <int64>

Granted Balance

tax
string <= 60 characters

Code of the Tax. REF to 'Tax.internalCode'. If null, Tax is taken from Offer definition.

taxIncluded
boolean

Indicates whether Balance is included Tax. If null, indicator is taken from Offer definition.

currency
string <= 3 characters

ISO Code of the Currency. If null, Currency is taken from Offer definition.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create One-Time Fee Subscription

Creates Individual Offer subscription of One-Time Fee service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

charge
required
integer <int64>

Charge to be applied.

tax
string <= 60 characters

Code of the Tax. REF to 'Tax.internalCode'. If null, Tax is taken from Offer definition.

taxIncluded
boolean

Indicates whether Balance is included Tax. If null, indicator is taken from Offer definition.

currency
string <= 3 characters

ISO Code of the Currency. If null, Currency is taken from Offer definition.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Recurrent Fee Subscription

Creates Individual Offer subscription of Recurrent Fee service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

charge
required
integer <int64>

Charge to be applied.

perUnit
integer <int64>

(Charge) Per Unit.

perUnitUoM
string

(Charge) Per Unit UoM. Allowed values are 'DAY', 'WEEK', 'MONTH', 'YEAR'.

tax
string <= 60 characters

Code of the Tax. REF to 'Tax.internalCode'. If null, Tax is taken from Offer definition.

taxIncluded
boolean

Indicates whether Balance is included Tax. If null, indicator is taken from Offer definition.

currency
string <= 3 characters

ISO Code of the Currency. If null, Currency is taken from Offer definition.

recurrenceCycles
integer <int64>

Number of cycles. -1 = unlimited. If null, number of cycles is taken from Offer definition.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Absolute Discount Subscription

Creates Individual Offer subscription of Absolute Discount service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

validity
integer <int64>

Validity of the Subscription.

validityPeriod
string (TimeUnitEnum)
Enum: "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Time Units values:

  • 'SECOND' - Units in Seconds.
  • 'MINUTE' - Units in Minutes.
  • 'HOUR' - Units in Hours.
  • 'DAY' - Units in Days.
  • 'WEEK' - Units in Weeks.
  • 'MONTH' - Units in Months.
  • 'YEAR' - Units in Years.
discount
required
integer <int64>

Individualized Value of the Discount. Value must be greater/equal to 0.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Percentage Discount Subscription

Creates Individual Offer subscription of Percentage Discount service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

validity
integer <int64>

Validity of the Subscription.

validityPeriod
string (TimeUnitEnum)
Enum: "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Time Units values:

  • 'SECOND' - Units in Seconds.
  • 'MINUTE' - Units in Minutes.
  • 'HOUR' - Units in Hours.
  • 'DAY' - Units in Days.
  • 'WEEK' - Units in Weeks.
  • 'MONTH' - Units in Months.
  • 'YEAR' - Units in Years.
discount
required
integer <int64>

Individualized Value of the Discount. Value must be between 0% and 100% (Number is shifted by two decimals, e.g. 5% = 500, 12,5% = 1250. Value must be between 0 and 10000).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Absolute Billing Discount Subscription

Creates Individual Offer subscription of Absolute Billing Discount service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

validity
integer <int64>

Validity of the Subscription.

validityPeriod
string (TimeUnitEnum)
Enum: "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Time Units values:

  • 'SECOND' - Units in Seconds.
  • 'MINUTE' - Units in Minutes.
  • 'HOUR' - Units in Hours.
  • 'DAY' - Units in Days.
  • 'WEEK' - Units in Weeks.
  • 'MONTH' - Units in Months.
  • 'YEAR' - Units in Years.
discount
required
integer <int64>

Individualized Value of the Discount. Value must be greater/equal to 0.

perUnit
integer <int64>

(Discount) Per Unit.

perUnitUoM
string

(Discount) Per Unit UoM. Allowed values are 'DAY', 'WEEK', 'MONTH', 'YEAR'.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Percentage Billing Discount Subscription

Creates Individual Offer subscription of Percentage Billing Discount service based Offer.

Authorizations:
(appIdapiKey)
path Parameters
entity
required
string

Name of the entity on which Individual Offer Subscription will be created. Could be 'customers', 'accounts' or 'subscribers'.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

offer
required
string [ 1 .. 60 ] characters

Code of the Offer. REF to 'Offer.internalCode'.

priority
integer <int64>

Priority of the Subscription.

externalId
string <= 255 characters

External ID of the Subscription.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateType)

State complex type.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

validity
integer <int64>

Validity of the Subscription.

validityPeriod
string (TimeUnitEnum)
Enum: "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR"

Time Units values:

  • 'SECOND' - Units in Seconds.
  • 'MINUTE' - Units in Minutes.
  • 'HOUR' - Units in Hours.
  • 'DAY' - Units in Days.
  • 'WEEK' - Units in Weeks.
  • 'MONTH' - Units in Months.
  • 'YEAR' - Units in Years.
discount
required
integer <int64>

Individualized Value of the Discount. Value must be between 0% and 100% (Number is shifted by two decimals, e.g. 5% = 500, 12,5% = 1250. Value must be between 0 and 10000).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Balance Management

Balance Management related APIs.

Read Offer Subscription Balances

Reads All Balances for given Offer Subscription's ID/External ID.

Authorizations:
(appIdapiKey)
query Parameters
offerSubscription.refId
string

Ref ID of the Offer Subscription

offerSubscription.externalId
string

External ID of the Offer Subscription

historyIncluded
boolean

Indicates whether Historical Resources are included in the response. By default only Valid Resources are retrieved

historyFrom
string <date-time>

Parameter is linked with 'historyIncluded'. If both populated, only Resources newer than given Date/Time will be retrieved.

Responses

Response samples

Content type
application/json
{
  • "balances": [
    ]
}

Read Offer Subscription Balance

Reads Specific Balance for given Offer Subscription's ID/External ID.

Authorizations:
(appIdapiKey)
path Parameters
productService
required
string

Name of the Service as configured in Product

query Parameters
offerSubscription.refId
string

Ref ID of the Offer Subscription

offerSubscription.externalId
string

External ID of the Offer Subscription

historyIncluded
boolean

Indicates whether Historical Resources are included in the response. By default only Valid Resources are retrieved

historyFrom
string <date-time>

Parameter is linked with 'historyIncluded'. If both populated, only Resources newer than given Date/Time will be retrieved.

Responses

Response samples

Content type
application/json
{
  • "service": {
    },
  • "balanceDef": {
    },
  • "balanceValues": [
    ]
}

Update Offer Subscription Balance

Updates Specific Balance for given Offer Subscription's ID/External ID.

Authorizations:
(appIdapiKey)
path Parameters
productService
required
string

Name of the Service as configured in Product

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

productService
string <= 60 characters

Product Service code

balanceValueRefId
required
string <= 40 characters

Balance Value Ref ID

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
balanceChange
required
integer <int64>

Change of the Balance, could be with positive or negative sign. If positive, Balance is increased, if negative, Balance is decreased. If type of Balance is Monetary, Currency and Including/Excluding Tax depends Balance configuration.

notificationTriggered
boolean

Indicates whether Balance Threshold notification(s) shall be triggered in case threshold has been reached.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "offerSubscription": {
    },
  • "balanceValueRefId": "nPXUWVwel7CVMQ",
  • "unitsOfMeasurement": "EVENT",
  • "balanceChange": 1
}

Response samples

Content type
application/json
{
  • "service": {
    },
  • "balanceDef": {
    },
  • "balanceValues": [
    ]
}

Update Offer Subscription Balance Definition

Updates Specific Balance Definition for given Offer Subscription's ID/External ID.

Authorizations:
(appIdapiKey)
path Parameters
productService
required
string

Name of the Service as configured in Product

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

productService
string <= 60 characters

Product Service code

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
grantedBalance
required
integer <int64>

New value for Granted Balance.

executedImmediately
boolean

Indicates whether Balance change is executed immediately.

notificationTriggered
boolean

Applied only for executedImmediately = true - Indicates whether Balance Threshold notification(s) shall be triggered in case threshold has been reached.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "offerSubscription": {
    },
  • "unitsOfMeasurement": "EVENT",
  • "grantedBalance": 1
}

Response samples

Content type
application/json
{
  • "service": {
    },
  • "balanceDef": {
    },
  • "balanceValues": [
    ]
}

Control Groups

Control Group Management related APIs.

Create Control Group

Creates Control Group.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

name
required
string [ 1 .. 80 ] characters

Name of the Control Group.

description
string <= 255 characters

Description of the Control Group.

internalCode
required
string [ 1 .. 60 ] characters

Internal Code of the Control Group.

Responses

Request samples

Content type
application/json
{
  • "internalCode": "cg-test",
  • "name": "Test Control Group",
  • "description": "Description of the Test Control Group"
}

Response samples

Content type
application/json
{
  • "internalCode": "cg-test",
  • "name": "Test Control Group",
  • "description": "Description of the Test Control Group",
  • "refId": "nPx20NfEM6Jd0i"
}

Get All Control Groups

Gets All Control Groups.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Control Group

Gets Control Group by {refId}.

Authorizations:
(appIdapiKey)
path Parameters
refId
required
string

Ref ID of the Control Group

Responses

Response samples

Content type
application/json
{
  • "internalCode": "cg-test",
  • "name": "Test Control Group",
  • "description": "Description of the Test Control Group",
  • "refId": "nPx20NfEM6Jd0i"
}

Update Control Group

Updates Control Group by {refId}.

Authorizations:
(appIdapiKey)
path Parameters
refId
required
string

Ref ID of the Control Group

Request Body schema: application/json
required

Payload of the request

name
required
string [ 1 .. 80 ] characters

Name of the Control Group.

description
string <= 255 characters

Description of the Control Group.

internalCode
required
string [ 1 .. 60 ] characters

Internal Code of the Control Group.

Responses

Request samples

Content type
application/json
{
  • "internalCode": "cg-test",
  • "name": "Test Control Group",
  • "description": "Updated description of the Test Control Group"
}

Response samples

Content type
application/json
{
  • "internalCode": "cg-test",
  • "name": "Test Control Group",
  • "description": "Updated description of the Test Control Group",
  • "refId": "nPx20NfEM6Jd0i"
}

Delete Control Group

Deletes Control Group by {refId}.

Authorizations:
(appIdapiKey)
path Parameters
refId
required
string

Ref ID of the Control Group

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Add To Control Group

Adds Accounts to Control Group.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

controlGroup
required
string [ 1 .. 60 ] characters

Control Group, REF to 'ControlGroup.internalCode'.

Array of objects (IdType)

List of Account's IDs to add to Control Group.

validFrom
string <date-time>

Date/Time from when Accounts are assigned to Control Group, if NULL validity is aligned with request Date/Time.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "controlGroup": "cg-test",
  • "accounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Remove From Control Group

Removes Accounts from Control Group.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

controlGroup
required
string [ 1 .. 60 ] characters

Control Group, REF to 'ControlGroup.internalCode'.

Array of objects (IdType)

List of Account's IDs to add to Control Group.

validFrom
string <date-time>

Date/Time from when Accounts are removed from Control Group, if NULL validity is aligned with request Date/Time.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "controlGroup": "cg-test",
  • "accounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get All Accounts belonging to the Control Group

Gets All Accounts belonging to the Control Group.

Authorizations:
(appIdapiKey)
path Parameters
refId
required
string

Ref ID of the Control Group

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All Control Groups where Account is member

Get All Control Groups where Account is member.

Authorizations:
(appIdapiKey)
query Parameters
refId
required
string

Ref ID of the Account

externalId
string

External ID of the Account

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Perform Control Group Run

Performs Control Group Run.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

controlGroup
required
string [ 1 .. 60 ] characters

Control Group for which Control billing will be performed. REF to 'ControlGroup.internalCode'.

billCycleType
string (BillCycleTypeEnum)
Enum: "PERIODICAL" "COMPOSITE" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'COMPOSITE' - Composite Billing Cycle, contains two ore more Billing Cycles (e.g. INITIAL + PERIODICAL + ADJUSTMENT).
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
effectiveDate
string <date-time>

Effective Date/Time for which Invoice within Control Group is calculated. If null, Account's Billing period end date is effective.

scheduledDate
string <date-time>

Date/Time when Control group is scheduled to be performed. If null, Control group will be performed immediately.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "controlGroup": "cg-test"
}

Response samples

Content type
application/json
{
  • "controlGroupRefId": "nPx20NfEM6Jd0i",
  • "refId": "nPIXGtByutx9qx"
}

Invoicing

Invoicing related APIs.

Adjust Chargeable Event

Adjust Chargeable Event - Credit or Debit

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

chargeableEventRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Chargeable Event.

chargeType
required
string
Enum: "CREDIT" "DEBIT"

Charge Type:

  • 'CREDIT' - Original Event is Credited by Adjusted amount.
  • 'DEBIT' - Original Event is Debited by Adjusted amount.
chargeAdjustment
required
integer <int64>

Charge Adjustment.

required
object (CurrencyEx)

Definition of the Currency.

taxIncluded
boolean

Indicates whether Tax is included in the charge adjustment.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "chargeableEventRefId": "nPiKUstjAT0Hu4",
  • "chargeType": "CREDIT",
  • "chargeAdjustment": 50000000,
  • "currency": "CZK",
  • "taxIncluded": true
}

Response samples

Content type
application/json
{ }

Preview OCS Invoice

Previews 'OCS Invoice'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

invoiceType
string [ 1 .. 60 ] characters

Type of the Invoice. If not provided, default is generated. REF to 'InvoiceType.internalCode'.

billCycleType
string (BillCycleTypeEnum)
Enum: "PERIODICAL" "COMPOSITE" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'COMPOSITE' - Composite Billing Cycle, contains two ore more Billing Cycles (e.g. INITIAL + PERIODICAL + ADJUSTMENT).
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
string <date-time>

Start Date of the Billing Period (truncated time). If not provided, Invoice Preview will be generated for current Billing Cycle.

compact
boolean

Indicates whether Invoice is generated in Compact mode.

itemizedBill
boolean

Indicates whether Invoice is generated including Itemized Bill.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "invoiceType": "pdf",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2020-10-01"
}

Response samples

Content type
application/json
{ }

Create OCS Invoice On-Demand

Creates OCS Invoice On-Demand

Authorizations:
(appIdapiKey)
query Parameters
inAdvance
boolean

Indicates whether the Invoice should be generated in advance, no Date validation are performed.

syncMode
boolean

Indicates whether the Invoice should be generated in sync mode - the Invoice is immediately returned in the response.

Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

invoiceType
string <= 60 characters

Type of the Invoice. If not provided, default is generated. REF to 'InvoiceType.internalCode'.

billCycleType
string (BillCycleTypeEnum)
Enum: "PERIODICAL" "COMPOSITE" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'COMPOSITE' - Composite Billing Cycle, contains two ore more Billing Cycles (e.g. INITIAL + PERIODICAL + ADJUSTMENT).
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
string <date-time>

Start Date of the Billing Period (truncated time). If not provided, Invoice will be generated for Billing Cycle in which Account was active.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "invoiceType": "pdf",
  • "billingPeriodStartDate": "2020-12-01"
}

Response samples

Content type
application/json
{ }

Payer

Payer related APIs.

Update Payer

Creates/Updates Payer with RM related information

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMethod
string [ 1 .. 60 ] characters

PaymentMethod assigned to Account.

deliveryMethod
string [ 1 .. 60 ] characters

DeliveryMethod assigned to Account.

invoicingExcluded
boolean

Indicates whether Payer is excluded from Invoicing.

invoicingExcludedTo
string <date-time>

If Payer is excluded from Invoicing, this is optional date till when Payer is excluded.

dueDateOffset
integer <int64>

Offset for calculation of Due Date of the Document. If null, document(s) will be created with default offset.

bankAccountNumber
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code.

iban
string <= 50 characters

IBAN

bic
string <= 30 characters

BIC code of bank.

bankAccountName
string <= 80 characters

Payer's (Billing Account) bank account name.

paymentRef1
string <= 30 characters

Payer's (Billing Account) Payment Reference No.1 in case Payment Reference No.1 is static.

paymentRef2
string <= 30 characters

Payer's (Billing Account) Payment Reference No.2 in case Payment Reference No.2 is static.

paymentRef3
string <= 30 characters

Payer's (Billing Account) Payment Reference No.3 in case Payment Reference No.3 is static.

bankAccountNumberDirectDebit
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebit
string <= 10 characters

Payer's (Billing Account) bank number code for Direct Debit.

bankAccountNumberDirectDebitProvider
string <= 80 characters

Provider's bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebitProvider
string <= 10 characters

Provider's bank number code for Direct Debit.

vatLiable
boolean

Indicates whether Payer is liable for VAT.

vatLiableEffectiveDate
string <date-time>

Effective Date/Time from or till when Payer is liable for VAT.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentMethod": "directDebit",
  • "deliveryMethod": "email",
  • "invoicingExcluded": true,
  • "dueDateOffset": 30,
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876",
  • "vatLiable": true,
  • "vatLiableEffectiveDate": "2020-10-01T22:00:00.000+02:00"
}

Response samples

Content type
application/json
{
  • "refId": "nPCje7TuSWPbV5",
  • "account": {
    },
  • "accountType": {
    },
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "invoicingExcluded": false,
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876",
  • "vatLiable": true,
  • "vatLiableValidFrom": "2020-10-01T22:00:00.000+02:00"
}

Update Payment Method

Updates Payer's Payment Method

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMethod
required
string [ 1 .. 60 ] characters

PaymentMethod assigned to Account. REF to 'PaymentMethod.internalCode'.

bankAccountNumber
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code.

iban
string <= 50 characters

IBAN number of bank account.

bic
string <= 30 characters

BIC code of bank.

bankAccountName
string <= 80 characters

Payer's (Billing Account) bank account name.

paymentRef1
string <= 30 characters

Payer's (Billing Account) Payment Reference No.1 in case Payment Reference No.1 is static.

paymentRef2
string <= 30 characters

Payer's (Billing Account) Payment Reference No.2 in case Payment Reference No.2 is static.

paymentRef3
string <= 30 characters

Payer's (Billing Account) Payment Reference No.3 in case Payment Reference No.3 is static.

bankAccountNumberDirectDebit
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebit
string <= 10 characters

Payer's (Billing Account) bank number code for Direct Debit.

bankAccountNumberDirectDebitProvider
string <= 80 characters

Provider's bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebitProvider
string <= 10 characters

Provider's bank number code for Direct Debit.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentMethod": "directDebit",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876"
}

Response samples

Content type
application/json
{
  • "refId": "nPFuFZ5La2VED6",
  • "account": {
    },
  • "accountType": {
    },
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "invoicingExcluded": false,
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876"
}

Update Delivery Method

Updates Payer's Delivery Method

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

deliveryMethod
required
string [ 1 .. 60 ] characters

DeliveryMethod assigned to Account. REF to 'DeliveryMethod.internalCode'.

documentType
string [ 1 .. 60 ] characters

Type of the Document for which Delivery Method is updated. If null, Delivery Method is valid for all document types. REF to 'DocumentType.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "deliveryMethod": "email"
}

Response samples

Content type
application/json
{
  • "refId": "nPFuFZ5La2VED6",
  • "account": {
    },
  • "accountType": {
    },
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "invoicingExcluded": false,
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876"
}

Update Due Date Offset

Updates Payer's Due Date Offset

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

dueDateOffset
integer <int64>

Offset for calculation of Due Date of the Document. If null, document(s) will be created with default offset.

documentType
string <= 60 characters

Type of the Document for which Due Date Offset is updated. If null, Offset is valid for all document types. REF to 'DocumentType.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "dueDateOffset": 30
}

Response samples

Content type
application/json
{
  • "refId": "nPCje7TuSWPbV5",
  • "account": {
    },
  • "accountType": {
    },
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "invoicingExcluded": false,
  • "dueDateOffset": 30,
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876"
}

Update Invoicing Flag

Updates Payer's Invoicing Flag

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

invoicingExcluded
required
boolean

Indicates whether Payer is excluded from Invoicing.

invoicingExcludedTo
string <date-time>

If Payer is excluded from Invoicing, this is optional date till when Payer is excluded.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "invoicingExcluded": true
}

Response samples

Content type
application/json
{
  • "refId": "nPFuFZ5La2VED6",
  • "account": {
    },
  • "accountType": {
    },
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "invoicingExcluded": true,
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "bankNumberCodeDirectDebit": "1234",
  • "bankAccountNumberDirectDebitProvider": "000987-654321",
  • "bankNumberCodeDirectDebitProvider": "9876"
}

Read Open Balance

Reads Payer's Open Balance.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Account (Payer)

externalId
string

External ID of the Account (Payer)

detailIncluded
boolean

Indicates whether Detail per Document Type is included.

calculationForced
boolean

Indicates whether Open Balance calculation is forced.

Responses

Response samples

Content type
application/json
Example
{
  • "openBalanceTotal": 200000000,
  • "openBalanceAr": 500000000,
  • "openBalanceLiability": 200000000,
  • "openBalanceTotalFuture": 300000000,
  • "openBalanceArFuture": 500000000,
  • "openBalanceLiabilityFuture": 200000000,
  • "openBalancePayment": 100000000
}

Read Collection Balance

Reads Payer's Collection Balance.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Account (Payer)

externalId
string

External ID of the Account (Payer)

calculationForced
boolean

Indicates whether Collection Balance calculation is forced.

Responses

Response samples

Content type
application/json
{
  • "collectionBalanceTotal": 100000000,
  • "lastCalculated": "2021-03-29T12:17:14.166+02:00",
  • "soonestDocumentDueDate": "2021-03-30T00:00:00.000+02:00"
}

Read Payment Moral

Reads Payer's Payment Moral.

Authorizations:
(appIdapiKey)
query Parameters
refId
string

Ref ID of the Account (Payer)

externalId
string

External ID of the Account (Payer)

calculationForced
boolean

Indicates whether Payment Moral calculation is forced.

Responses

Response samples

Content type
application/json
{
  • "paymentMoral": "1",
  • "lastCalculated": "2021-03-29T12:53:52.196+02:00",
  • "soonestDocumentDueDate": "2021-03-30T00:00:00.000+02:00"
}

Documents

Documents related APIs.

Create Corrective Tax Doc

Creates Document of type 'Corrective Tax Document'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
string <= 60 characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

parentDocumentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Parent Document.

reason
required
string [ 1 .. 255 ] characters

Reason of Corrective Tax Document as configured in external Product Catalogue.

required
Array of objects (DocumentLine)

Array of document lines (product code, product name, UoM, ...).

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentSource": "crm",
  • "documentType": "correctiveTax",
  • "documentCode": "correctiveTax",
  • "documentName": "Corrective Tax",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "documentLines": [
    ],
  • "parentDocumentRefId": "nPqk4LXC31HKgy",
  • "reason": "Wrong invoice"
}

Response samples

Content type
application/json
{
  • "refId": "nPcWeWsTwBCBPa",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "cb557686-547d-455d-a3c8-ed3f702d7105",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "correctiveTax",
  • "documentName": "Corrective Tax",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330578512,
  • "totalAmountNet": 400000000,
  • "totalAmountTax": 69421488,
  • "totalInvoiced": 400000000,
  • "roundingCompensation": 0,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:53:31.667+01:00",
  • "documentCreatedBy": "usr01",
  • "documentLines": [
    ]
}

Create Deposit

Creates Document of type 'Deposit Requested'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
string <= 60 characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

amount
required
integer <int64>

Amount of the Document. Including or Excluding Tax depends on 'taxIncluded' attribute.

taxIncluded
boolean

Indicates whether amount is inclusive Tax.

tax
required
string [ 1 .. 60 ] characters

Code of Tax. REF to 'Tax.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentSource": "crm",
  • "documentType": "deposit",
  • "documentCode": "deposit",
  • "documentName": "Deposit",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "amount": 200003456,
  • "taxIncluded": true,
  • "tax": "S_VAT"
}

Response samples

Content type
application/json
{
  • "refId": "nPSTt1mdmm0ssQ",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "242d242d-be27-47ee-8073-b6416d626172",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "deposit",
  • "documentName": "Deposit",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 165292112,
  • "totalAmountNet": 200003456,
  • "totalAmountTax": 34711344,
  • "totalInvoiced": 200000000,
  • "roundingCompensation": -3456,
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:55:26.946+01:00",
  • "documentCreatedBy": "usr01"
}

Create Generic Invoice

Creates Document of type 'Generic Invoice'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
string <= 60 characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
Array of objects (DocumentLine)

Array of document lines (product code, product name, UoM, ...).

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentSource": "crm",
  • "documentType": "genericInvoice",
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "documentLines": [
    ]
}

Response samples

Content type
application/json
{
  • "refId": "nPiVBg9f1m8XQL",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "38031ea2-2a5f-4326-a0af-f8abd4feaffd",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330991734,
  • "totalAmountNet": 400500000,
  • "totalAmountTax": 69508266,
  • "totalInvoiced": 401000000,
  • "roundingCompensation": 500000,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:58:59.845+01:00",
  • "documentCreatedBy": "usr01",
  • "documentLines": [
    ]
}

Create Proforma Invoice

Creates Document of type 'Pro-forma Invoice'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
string <= 60 characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

amount
required
integer <int64>

Amount of the Document. Including or Excluding Tax depends on 'taxIncluded' attribute.

taxIncluded
boolean

Indicates whether amount is inclusive Tax.

tax
required
string [ 1 .. 60 ] characters

Code of Tax. REF to 'Tax.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentSource": "crm",
  • "documentType": "proformaInvoice",
  • "documentCode": "proforma",
  • "documentName": "Pro-Forma Invoice",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "amount": 100300000,
  • "taxIncluded": true,
  • "tax": "S_VAT"
}

Response samples

Content type
application/json
{
  • "refId": "nPJI7Ckca7cWzP",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "b57ad037-9fbd-484c-89c7-2ad0f67f58ba",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "proforma",
  • "documentName": "Pro-Forma Invoice",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 82892561,
  • "totalAmountNet": 100300000,
  • "totalAmountTax": 17407439,
  • "totalInvoiced": 100000000,
  • "roundingCompensation": -300000,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T14:22:39.635+01:00",
  • "documentCreatedBy": "usr01"
}

Create Reciprocal Commitment

Creates Document of type 'Reciprocal Commitment'.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
string <= 60 characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

amount
required
integer <int64>

Amount of the Document. Including or Excluding Tax depends on 'taxIncluded' attribute.

taxIncluded
boolean

Indicates whether amount is inclusive Tax.

tax
required
string [ 1 .. 60 ] characters

Code of Tax. REF to 'Tax.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentSource": "crm",
  • "documentType": "reciprocalCommitment",
  • "documentCode": "reciprocalCommitment",
  • "documentName": "Reciprocal Commitment",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "amount": 351000000,
  • "taxIncluded": false,
  • "tax": "S_VAT"
}

Response samples

Content type
application/json
{
  • "refId": "nPvvRQjquNGRYU",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "99f5a79d-0586-4a7a-8f72-c3531467bbcf",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "reciprocalCommitment",
  • "documentName": "Reciprocal Commitment",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 351000000,
  • "totalAmountNet": 424710000,
  • "totalAmountTax": 73710000,
  • "totalInvoiced": 425000000,
  • "roundingCompensation": 290000,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T14:23:28.771+01:00",
  • "documentCreatedBy": "usr01"
}

Create Document of Any type

Creates Document of Any type.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentCategory
string (DocumentCategoryEnum)
Enum: "GENERIC_INVOICE" "OCS_INVOICE" "DEPOSIT" "CORRECTIVE_TAX_DOC" "PROFORMA_INVOICE" "RECIPROCAL_COMMITMENT"

Document Category values:

  • 'GENERIC_INVOICE' - Generic Invoice Document, usually created by external system, e.g. CRM.
  • 'OCS_INVOICE' - OCS Invoice Document, created by OCS.
  • 'DEPOSIT' - Deposit Document, usually created by external system, e.g. CRM.
  • 'CORRECTIVE_TAX_DOC' - Corrective Tax Document, usually created by external system, e.g. CRM.
  • 'PROFORMA_INVOICE' - Proforma Invoice Document, usually created by external system, e.g. CRM.
  • 'RECIPROCAL_COMMITMENT' - Reciprocal Commitment Document, usually created by external system, e.g. CRM.
documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
required
string [ 1 .. 60 ] characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

amount
required
integer <int64>

Amount of the Document. Including or Excluding Tax depends on 'taxIncluded' attribute.

taxIncluded
boolean

Indicates whether amount is inclusive Tax.

tax
required
string [ 1 .. 60 ] characters

Code of Tax. REF to 'Tax.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentCategory": "DEPOSIT",
  • "documentSource": "crm",
  • "documentType": "deposit",
  • "documentCode": "deposit",
  • "documentName": "Deposit",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "amount": 200003456,
  • "taxIncluded": true,
  • "tax": "S_VAT"
}

Response samples

Content type
application/json
{
  • "refId": "nPSTt1mdmm0ssQ",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "242d242d-be27-47ee-8073-b6416d626172",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "deposit",
  • "documentName": "Deposit",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 165292112,
  • "totalAmountNet": 200003456,
  • "totalAmountTax": 34711344,
  • "totalInvoiced": 200000000,
  • "roundingCompensation": -3456,
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:55:26.946+01:00",
  • "documentCreatedBy": "usr01"
}

Create Document with Lines of Any type

Creates Document With Lines of Any type.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

documentCategory
string (DocumentCategoryEnum)
Enum: "GENERIC_INVOICE" "OCS_INVOICE" "DEPOSIT" "CORRECTIVE_TAX_DOC" "PROFORMA_INVOICE" "RECIPROCAL_COMMITMENT"

Document Category values:

  • 'GENERIC_INVOICE' - Generic Invoice Document, usually created by external system, e.g. CRM.
  • 'OCS_INVOICE' - OCS Invoice Document, created by OCS.
  • 'DEPOSIT' - Deposit Document, usually created by external system, e.g. CRM.
  • 'CORRECTIVE_TAX_DOC' - Corrective Tax Document, usually created by external system, e.g. CRM.
  • 'PROFORMA_INVOICE' - Proforma Invoice Document, usually created by external system, e.g. CRM.
  • 'RECIPROCAL_COMMITMENT' - Reciprocal Commitment Document, usually created by external system, e.g. CRM.
documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentType
required
string [ 1 .. 60 ] characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentDueDate
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Override configured Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
string <= 60 characters

Override configured Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

previewMode
boolean

Indicates whether Document is created in 'Preview Mode'.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
Array of objects (DocumentLine)

Array of document lines (product code, product name, UoM, ...).

Responses

Request samples

Content type
application/json
{
  • "previewMode": false,
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentCategory": "GENERIC_INVOICE",
  • "documentSource": "crm",
  • "documentType": "genericInvoice",
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "currency": "EUR",
  • "documentLines": [
    ]
}

Response samples

Content type
application/json
{
  • "refId": "nPiVBg9f1m8XQL",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "38031ea2-2a5f-4326-a0af-f8abd4feaffd",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330991734,
  • "totalAmountNet": 400500000,
  • "totalAmountTax": 69508266,
  • "totalInvoiced": 401000000,
  • "roundingCompensation": 500000,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:58:59.845+01:00",
  • "documentCreatedBy": "usr01",
  • "documentLines": [
    ]
}

Assign Document Credit To Document

Assigns Document Credit to Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceDocumentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the source Document.

targetDocumentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the target Document.

amount
required
integer <int64>

Amount of the Assignment.

currency
required
string = 3 characters

Currency ISO Code of the Assignment. REF to 'Currency.code'.

notificationRequested
boolean

Indicates whether 'Credit assignment' Notification will be triggered.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Cancel Document Credit Assignment

Cancel Assignment between Document Credit and Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

monetaryTransactionRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Monetatry Transaction.

reason
required
string [ 1 .. 60 ] characters

Reason for Cancellation. REF to 'CancellationReason.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "monetaryTransactionRefId": "nPfKleixKNhlZS",
  • "reason": "dfltReason"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Cancel Document

Cancel Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentRefId
string <= 40 characters

ID (Ref ID) of the Document. Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

documentNo
string <= 80 characters

Number of the document (generated by RM module). Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

externalDocumentNo
string <= 80 characters

External number of the document (generated by external system, e.g. OCS or CRM). Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

reason
required
string [ 1 .. 60 ] characters

Reason for Cancellation. REF to 'CancellationReason.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentRefId": "nPr2ODiPrs7oMI",
  • "reason": "dfltReason"
}

Response samples

Content type
application/json
{
  • "refId": "nPr2ODiPrs7oMI",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "2d240a5d-4af4-444a-ab96-e1ef5aeea4d2",
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330578512,
  • "totalAmountNet": 400000000,
  • "totalAmountTax": 69421488,
  • "totalInvoiced": 330580000,
  • "vatExemption": false,
  • "paymentRef1": "ref1",
  • "paymentRef2": "ref2",
  • "paymentRef3": "ref3",
  • "documentCreatedDate": "2020-10-19T20:26:34.153+02:00",
  • "documentCreatedBy": "usr01",
  • "dueAmount": 400000000,
  • "dueAmountType": "AR",
  • "documentCancelledDate": "2020-10-19T20:26:44.612+02:00",
  • "documentCancelledBy": "usr01",
  • "cancellationReason": {
    }
}

Pay Document Online

Register OnLine Payment for Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentRefId
string <= 40 characters

ID (Ref ID) of the Document. Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

documentNo
string <= 80 characters

Number of the document (generated by RM module). Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

externalDocumentNo
string <= 80 characters

External number of the document (generated by external system, e.g. OCS or CRM). Either 'documentRefId', 'documentNo' or 'externalDocumentNo' must be populated.

paymentAmount
required
integer <int64>

Amount of the Payment.

currency
required
string = 3 characters

Currency ISO Code.

paymentDatePerformed
required
string <date-time>

Date/Time when OnLine Payment was performed.

paymentRef
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentRefId": "nPBHv1M4G1f2lS",
  • "paymentAmount": 400000000,
  • "currency": "EUR",
  • "paymentDatePerformed": "2020-10-03T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "channelType": "PaymentGateway",
  • "notificationRequested": true
}

Response samples

Content type
application/json
{
  • "refId": "nPaXgAZyFcYrAx",
  • "paymentType": "PROMISE_TO_PAY",
  • "paymentAmount": 400000000,
  • "currency": {
    },
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-03T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "channelType": "PaymentGateway",
  • "paymentCreatedDate": "2020-10-18T13:07:08.666+02:00",
  • "paymentCreatedBy": "usr01",
  • "usedAmount": 400000000,
  • "remainingAmount": 0,
  • "account": {
    },
  • "promisedPaymentDueDate": "2020-11-03T00:00:00.000+01:00"
}

Read Document

Reads Document.

Authorizations:
(appIdapiKey)
query Parameters
documentRefId
string

ID (Ref ID) of the Document. Either 'documentRefId' or 'documentNo' must be provided.

documentNo
string

Number of the Document as generated by RM. Either 'documentRefId' or 'documentNo' must be provided.

Responses

Response samples

Content type
application/json
Example
{
  • "refId": "nPcWeWsTwBCBPa",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "cb557686-547d-455d-a3c8-ed3f702d7105",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "correctiveTax",
  • "documentName": "Corrective Tax",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330578512,
  • "totalAmountNet": 400000000,
  • "totalAmountTax": 69421488,
  • "totalInvoiced": 400000000,
  • "roundingCompensation": 0,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:53:31.667+01:00",
  • "documentCreatedBy": "usr01",
  • "documentLines": [
    ]
}

Payments

Payments related APIs.

Assign Incoming Payment To Document

Assigns Identified Incoming Payment to Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Incoming Payment.

documentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Document.

amount
required
integer <int64>

Amount of the Assignment.

currency
required
string = 3 characters

Currency ISO Code of the Assignment. REF to 'Currency.code'.

notificationRequested
boolean

Indicates whether 'Payment Received' Notification will be triggered.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "documentRefId": "nPfmbEeLjQWcJ8",
  • "paymentRefId": "nPjicCoQHAB8OU",
  • "amount": 400000000,
  • "currency": "EUR"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Cancel Incoming Payment Assignment

Cancel Assignment between Identified Incoming Payment and Document.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

monetaryTransactionRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Monetatry Transaction.

reason
required
string [ 1 .. 60 ] characters

Reason for Cancellation. REF to 'CancellationReason.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "monetaryTransactionRefId": "nPfKleixKNhlZS",
  • "reason": "dfltReason"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Cancel Incoming Payment Identification

Cancel Identification of Identified Incoming Payment to Account.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Incoming Payment.

reason
required
string [ 1 .. 60 ] characters

Reason for Cancellation. REF to 'CancellationReason.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentRefId": "nPbxEafDewMBcu",
  • "reason": "dfltReason"
}

Response samples

Content type
application/json
{
  • "refId": "nPbxEafDewMBcu",
  • "paymentType": "IN",
  • "paymentAmount": 400000000,
  • "currency": {
    },
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-01T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "recipientNote": "Recipient Note",
  • "payerNote": "Payer Note",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentCreatedDate": "2020-10-19T15:18:01.863+02:00",
  • "paymentCreatedBy": "usr01",
  • "usedAmount": 0,
  • "remainingAmount": 400000000
}

Create Outgoing Payment By Incoming Payment

Creates Outgoing Payment according to Incoming Payment.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

paymentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Incoming Payment.

description
string <= 50 characters

Provider's Description of the Payment.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "paymentRefId": "nPuqsJTrlqfZQn",
  • "description": "Transaction Desc"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create Outgoing Payment From Document Credit

Creates Outgoing Payment from Credit Document(s).

Validations

Either 'bankAccountNumber'/'bankNumberCode' or 'iban'/'bic' must be provided.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMethod
string <= 60 characters

Payment Method associated with the Outgoing Payment.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string [ 1 .. 10 ] characters

Payer's (Billing Account) bank number code.

iban
string [ 1 .. 50 ] characters

Payer's (Billing Account) bank account number in international format.

bic
string [ 1 .. 30 ] characters

BIC code of bank.

bankAccountName
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account name.

object (MoneyOrder)

Person and Address details for Payment of type Money Order

description
string <= 50 characters

Provider's Description of the Payment. Will be copied to Payer's NOTE of the payment transaction.

required
object (EntityAmount)

Type used for store pair of entity ID (e.g. Entity of type Document, Payment) and Amount.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentMethod": "bankTransfer",
  • "paymentRef1": "20200000000001",
  • "paymentRef2": "",
  • "paymentRef3": "0308",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "description": "Transaction Desc",
  • "documentAmounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create Outgoing Payment From Incoming Payment

Creates Outgoing Payment from Incoming Payment(s).

Validations

Either 'bankAccountNumber'/'bankNumberCode' or 'iban'/'bic' must be provided.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMethod
string <= 60 characters

Payment Method associated with the Outoing Payment.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string [ 1 .. 10 ] characters

Payer's (Billing Account) bank number code.

iban
string [ 1 .. 50 ] characters

Payer's (Billing Account) bank account number in international format.

bic
string [ 1 .. 30 ] characters

BIC code of bank.

bankAccountName
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account name.

object (MoneyOrder)

Person and Address details for Payment of type Money Order

description
string <= 50 characters

Provider's Description of the Payment. Will be copied to Payer's NOTE of the payment transaction.

required
object (EntityAmount)

Type used for store pair of entity ID (e.g. Entity of type Document, Payment) and Amount.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentMethod": "bankTransfer",
  • "paymentRef1": "20200000000001",
  • "paymentRef2": "",
  • "paymentRef3": "0308",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "description": "Transaction Desc",
  • "paymentAmounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Identify Incoming Payment

Sets Incoming Payment as identified to Account.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Incoming Payment.

notificationRequested
boolean

Indicates whether 'Payment Received' Notification will be triggered.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentRefId": "nPGaSnhaECnX02",
  • "notificationRequested": false
}

Response samples

Content type
application/json
{
  • "refId": "nPGaSnhaECnX02",
  • "paymentType": "IN",
  • "paymentAmount": 400000000,
  • "currency": {
    },
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-01T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "recipientNote": "Recipient Note",
  • "payerNote": "Payer Note",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentCreatedDate": "2020-10-18T17:02:30.506+02:00",
  • "paymentCreatedBy": "usr01",
  • "usedAmount": 0,
  • "remainingAmount": 400000000,
  • "account": {
    }
}

Register Payment

Registers Incoming / Outgoing Payment from external system, e.g. Payment Gateway.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

paymentType
required
string
Enum: "IN" "OUT" "PROMISE_TO_PAY"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
paymentAmount
required
integer <int64>

Amount of the Payment.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentMethod
string <= 60 characters

Payment Method associated with the Incoming / Outgoing Payment.

paymentDateReceived
string <date-time>

Date/Time when Payment was received on provider's bank account.

paymentDateSent
string <date-time>

Date/Time when Payment was sent from payer's bank account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string <= 30 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

iban
string <= 50 characters

Payer's (Billing Account) bank account number in international format.

bic
string <= 30 characters

Payer's (Billing Account) BIC code of the bank.

bankAccountName
string <= 50 characters

Payer's (Billing Account) bank account name.

recipientNote
string <= 255 characters

Recipient's note/description of the Payment.

payerNote
string <= 255 characters

Payer's note/decription of the Payment.

bankAccountTransactionId
string <= 80 characters

Unique identifier of transaction in the context of bank account.

bankAccountNumberProvider
string <= 30 characters

Provider's bank account number, including prefix, without bank number code.

bankNumberCodeProvider
string <= 10 characters

Provider's bank number code

ibanProvider
string <= 50 characters

Provider's bank account number in international format.

bicProvider
string <= 30 characters

Provider's BIC code of the bank.

bankAccountNameProvider
string <= 50 characters

Provider's bank account name.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

notificationRequested
boolean

Indicates whether 'Payment Received' Notification will be triggered.

edrFileLoader
string <= 60 characters

Foreign Key to EdrFileLoader processed the Payment.

edrFile
string <= 60 characters

Foreign Key to EdrFile where Payment was loaded from.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentType": "IN",
  • "paymentAmount": 400000000,
  • "currency": "EUR",
  • "paymentMethod": "bankTransfer",
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-01T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "recipientNote": "Recipient Note",
  • "payerNote": "Payer Note",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "notificationRequested": true
}

Response samples

Content type
application/json
{
  • "refId": "nPbxEafDewMBcu",
  • "paymentType": "IN",
  • "paymentAmount": 400000000,
  • "currency": {
    },
  • "paymentMethod": {
    },
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-01T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "recipientNote": "Recipient Note",
  • "payerNote": "Payer Note",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentCreatedDate": "2020-10-19T15:18:01.863+02:00",
  • "paymentCreatedBy": "usr01",
  • "usedAmount": 0,
  • "remainingAmount": 400000000,
  • "paymentIdentifiedDate": "2020-10-19T15:18:01.863+02:00",
  • "paymentIdentifiedBy": "usr01",
  • "account": {
    }
}

Cancel Payment

Cancel Payment.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentRefId
string <= 40 characters

ID (Ref ID) of the Payment. Either 'PaymentRefId', 'PaymentNo' or 'externalPaymentNo' must be populated.

paymentNo
string <= 80 characters

Number of the Payment (generated by RM module). Either 'PaymentRefId', 'PaymentNo' or 'externalPaymentNo' must be populated.

externalPaymentNo
string <= 80 characters

External number of the Payment (generated by external system, e.g. OCS or CRM). Either 'PaymentRefId', 'PaymentNo' or 'externalPaymentNo' must be populated.

reason
required
string [ 1 .. 60 ] characters

Reason for Cancellation. REF to 'CancellationReason.internalCode'.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentRefId": "nPr2ODiPrs7oMI",
  • "reason": "dfltReason"
}

Response samples

Content type
application/json
{ }

RM

RM related APIs (vary per Deployment).

Create Outgoing Payment From Incoming Payment Custom

Creates Outgoing Payment from Incoming Payment(s) with extended validations.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMethod
string <= 60 characters

Payment Method associated with the Outoing Payment.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string [ 1 .. 10 ] characters

Payer's (Billing Account) bank number code.

iban
string [ 1 .. 50 ] characters

Payer's (Billing Account) bank account number in international format.

bic
string [ 1 .. 30 ] characters

BIC code of bank.

bankAccountName
string [ 1 .. 80 ] characters

Payer's (Billing Account) bank account name.

object (MoneyOrder)

Person and Address details for Payment of type Money Order

description
string <= 50 characters

Provider's Description of the Payment. Will be copied to Payer's NOTE of the payment transaction.

required
object (EntityAmount)

Type used for store pair of entity ID (e.g. Entity of type Document, Payment) and Amount.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "usr01",
  • "account": {
    },
  • "paymentMethod": "bankTransfer",
  • "paymentRef1": "20200000000001",
  • "paymentRef2": "",
  • "paymentRef3": "0308",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "description": "Transaction Desc",
  • "paymentAmounts": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Platform

Platform Operations related APIs.

Invalidate Cache

Invalidates Cache of the Platform.

Authorizations:
(appIdapiKey)

Responses

Perform Cron Job

Performs defined Cron Job.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

cronJob
required
string [ 1 .. 60 ] characters

Code of the Cron Job. REF to 'CronJobCfg.internalCode'.

effectiveDate
string <date-time>

Effective Date/Time of the Cron Job.

executionForced
boolean

Indicates whether Cron Job Execution is forced even Job is disabled in configuration.

Responses

Request samples

Content type
application/json
{
  • "cronJob": "recurrent",
  • "effectiveDate": "2021-09-19T22:00:00.000+02:00",
  • "executionForced": true
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

RM

RM Operations related APIs.

Close Bill Cycle Run

Close Bill Cycle Run to enable further activities.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

billCycle
required
string [ 1 .. 60 ] characters

Code of the Bill Cycle. REF to 'BillCycle.internalCode'.

billCycleType
required
string (BillCycleTypeBaseEnum)
Enum: "PERIODICAL" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
required
string <date-time>

Start Date of the Billing Period (truncated to Day).

Responses

Request samples

Content type
application/json
{
  • "user": "usr01",
  • "billCycle": "mnt01",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2024-10-01"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Schedule Bill Cycle Run

Schedules Bill Cycle Run for all accounts belonging to the Bill Cycle.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

billCycle
required
string [ 1 .. 60 ] characters

Code of the Bill Cycle. REF to 'BillCycle.internalCode'.

billCycleType
required
string (BillCycleTypeBaseEnum)
Enum: "PERIODICAL" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
required
string <date-time>

Start Date of the Billing Period (truncated to Day).

Responses

Request samples

Content type
application/json
{
  • "user": "usr01",
  • "billCycle": "mnt01",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2024-10-01"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Perform Bill Cycle Run

Performs Bill Cycle Run in regular mode.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

billCycle
required
string [ 1 .. 60 ] characters

Code of the Bill Cycle. REF to 'BillCycle.internalCode'.

billCycleType
required
string (BillCycleTypeBaseEnum)
Enum: "PERIODICAL" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
required
string <date-time>

Start Date of the Billing Period (truncated to Day).

Responses

Request samples

Content type
application/json
{
  • "user": "usr01",
  • "billCycle": "mnt01",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2024-10-01"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Fix Bill Cycle Run

Fix errors in Bill Cycle Run.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

billCycle
required
string [ 1 .. 60 ] characters

Code of the Bill Cycle. REF to 'BillCycle.internalCode'.

billCycleType
required
string (BillCycleTypeBaseEnum)
Enum: "PERIODICAL" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
required
string <date-time>

Start Date of the Billing Period (truncated to Day).

Responses

Request samples

Content type
application/json
{
  • "user": "usr01",
  • "billCycle": "mnt01",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2024-10-01"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Finalize Bill Cycle Run

Finalize Bill Cycle Run.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

billCycle
required
string [ 1 .. 60 ] characters

Code of the Bill Cycle. REF to 'BillCycle.internalCode'.

billCycleType
required
string (BillCycleTypeBaseEnum)
Enum: "PERIODICAL" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStartDate
required
string <date-time>

Start Date of the Billing Period (truncated to Day).

Responses

Request samples

Content type
application/json
{
  • "user": "usr01",
  • "billCycle": "mnt01",
  • "billCycleType": "PERIODICAL",
  • "billingPeriodStartDate": "2024-10-01"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "seqno": 0,
  • "object": { },
  • "objectType": "string"
}

Integration

Integration Operations related APIs.

Re-Format Document

Triggers publishing of specified Document to Pub-Sub Endpoint. Used in case Document in target system should be re-formatted.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

documentRefId
string [ 0 .. 40 ] characters

ID (Ref ID) of the Document.

documentNo
string [ 0 .. 80 ] characters

Number of the document (generated by RM module).

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "documentNo": "1234567890"
}

RM

Migration (RM) related APIs.

Delete Chargeable Events - Migration

Deletes all Chargeable Events on Account. Align Recurrent cycles if required. Only for migration purposes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string <= 255 characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

recurrentCyclesAligned
boolean

Indicates whether Recurrent cycles are aligned.

alignmentDate
string <date-time>

Effective date till when Recurrent cycles are aligned..

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "migration",
  • "account": {
    },
  • "recurrentCyclesAligned": true,
  • "alignmentDate": "2024-01-01T00:00:00.000+01:00"
}

Create Document - Migration

Creating Document of type specified in DocumentType. Only for migration purposes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string <= 255 characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentType
required
string [ 1 .. 60 ] characters

Type of the Document. REF to 'DocumentType.internalCode'.

documentNo
required
string [ 1 .. 80 ] characters

Unique Number of the Document.

externalDocumentNo
string <= 80 characters

Unique External number of the Document.

documentSource
required
string [ 1 .. 60 ] characters

Source of the Document. REF to 'DocumentSource.internalCode'.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
required
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with TAX Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with TAX Exemption.

totalInvoiced
required
integer <int64>

Invoiced Amount of the Document, after rounding. This amount may consider other due documents / over-payments. This is the amount which is expected to be paid by Payer in order to settle all debts.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence

dueAmount
required
integer <int64>

Due amount of the account receivable or liability including Tax.

dueAmountType
required
string (DueAmountType)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
paymentMethod
required
string [ 1 .. 60 ] characters

Payment Method. REF to 'PaymentMethod.internalCode'.

deliveryMethod
required
string [ 1 .. 60 ] characters

Delivery Method. REF to 'DeliveryMethod.internalCode'.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

billCycle
string [ 1 .. 60 ] characters

Code of the Billing Cycle. Valid only for 'OCS Invoice' document.

billCycleType
string (BillCycleTypeEnum)
Enum: "PERIODICAL" "COMPOSITE" "INITIAL" "ADJUSTMENT" "FINAL"

Billing Cycle Types values:

  • 'PERIODICAL' - Periodical Billing Cycle, e.g. Weekly, Monthly. Could be defined as standalone or part of COMPOSITE Billing Cycle Type.
  • 'COMPOSITE' - Composite Billing Cycle, contains two ore more Billing Cycles (e.g. INITIAL + PERIODICAL + ADJUSTMENT).
  • 'INITIAL' - Initial Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'ADJUSTMENT' - Adjustment Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
  • 'FINAL' - Final Billing Cycle, part of COMPOSITE Billing Cycle Type, could not be standalone.
billingPeriodStart
string <date-time>

Billing Period Start Date. Valid only for 'OCS Invoice' document.

billingPeriodEnd
string <date-time>

Billing Period End Date. Valid only for 'OCS Invoice' document.

correctiveTaxDocumentReason
string <= 255 characters

Reason of corrective. Valid only for corrective tax document.

parentDocumentRefId
string <= 40 characters

Foreign Key to ParentDocument. Valid only for Corrective Tax document.

debtThresholdReached
boolean

Indicates whether Debt of the Document exceed threshold.

dueAmountPostponed
integer <int64>

Postponed due amount, populated when debtThresholdReached=False and dueAmount is postponed to future documents.

dueAmountPostponedTransferred
integer <int64>

Postponed due amount which was transferred to another document.

dueAmountPostponedTransferredToRefId
string <= 40 characters

Foreign Key to Document to which was dueAmountPostponed transferred.

documentPaidDate
string <date-time>

Date/Time when Document was paid (criteria when Document is considered as paid have been met).

documentCancelledDate
string <date-time>

Date/Time when Document was cancelled.

documentCancelledBy
string <= 80 characters

Identification of the user who cancelled this Document.

cancellationReason
string <= 60 characters

Cancellation Reason. REF to 'CancellationReason.internalCode'.

recordState
string (RecordStateEnum)
Enum: "ACTIVE" "ARCHIVE"

States of the record:

  • 'ACTIVE' - Record is Active, all operations are allowed.
  • 'ARCHIVE' - Record is Archived, no operations are allowed. Is or Will be moved to Archive partition.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "migration",
  • "account": {
    },
  • "documentType": "ocsInvoice",
  • "documentSource": "axfone",
  • "documentCode": "axfoneInvoice",
  • "documentName": "Axfone Invoice",
  • "documentNo": "99{{$timestamp}}",
  • "externalDocumentNo": "99{{$timestamp}}",
  • "documentDueDate": "2021-03-01T22:00:00.000+02:00",
  • "documentIssuedDate": "2021-01-01T22:00:00.000+02:00",
  • "documentTaxDate": "2021-02-01T22:00:00.000+02:00",
  • "paymentRef1": "0000001",
  • "paymentRef2": "0000002",
  • "paymentRef3": "0308",
  • "currency": "CZK",
  • "totalAmount": 100000000,
  • "totalAmountNet": 121000000,
  • "totalAmountTax": 21000000,
  • "totalInvoiced": 121000000,
  • "roundingCompensation": 0,
  • "dueAmount": 121000000,
  • "dueAmountType": "AR",
  • "paymentMethod": "bankTransfer",
  • "deliveryMethod": "ELE"
}

Response samples

Content type
application/json
{
  • "documentNo": "991624780966",
  • "externalDocumentNo": "991624780966",
  • "documentSourceRefId": "nP7f508eccf4264b15af6d03f7e426ac2f",
  • "documentTypeRefId": "nPJuOMoIKqQXDH",
  • "accountRefId": "nPurV06vkuc8zQ",
  • "payerRefId": "nPpOr3BGdbtEWm",
  • "documentCode": "axfoneInvoice",
  • "documentName": "Axfone Invoice",
  • "documentIssuedDate": "2021-01-01T21:00:00.000+01:00",
  • "documentTaxDate": "2021-02-01T21:00:00.000+01:00",
  • "currencyRefId": "nPndtq1S3D21Y0",
  • "totalAmount": 100000000,
  • "totalAmountNet": 121000000,
  • "totalAmountTax": 21000000,
  • "totalInvoiced": 121000000,
  • "roundingCompensation": 0,
  • "dueAmount": 121000000,
  • "dueAmountType": "AR",
  • "documentDueDate": "2021-03-01T21:00:00.000+01:00",
  • "paymentRef1": "0000001",
  • "paymentRef2": "0000002",
  • "paymentRef3": "0308",
  • "paymentMethodRefId": "nPNFrdyYRCKauO",
  • "deliveryMethodRefId": "nPV55Lshs7Wht4",
  • "documentCreatedDate": "2021-06-27T10:02:45.874+02:00",
  • "documentCreatedBy": "migration",
  • "documentStored": false,
  • "refId": "nPfcc0d387961d49b883fe15341c91e83f"
}

Create Document Items - Migration

Creating Document Items for migrated Document. Only for migration purposes.

Authorizations:
(appIdapiKey)
query Parameters
deleteChargeableEvents
boolean

Indicates whether all Chargeable Events are deleted prior creating of Document items.

alignRecurrentCycles
boolean

Indicates whether Recurrent cycles are aligned.

storeDocumentItems
boolean

Indicates whether Document Items are stored.

Request Body schema: application/json
required

Payload of the request

requestId
required
string <= 255 characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

documentRefId
string [ 1 .. 40 ] characters

Ref ID of the Document.

documentNo
string [ 1 .. 80 ] characters

Number of the Document.

object (OcsInvoiceLayout)

Document header layout, from this other layouts are inherited.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Create Payment - Migration

Creating Payment of type specified in PaymentType. Only for migration purposes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string <= 255 characters

Unique ID of the request.

requestDate
string <date-time>

Date/Time of the request. Set by system itself.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

paymentType
required
string (PaymentType)
Enum: "IN" "OUT" "PROMISE_TO_PAY" "PAYMENT_OUT_REQ"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment
paymentNo
required
string [ 1 .. 80 ] characters

Unique Number of the Payment.

externalPaymentNo
string <= 80 characters

Unique External number of the Payment.

paymentAmount
required
integer <int64>

Amount of the Payment.

currency
required
string = 3 characters

Currency ISO Code. REF to 'Currency.code'.

paymentDateReceived
string <date-time>

Date/Time when Payment was received on provider's bank account.

paymentDateSent
string <date-time>

Date/Time when Payment was sent from payer's bank account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string <= 30 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

iban
string <= 50 characters

Payer's (Billing Account) bank account number in international format.

bic
string <= 30 characters

BIC code of the bank.

bankAccountName
string <= 50 characters

Payer's (Billing Account) bank account name.

recipientNote
string <= 255 characters

Recipient's note/description of the Payment.

payerNote
string <= 255 characters

Payer's note/description of the Payment.

bankAccountTransactionId
string <= 80 characters

Identifier of transaction in the context of bank account.

bankAccountNumberProvider
string <= 30 characters

Provider's bank account number, including prefix, without bank number code.

bankNumberCodeProvider
string <= 10 characters

Payer's bank number code.

ibanProvider
string <= 50 characters

Provider's bank account number in international format.

bicProvider
string <= 30 characters

Provider's BIC code of the bank.

bankAccountNameProvider
string <= 50 characters

Provider's bank account name.

paymentIdentifiedDate
string <date-time>

Date/Time when Payment was lastly identified.

paymentIdentifiedBy
string <= 80 characters

Identification of the user who lastly identified the Payment.

paymentAssignedDate
string <date-time>

Date/Time when Payment was lastly assigned.

paymentAssignedBy
string <= 80 characters

Identification of the user who lastly assigned the Payment.

usedAmount
integer <int64>

Valid only for incoming payments, amount used in case of amount transactions.

remainingAmount
integer <int64>

Valid only for incoming payments, remaining amount of payment after using some amount in case of amount transactions.

paymentCancelledDate
string <date-time>

Date/Time when Payment was cancelled.

paymentCancelledBy
string <= 80 characters

Identification of the user who cancelled the Payment.

cancellationReason
string <= 60 characters

Cancellation Reason. REF to 'CancellationReason.internalCode'.

promisedPaymentRefId
string <= 40 characters

Foreign Key to Payment of PaymentType='PROMISE_TO_PAY' done via OnLine channels.

promisedPaymentDueDate
string <date-time>

Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'.

paymentOutRequestDueDate
string <date-time>

Date/Time Due of the Payment Out Request. Populated only for PaymentType='PAYMENT_OUT_REQ'.

recordState
string (RecordStateEnum)
Enum: "ACTIVE" "ARCHIVE"

States of the record:

  • 'ACTIVE' - Record is Active, all operations are allowed.
  • 'ARCHIVE' - Record is Archived, no operations are allowed. Is or Will be moved to Archive partition.
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "migration",
  • "account": {
    },
  • "paymentType": "IN",
  • "paymentNo": "88}{{$timestamp}}",
  • "externalPaymentNo": "88{{$timestamp}}",
  • "paymentAmount": 500000000,
  • "currency": "CZK",
  • "paymentDateReceived": "2020-12-04T13:10:20.000+02:00",
  • "paymentDateSent": "2020-12-02T22:00:00.000+02:00",
  • "paymentRef1": "20200000000001",
  • "paymentRef2": "",
  • "paymentRef3": "0308",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Miloš Havel",
  • "bankAccountNumberDirectDebit": "000123-456789",
  • "recipientNote": "",
  • "payerNote": "Payment for services",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentIdentifiedBy": "migration",
  • "paymentIdentifiedDate": "2020-12-04T13:10:20.000+02:00"
}

Response samples

Content type
application/json
{
  • "paymentNo": "88}1624780507",
  • "externalPaymentNo": "881624780507",
  • "paymentType": "IN",
  • "paymentAmount": 500000000,
  • "currencyRefId": "nPndtq1S3D21Y0",
  • "paymentDateReceived": "2020-12-04T12:10:20.000+01:00",
  • "paymentDateSent": "2020-12-02T21:00:00.000+01:00",
  • "paymentRef1": "20200000000001",
  • "paymentRef2": "",
  • "paymentRef3": "0308",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Miloš Havel",
  • "recipientNote": "",
  • "payerNote": "Payment for services",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentCreatedDate": "2021-06-27T09:55:06.891+02:00",
  • "paymentCreatedBy": "usr01",
  • "paymentIdentifiedDate": "2020-12-04T12:10:20.000+01:00",
  • "paymentIdentifiedBy": "migration",
  • "accountRefId": "nPurV06vkuc8zQ",
  • "remainingAmount": 500000000,
  • "refId": "nP9e61713b82374dbcbe88642f13c744d8"
}

Assign Document Credit To Document - Migration

Assigns Document Credit to Document. Only for migration purposes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceDocumentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the source Document.

targetDocumentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the target Document.

amount
required
integer <int64>

Amount of the Assignment.

currency
required
string = 3 characters

Currency ISO Code of the Assignment. REF to 'Currency.code'.

transactionCreatedDate
required
string <date-time>

Date/Time when Transaction was created.

recordState
string (RecordStateEnum)
Enum: "ACTIVE" "ARCHIVE"

States of the record:

  • 'ACTIVE' - Record is Active, all operations are allowed.
  • 'ARCHIVE' - Record is Archived, no operations are allowed. Is or Will be moved to Archive partition.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "migrate",
  • "account": {
    },
  • "sourceDocumentRefId": "{{documentCreditMigRefId}}",
  • "targetDocumentRefId": "{{documentMigRefId}}",
  • "amount": 200000000,
  • "currency": "CZK",
  • "transactionCreatedDate": "2020-12-04T13:10:20.000+02:00"
}

Response samples

Content type
application/json
{
  • "sourceDocumentRefId": "nP39b5314c5d844a5d83c1288565291fda",
  • "targetDocumentRefId": "nPfcc0d387961d49b883fe15341c91e83f",
  • "transactionAmount": 200000000,
  • "currencyRefId": "nPndtq1S3D21Y0",
  • "transactionCreatedDate": "2020-12-04T12:10:20.000+01:00",
  • "transactionCreatedBy": "migrate",
  • "refId": "nPcd1cf3303a5645c289d4e957e9e53813"
}

Assign Incoming Payment To Document - Migration

Assigns Identified Incoming Payment to Document. Only for migration purposes.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required

Payload of the request

requestId
required
string [ 1 .. 255 ] characters

Unique ID of the request.

transactionId
string <= 255 characters

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

user
required
string [ 1 .. 80 ] characters

Identification of the User performed the operation.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Incoming Payment.

documentRefId
required
string [ 1 .. 40 ] characters

ID (Ref ID) of the Document.

amount
required
integer <int64>

Amount of the Assignment.

currency
required
string = 3 characters

Currency ISO Code of the Assignment. REF to 'Currency.code'.

transactionCreatedDate
required
string <date-time>

Date/Time when Transaction was created.

recordState
string (RecordStateEnum)
Enum: "ACTIVE" "ARCHIVE"

States of the record:

  • 'ACTIVE' - Record is Active, all operations are allowed.
  • 'ARCHIVE' - Record is Archived, no operations are allowed. Is or Will be moved to Archive partition.

Responses

Request samples

Content type
application/json
{
  • "requestId": "{{$guid}}",
  • "user": "migration",
  • "account": {
    },
  • "documentRefId": "{{documentMigRefId}}",
  • "paymentRefId": "{{paymentMigRefId}}",
  • "amount": 50000000,
  • "currency": "CZK",
  • "transactionCreatedDate": "2020-12-04T13:10:20.000+02:00"
}

Response samples

Content type
application/json
{
  • "paymentRefId": "nP9e61713b82374dbcbe88642f13c744d8",
  • "documentRefId": "nP05e3aba6a235446990dc893da69976d4",
  • "transactionAmount": 50000000,
  • "currencyRefId": "nPndtq1S3D21Y0",
  • "transactionCreatedDate": "2020-12-04T12:10:20.000+01:00",
  • "transactionCreatedBy": "migration",
  • "refId": "nP16ae82169a704f5e808078f9c5ccdada"
}

CASM

CASM related Business Transactions published to Streaming Platform.

Publish Customer

Publishes event 'Customer created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Customer name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Customer.

Array of objects (AccountEx)

Accounts belonging to the Customer.

Responses

Request samples

Content type
application/json
{ }

Publish Account

Publishes event 'Account created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Account name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

object (AccountBillCycleEx)

Account's Current Billing Cycle.

object (AccountBillCycleEx)

Account's Current Billing Cycle.

Array of objects (AccountBillCycleEx)

History of the Account's Bill Cycles.

paymentResponsible
boolean

Indicates whether Account is Payment Responsible.

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

hasSubOrdinate
boolean

Indicates whether Account has Sub-Ordinate Account(s.)

subOrdinates
Array of strings

List of Sub-Ordinate Account's Ref IDs.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Account.

Array of objects (SubscriberEx)

Subscribers belonging to the Account.

Responses

Request samples

Content type
application/json
{ }

Publish Subscriber

Publishes event 'Subscriber created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Subscriber name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

primaryResourceValue
required
string [ 1 .. 255 ] characters

Primary Resource Value.

Array of objects (SubscriberResourceEx)

Resources assigned to Subscriber.

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Subscriber.

Responses

Request samples

Content type
application/json
{ }

Publish Subscriber Resource

Publishes event 'Subscriber Resource created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

resourceValue
required
string [ 1 .. 255 ] characters

Value of the Resource.

validFrom
required
string <date-time>

From when Resource is Valid.

validTo
string <date-time>

Till when Resource is valid.

Responses

Request samples

Content type
application/json
{ }

Publish Offer Subscription

Publishes event 'Offer Subscription created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

isTransient
boolean

Indicates whether Subscription is transient.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

Responses

Request samples

Content type
application/json
{ }

RM

RM related Business Transactions published to Streaming Platform.

Publish Payer

Publishes event 'Payer created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the AccountDetail.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

invoicingExcluded
boolean

Indicates whether Payer is excluded from Invoicing.

dueDateOffset
integer <int64>

Offset for calculation of Due Date of all Documents.

paymentMoral
integer <int64>

Payment moral of the Account, calculated in flowing period for last X months.

paymentMoralCalculated
string <date-time>

Last calculation of Payment moral for the Account.

bankAccountName
string <= 80 characters

Payer's (Billing Account) bank account name.

bankAccountNumber
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code.

iban
string <= 50 characters
bic
string <= 30 characters

BIC code of bank.

paymentRef1
string <= 30 characters

Payer's (Billing Account) Payment Reference No.1 in case Payment Reference No.1 is static.

paymentRef2
string <= 30 characters

Payer's (Billing Account) Payment Reference No.2 in case Payment Reference No.2 is static.

paymentRef3
string <= 30 characters

Payer's (Billing Account) Payment Reference No.3 in case Payment Reference No.3 is static.

bankAccountNumberDirectDebit
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebit
string <= 10 characters

Payer's (Billing Account) bank number code for Direct Debit.

bankAccountNumberDirectDebitProvider
string <= 80 characters

Provider's bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebitProvider
string <= 10 characters

Provider's bank number code for Direct Debit.

vatLiable
boolean

Indicates whether Payer is liable for VAT.

vatLiableValidFrom
string <date-time>

Date/Time from when Payer is liable for VAT.

vatLiableValidTo
string <date-time>

Date/Time till when Payer is liable for VAT.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

Responses

Request samples

Content type
application/json
{ }

Publish Document

Publishes event 'Document created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 60 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Amount of the Document, after rounding. This amount may consider other due documents / over-payments. This is the amount which is expected to be paid by Payer in order to settle all debts.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

paymentInfo
string (PaymentInfo)
Enum: "BANK_TRANSFER" "DIRECT_DEBIT" "POSTPONED" "DO_NOT_PAY"

Payment Info values:

  • 'BANK_TRANSFER' - Payment should be settled by Payer.
  • 'DIRECT_DEBIT' - Payment will be requested by Provider via Direct Debit, Card payment, etc.
  • 'POSTPONED' - Do not pay, Debt amount is postponed to future Documents.
  • 'DO_NOT_PAY' - Do not pay.
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

dueAmount
required
integer <int64>

Due amount of the account receivable or liability including Tax.

dueAmountType
required
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentPaidDate
string <date-time>

Date/Time when Document was paid (criteria when Document is considered as paid have been met).

object (BillCycleEx)

Billing Cycle including Billing Period start and end.

correctiveTaxDocumentReason
string <= 255 characters

Reason of corrective. Valid only for Corrective Tax document.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

parentDocumentRefId
string <= 40 characters

Foreign Key to ParentDocument. Valid only for Corrective Tax document.

documentCancelledDate
string <date-time>

Date/Time when Document was cancelled.

documentCancelledBy
string <= 80 characters

Identification of the user who cancelled this Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

cancellationAmount
integer <int64>

Cancellation amount of the account receivable or liability including Tax (= Due Amount at the time of Cancel).

Responses

Request samples

Content type
application/json
{
  • "refId": "nPtvbglRsmKV4E",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "840389f2-48a9-44e6-96b3-777a8ab4b693",
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "deposit",
  • "documentName": "Deposit",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 200000000,
  • "totalAmountNet": 242000000,
  • "totalAmountTax": 42000000,
  • "totalInvoiced": 200000000,
  • "roundingCompensation": 0,
  • "vatExemption": false,
  • "paymentRef1": "ref1",
  • "paymentRef2": "ref2",
  • "paymentRef3": "ref3",
  • "documentCreatedDate": "2020-10-09T00:05:51.838+02:00",
  • "documentCreatedBy": "usr01",
  • "dueAmount": 200000000,
  • "dueAmountType": "LIABILITY"
}

Publish Payment

Publishes event 'Payment registered/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Payment.

paymentNo
required
string [ 1 .. 80 ] characters

Number of the Payment (generated by RM module).

externalPaymentNo
string <= 80 characters

External number of the Payment (generated by external system, e.g. Bank or Payment Gateway).

paymentType
required
string (PaymentType)
Enum: "IN" "OUT" "PROMISE_TO_PAY" "PAYMENT_OUT_REQ"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

paymentAmount
required
integer <int64>

Amount of the Payment.

required
object (CurrencyEx)

Definition of the Currency.

paymentDateReceived
string <date-time>

Date/Time when Payment was received on provider's bank account. Valid only for incoming payments.

paymentDateSent
string <date-time>

Date/Time when Payment was sent from payer's bank account (Incoming) from provider's bank account (Outgoing).")

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string <= 30 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code.

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

iban
string <= 50 characters

Payer's (Billing Account) bank account number in international format.

bic
string <= 30 characters

Payer's (Billing Account) BIC code of the bank.

bankAccountName
string <= 50 characters

Payer's (Billing Account) bank account name.

object (MoneyOrder)

Person and Address details for Payment of type Money Order

recipientNote
string <= 255 characters

Recipient's note/description of the Payment. Valid only for incoming payments.

payerNote
string <= 255 characters

Payer's note/description of the Payment.

bankAccountNumberProvider
string <= 30 characters

Provider's bank account number, including prefix, without bank number code.

bankNumberCodeProvider
string <= 10 characters

Provider's bank number code.

ibanProvider
string <= 50 characters

Provider's bank account number in international format.

bicProvider
string <= 30 characters

Provider's BIC code of the bank.

bankAccountNameProvider
string <= 50 characters

Provider's bank account name.

paymentCreatedDate
required
string <date-time>

Date/Time when Payment was created.

paymentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who creates the Payment.

paymentIdentifiedDate
string <date-time>

Date/Time when Payment was lastly identified. Valid only for incoming payments.

paymentIdentifiedBy
string <= 80 characters

Identification of the user who lastly idenfifed the Payment. Valid only for incoming payments.

paymentAssignedDate
string <date-time>

Date/Time when Payment was lastly assigned.

paymentAssignedBy
string <= 80 characters

Identification of the user who lastly assigned the Payment.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

usedAmount
integer <int64>

Amount used in case of amount transactions.

remainingAmount
integer <int64>

Remaining amount of payment after using some amount in case of amount transactions.

paymentCancelledDate
string <date-time>

Date/Time when Payment was cancelled.

paymentCancelledBy
string <= 80 characters

Identification of the user who cancelled the Payment.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

cancellationAmount
integer <int64>

Cancellation amount (= Remaining Amount at the time of Cancel).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

promisedPaymentRefId
string <= 40 characters

Ref ID of the Promised Payment done via OnLine channels. Populated only for PaymentType='PROMISE_TO_PAY'.

promisedPaymentDueDate
string <date-time>

Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'.

Responses

Request samples

Content type
application/json
{
  • "refId": "nPRcMI4bnnZgJ3",
  • "paymentType": "IN",
  • "paymentAmount": 100000000,
  • "currency": {
    },
  • "paymentDateReceived": "2020-10-03T22:00:00.000+02:00",
  • "paymentDateSent": "2020-10-01T22:00:00.000+02:00",
  • "paymentRef1": "VS0001",
  • "paymentRef2": "SS0001",
  • "paymentRef3": "SIPO0001",
  • "bankAccountNumber": "000123-456789",
  • "bankNumberCode": "1234",
  • "channelType": "PaymentGateway",
  • "iban": "CZ1234000123456789",
  • "bic": "CZXXX",
  • "bankAccountName": "Bank Account Name",
  • "recipientNote": "Recipient Note",
  • "payerNote": "Payer Note",
  • "bankAccountTransactionId": "XXX-123-456-789-YYY",
  • "paymentCreatedDate": "2020-10-09T00:04:44.111+02:00",
  • "paymentCreatedBy": "usr01",
  • "account": {
    }
}

Publish Document Payments

Publishes event 'Payments paired/unapired to/from Document'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceEntity
required
string
Enum: "DOCUMENT_AR" "DOCUMENT_LIABILITY"

Source Entity (From).

  • 'DOCUMENT_AR' - Entity of type DocumentEx, used for Debt Documents (AR).
  • 'DOCUMENT_LIABILITY' - Entity of type DocumentEx, used for Credit Documents (LIABILITY).
targetEntity
required
string
Enum: "PAYMENT_IN" "PAYMENT_OUT"

Target Entity (To).

  • 'PAYMENT_IN' - Entity of type PaymentEx, used for Incoming payments.
  • 'PAYMENT_OUT' - Entity of type PaymentEx, used for Outgoing payments.
required
object (MonetaryTransactionEx)

Detail of Monetary Transaction.

Responses

Request samples

Content type
application/json
{
  • "refId": "nPpvXSzkxip8oU",
  • "account": {
    },
  • "sourceEntity": "DOCUMENT_AR",
  • "targetEntity": "PAYMENT_IN",
  • "monetaryTransaction": {
    }
}

Publish Payment Documents

Publishes event 'Documents paired/unpaired to/from Payment'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Payment.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceEntity
required
string
Enum: "PAYMENT_IN" "PAYMENT_OUT"

Source Entity (From).

  • 'PAYMENT_IN' - Entity of type PaymentEx, used for Incoming payments.
  • 'PAYMENT_OUT' - Entity of type PaymentEx, used for Outgoing payments.
targetEntity
required
string
Enum: "DOCUMENT_AR" "DOCUMENT_LIABILITY"

Target Entity (To).

  • 'DOCUMENT_AR' - Entity of type DocumentEx, used for Debt Documents (AR).
  • 'DOCUMENT_LIABILITY' - Entity of type DocumentEx, used for Credit Documents (LIABILITY).
required
object (MonetaryTransactionEx)

Detail of Monetary Transaction.

Responses

Request samples

Content type
application/json
{
  • "refId": "nPSFo5kOT1ohQ6",
  • "account": {
    },
  • "sourceEntity": "PAYMENT_IN",
  • "targetEntity": "DOCUMENT_AR",
  • "monetaryTransaction": {
    }
}

Publish Document Documents

Publishes event 'Documents paired/unapired to/from Document'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceEntity
required
string
Enum: "DOCUMENT_AR" "DOCUMENT_LIABILITY"

Source Entity (From).

  • 'DOCUMENT_AR' - Entity of type DocumentEx, used for Debt Documents (AR).
  • 'DOCUMENT_LIABILITY' - Entity of type DocumentEx, used for Credit Documents (LIABILITY).
targetEntity
required
string
Enum: "DOCUMENT_AR" "DOCUMENT_LIABILITY"

Target Entity (To).

  • 'DOCUMENT_AR' - Entity of type DocumentEx, used for Debt Documents (AR).
  • 'DOCUMENT_LIABILITY' - Entity of type DocumentEx, used for Credit Documents (LIABILITY).
required
object (MonetaryTransactionEx)

Detail of Monetary Transaction.

Responses

Request samples

Content type
application/json
{
  • "refId": "nPpvXSzkxip8oU",
  • "account": {
    },
  • "sourceEntity": "DOCUMENT_LIABILITY",
  • "targetEntity": "DOCUMENT_AR",
  • "monetaryTransaction": {
    }
}

Publish Payment Payments

Publishes event 'Payments paired/unpaired to/from Payment'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Payment.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceEntity
required
string
Enum: "PAYMENT_IN" "PAYMENT_OUT"

Source Entity (From).

  • 'PAYMENT_IN' - Entity of type PaymentEx, used for Incoming payments.
  • 'PAYMENT_OUT' - Entity of type PaymentEx, used for Outgoing payments.
targetEntity
required
string
Enum: "PAYMENT_IN" "PAYMENT_OUT"

Target Entity (To).

  • 'PAYMENT_IN' - Entity of type PaymentEx, used for Incoming payments.
  • 'PAYMENT_OUT' - Entity of type PaymentEx, used for Outgoing payments.
required
object (MonetaryTransactionEx)

Detail of Monetary Transaction.

Responses

Request samples

Content type
application/json
{
  • "refId": "nPSFo5kOT1ohQ6",
  • "account": {
    },
  • "sourceEntity": "PAYMENT_IN",
  • "targetEntity": "PAYMENT_OUT",
  • "monetaryTransaction": {
    }
}

Publish Payment History

Publishes event 'Payment History created/updated'.

Published events

operationType operationCode Description Reference
CREATED PAYMENT_IN_CREATED Published when Incoming Payment is created.
UPDATED PAYMENT_IN_UPDATED Published when Incoming Payment is updated.
UPDATED PAYMENT_IN_CANCELLED Published when Incoming Payment is cancelled.
UPDATED PAYMENT_IN_IDENTIFIED Published when Incoming Payment is identified.
UPDATED PAYMENT_IN_UNIDENTIFIED Published when Incoming Payment's Identification is removed.
UPDATED PAYMENT_IN_PAIRED_DOCUMENT Published when Incoming Payment is paired with Document. Document
UPDATED PROMISE_TO_PAY_PAIRED_DOCUMENT Published when Promise to Pay is paired with Document. Document
UPDATED PROMISE_TO_PAY_PAIRED_PAYMENT Published when Promise to Pay is paired with Incoming Payment.

NOTE: Event is published for each party (Promise to Pay & Incoming Payment).		 Incoming Payment
UPDATED PAYMENT_IN_UNPAIRED Published when Incoming Payment's pairing with Document is removed. Document
UPDATED PROMISE_TO_PAY_CANCELLED Published when Promise to Pay is cancelled.
CREATED PAYMENT_OUT_CREATED Published when Outgoing Payment is created.
UPDATED PAYMENT_OUT_UPDATED Published when Outgoing Payment is updated.
UPDATED PAYMENT_OUT_CANCELLED Published when Outgoing Payment is cancelled.
UPDATED PAYMENT_OUT_IDENTIFIED Published when Outgoing Payment is identified.
UPDATED PAYMENT_OUT_REQ_PAIRED Published when Outgoing Payment Request is paired with Outgoing Payment.

NOTE: Event is published for each party (Outgoing Payment Request & Outgoing Payment).		 Outgoing Payment
UPDATED PAYMENT_OUT_REQ_CANCELLED Published when Outgoing Payment Request is cancelled.
Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the PaymentHistory.

operationType
required
string (HistoryOperationType)
Enum: "CREATED" "UPDATED"

History Operation Types:

  • 'CREATED' - entry is Created
  • 'UPDATED' - entry is Updated
operationCode
required
string [ 1 .. 60 ] characters

Code of the Operation.

createdDate
required
string <date-time>

Date/Time when History Entry was created.

createdBy
required
string [ 1 .. 80 ] characters

Identification of the user who created the History Entry.

object

Parameters of the Operation as HashMap.

paymentType
required
string (PaymentType)
Enum: "IN" "OUT" "PROMISE_TO_PAY" "PAYMENT_OUT_REQ"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment
paymentRefId
required
string <= 40 characters

Payment Ref ID.

effectiveDate
string <date-time>

Effective Date/Time of the Operation.

refPaymentType
string (PaymentType)
Enum: "IN" "OUT" "PROMISE_TO_PAY" "PAYMENT_OUT_REQ"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment
refPaymentRefId
string <= 40 characters

Referenced Payment Ref ID.

refDocumentRefId
string <= 40 characters

Referenced Document Ref ID.

Responses

Request samples

Content type
application/json
{ }

Charging

Charging related Business Transactions published to Streaming Platform.

Publish Chargeable Event

Publishes event 'Chargeable Event created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

RefId of the Event.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

resource
string <= 255 characters

Resource made the Event.

chargeType
string (ChargeTypeEnum)
Enum: "CREDIT" "DEBIT" "DISCOUNT" "ADJUSTMENT" "REFUND" "STORNO"

Charge Types:

  • 'CREDIT' - Credit event
  • 'DEBIT' - Debit event
  • 'DISCOUNT' - Discount associated with Debit event
  • 'ADJUSTMENT' - Adjustment event associated with Debit event
  • 'REFUND' - Refund event associated with Debit Event
  • 'STORNO' - Debit event storno
chargingTaxIncluded
boolean

Indicates whether Charging was performed with Tax Included charges.

taxValue
integer <int64>

Tax Value applied.

proRateRatio
integer <int64>

In case of Pro-Rating, Ratio which was used. In 0.01%

proRateMode
string (ProRateModeEnum)
Enum: "SECOND" "DAY" "NOON" "CUSTOMER_FRIENDLY" "PROVIDER_FRIENDLY"

Pro-Rate Modes:

  • 'SECOND' - Second precision of calculation as Charged
  • 'DAY' - Period is calculated as Charged, when at least one second from a Day the Subscription was Active
  • 'NOON' - Period is calculated as Charted, when at least one second till Noon the Subscription was Active
  • 'CUSTOMER_FRIENDLY' - Period is calculated as Non-Charted, when at least one second from a Day the Subscription was Not Active
  • 'PROVIDER_FRIENDLY' - Period is calculated as Charted, when at least one second from a Day the Subscription was Active
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

eventEntry
required
string <date-time>

Timestamp when event was entered.

eventStart
required
string <date-time>

Start Timestamp of the event.

eventEnd
string <date-time>

End Timestamp of the event.

eventCount
required
integer <int64>

Events count.

volume
required
integer <int64>

Volume of the event as in the Charging Request.

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
eventTotalVolume
required
integer <int64>

Total Volume of the event after Charging completed.

eventTotalPrice
integer <int64>

Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Rounded to Currency precision and Rounding Level definition. Excluding Tax.

eventTotalPriceNet
integer <int64>

Sum of Total Price and Total Price Tax. Rounded to Currency precision and Rounding Level definition.

eventTotalPriceTax
integer <int64>

Tax part of the Total Price. Rounded to Currency precision and Rounding Level definition.

eventCataloguePrice
integer <int64>

Catalogue Price per Units and UoM. Excluding Tax.

eventCataloguePriceNet
integer <int64>

Catalogue Price per Units and UoM. Including Tax.

eventCataloguePricePerUnit
integer <int64>

Catalogue Price per Unit.

eventCataloguePricePerUnitUoM
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
ratedTotalVolume
integer <int64>

Total Volume after Rating.

ratedTotalPrice
integer <int64>

Total Price after Rating. Excluding Tax.

overrideUnitPrice
integer <int64>

Price passed to Charging Request which overrides Offer Price. Excluding Tax.

overrideUnitPriceNet
integer <int64>

Net Price passed to Charging Request which overrides Offer Price. Including Tax.

reservationId
string

ID of the Reservation in case ECUR or SCUR charging.

request
object

Request.

ratingResult
object

Rating Result.

Responses

Request samples

Content type
application/json
{ }

Publish Balance

Publishes event 'Balance Event created/updated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

Request Body schema: application/json
required

Payload of the request

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (BalanceDefEx)

Balance Definition

Array of objects (BalanceValueEx)

Balance instances

Responses

Request samples

Content type
application/json
{ }

RM

RM related Notifications published to Streaming Platform.

Notify Collection Start

Notifies event 'Collection for Account should be started'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'collectionStart'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'CollectionStartNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

dueAmount
required
integer <int64>

Sum of all Due amounts for the Account.

oldestDocumentDueDate
required
string <date-time>

Oldest Document Due date

Responses

Request samples

Content type
application/json
{ }

Notify Credit To Document Assignment

Notifies event 'Credit to Document Assignment'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'creditToDocumentAssignment'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'CreditToDocumentAssignmentNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

sourceDocumentNo
required
string [ 1 .. 80 ] characters

Number of the Source Document (Credit).

sourceDocumentExternalNo
string <= 80 characters

External number of the Source Document (Credit).

targetDocumentNo
required
string [ 1 .. 80 ] characters

Number of the Target Document (Debt).

targetDocumentExternalNo
string <= 80 characters

External number of the Target Document (Debt).

transactionAmount
required
integer <int64>

Amount of the Transaction.

required
object (CurrencyEx)

Definition of the Currency.

transactionCreatedDate
required
string <date-time>

Date/Time when Transaction was created.

Responses

Request samples

Content type
application/json
{ }

Notify Debit Request Created

Notifies event 'Debit Request Created'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'debitRequestCreated'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'DebitRequestCreatedNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentNo
required
string [ 1 .. 80 ] characters

Number of the document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the document (generated by external system, e.g. OCS).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (CurrencyEx)

Definition of the Currency.

amount
required
integer <int64>

Amount of the Debit Request

requestDueDate
required
string <date-time>

Due date of the due amount.

requestPlannedDate
string <date-time>

Date/Time when Debit Request is planned for processing.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

channelType
string <= 60 characters

Type of channel (e.g. card, direct debit, etc.).

bankAccountNumberDirectDebit
string <= 80 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code for Direct debit.

bankNumberCodeDirectDebit
string <= 10 characters

Payer's (Billing Account) bank number code for Direct Debit.

Responses

Request samples

Content type
application/json
{ }

Notify Document Created

Notifies event 'Document Created'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'documentCreated'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'DocumentCreatedNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentNo
required
string [ 1 .. 80 ] characters

Number of the document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the document (generated by external system, e.g. OCS).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (CurrencyEx)

Definition of the Currency.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Documen including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

dueAmountType
required
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentDueDate
required
string <date-time>

Due date of the Document.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

billingPeriodStart
string <date-time>

Billing Period Start Date. Only for OCS Invoice Document.

billingPeriodEnd
string <date-time>

Billing Period End Date. Only for OCS Invoice Document.

Responses

Request samples

Content type
application/json
{ }

Notify Document Open Balance Changed

Notifies event 'Open Balance on Document changed'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'documentOpenBalanceChanged'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'DocumentOpenBalanceChangedNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

documentNo
required
string [ 1 .. 80 ] characters

Number of the document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the document (generated by external system, e.g. OCS).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (CurrencyEx)

Definition of the Currency.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

dueAmount
required
integer <int64>

Due amount of the account receivable or liability.

dueAmountType
required
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentDueDate
required
string <date-time>

Due date of the Document.

Responses

Request samples

Content type
application/json
{ }

Notify Payment Moral Calculated

Notifies event 'Payment Moral calculated'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'paymentMoralCalculated'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'PaymentMoralCalculatedNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentMoral
required
string [ 1 .. 255 ] characters

Payment moral of the Account. Deployment specific interpretation.

paymentMoralCalculated
string <date-time>

Last calculation of Payment moral for the Account.

Responses

Request samples

Content type
application/json
{ }

Notify Payment Received

Notifies event 'Payment received'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'paymentReceived'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'PaymentReceivedNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentType
required
string
Value: "IN"

Payment Types:

  • 'IN' - Incoming Payment
paymentAmount
required
integer <int64>

Amount of the Payment.

required
object (CurrencyEx)

Definition of the Currency.

paymentDateReceived
required
string <date-time>

Date/Time when Payment was received on provider's bank account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

Responses

Request samples

Content type
application/json
{ }

Notify Payment Sent

Notifies event 'Payment sent'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-transaction-id
required
string

ID of the transaction.

x-ocs-io-notification-code
required
string

Code of the Notification - 'paymentSent'.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload - 'PaymentSentNotification'.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

paymentType
required
string
Value: "OUT"

Payment Types:

  • 'OUT' - Outgoing Payment
paymentAmount
required
integer <int64>

Amount of the Payment.

required
object (CurrencyEx)

Definition of the Currency.

paymentDateSent
string <date-time>

Date/Time when Payment was sent from provider's bank account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

Responses

Request samples

Content type
application/json
{ }

Charging

Charging related Notifications published to Streaming Platform.

Notify Balance First Event

Notifies event 'First Event on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

Responses

Request samples

Content type
application/json
{ }

Notify Balance Threshold No.1 Reached

Notifies event 'Threshold No.1 Reached on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

thresholdBalance
required
integer <int64>

Balance's defined threshold.

Responses

Request samples

Content type
application/json
{ }

Notify Balance Threshold No.2 Reached

Notifies event 'Threshold No.2 Reached on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

thresholdBalance
required
integer <int64>

Balance's defined threshold.

Responses

Request samples

Content type
application/json
{ }

Notify Balance Threshold No.3 Reached

Notifies event 'Threshold No.3 Reached on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

thresholdBalance
required
integer <int64>

Balance's defined threshold.

Responses

Request samples

Content type
application/json
{ }

Notify Balance Adjustment

Notifies event 'Adjustment on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

adjustedBalance
required
integer <int64>

Balance's Adjustment.

Responses

Request samples

Content type
application/json
{ }

Notify Balance Recurrence

Notifies event 'Recurrence on Balance'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

effectiveDate
required
string <date-time>

Effective Date/Time of the Notification.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
object (CurrencyEx)

Definition of the Currency.

grantedBalance
required
integer <int64>

Balance granted.

balanceDeducted
boolean

Indicates whether Balance is deducted to 0.

actualBalance
required
integer <int64>

Actual Balance.

validFrom
required
string <date-time>

Date/Time from when Balance Value is valid.

validTo
string <date-time>

Date/Time till when Balance is valid.

periodStart
required
string <date-time>

Start Date/Time of the Recurrence Period.

periodEnd
required
string <date-time>

End Date/Time of the Recurrence Period.

cycle
required
integer <int64>

SeqNo of the Cycle.

Responses

Request samples

Content type
application/json
{ }

Invoicing

Invoiding related Notifications published to Streaming Platform.

Notify Billing Cycle Start

Notifies event 'Billing Cycle Start'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

tbd
required
string

TBD.

Responses

Request samples

Content type
application/json
{ }

Notify Account Billing Start

Notifies event 'Account Billing Start'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

tbd
required
string

TBD.

Responses

Request samples

Content type
application/json
{ }

Notify Account Billing End

Notifies event 'Account Billing End'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

tbd
required
string

TBD.

Responses

Request samples

Content type
application/json
{ }

Notify Account Billing Failed

Notifies event 'Account Billing Failed'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

tbd
required
string

TBD.

Responses

Request samples

Content type
application/json
{ }

Notify Billing Cycle End

Notifies event 'Billing Cycle End'.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-notification-code
required
string

Code of the Notification.

x-ocs-io-notification-payload
required
string

Name (JAVA's Simple Name) of the Notification's Payload.

Request Body schema: application/json
required

Payload of the request

tbd
required
string

TBD.

Responses

Request samples

Content type
application/json
{ }

Document Layouts

Document Layouts published to Streaming Platform.

Publish Document to Formatter

Publishes Document for formatting.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

x-ocs-io-document-type
required
string

Type of the Document. Ref to DocumentType.internalCode

x-ocs-io-document-ref-id
required
string

Ref ID of the Document

x-ocs-io-document-no
required
string

Document Number (as internally created by RM module)

x-ocs-io-account-ref-id
required
string

Ref ID of the Account for which Document (excl. OCS Invoice) is created

x-ocs-io-account-external-id
required
string

External ID of the Account for which Document (excl. OCS Invoice) is created

Request Body schema: application/json
required

Payload of the request

One of
refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Total Amount of the Document, after rounding.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

Array of objects (TaxSummaryItemEx)

Items of Tax Summary for the Document.

dueAmountType
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
Array of objects (DocumentLineEx)

Lines of the Document.

Responses

Request samples

Content type
application/json
Example
{
  • "refId": "nPiVBg9f1m8XQL",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "38031ea2-2a5f-4326-a0af-f8abd4feaffd",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "genericInvoice",
  • "documentName": "Generic Invoice",
  • "documentIssuedDate": "2020-10-01T22:00:00.000+02:00",
  • "documentTaxDate": "2020-10-01T22:00:00.000+02:00",
  • "documentDueDate": "2020-10-01T22:00:00.000+02:00",
  • "totalAmount": 330991734,
  • "totalAmountNet": 400500000,
  • "totalAmountTax": 69508266,
  • "totalInvoiced": 401000000,
  • "roundingCompensation": 500000,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "80001",
  • "paymentRef2": "90002",
  • "paymentRef3": "0308",
  • "documentCreatedDate": "2020-11-09T13:58:59.845+01:00",
  • "documentCreatedBy": "usr01",
  • "documentLines": [
    ]
}

Publish OCS Invoice to Formatter - Control Group Run

Publishes OCS Invoice created during Control Group Run for formatting.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

x-ocs-io-cg-ref-id
required
string

Ref ID of the Control Group

x-ocs-io-cg-code
required
string

Code of the Control Group

x-ocs-io-cg-run-ref-id
required
string

Ref ID of the Control Group Run

x-ocs-io-bc-ref-id
required
string

Ref ID of the Bill Cycle

x-ocs-io-bc-code
required
string

Code of the Bill Cycle

x-ocs-io-bc-type
required
string

Type of the Bill Cycle (INITIAL, PERIODICAL, ADJUSTMENT, FINAL)

x-ocs-io-account-ref-id
required
string

Ref ID of the Account for which Control OCS Invoice is created

x-ocs-io-account-external-id
string

External ID of the Account for which Control OCS Invoice is created

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Total Amount of the Document, after rounding.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

Array of objects (TaxSummaryItemEx)

Items of Tax Summary for the Document.

dueAmountType
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

required
object (BillCycleEx)

Billing Cycle including Billing Period start and end.

object (ControlGroupEx)

Control Group. Applicable only for generating of Control Group OCS Invoice.

Array of objects (InvoicePageIndexEntryEx)

Index of Invoice Pages.

Array of objects (InvoicePageEx)

All Invoice Pages.

Array of objects (ChargingEventEx)

All events (if applicable.)

Array of objects (RelatedDocumentEx)

Related AR Documents, list of AR / Liability documents matching defined criteria.

Array of objects (RelatedPaymentEx)

Related AR Payments matching defined criteria.

extension
object

Placeholder for Deployment specific extension.

Responses

Request samples

Content type
application/json
{
  • "refId": "0",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "ec5a40ee-090a-4eb0-9823-3380f98b5771",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "pdf",
  • "documentName": "PDF",
  • "documentIssuedDate": "2020-10-29T16:54:46.150+01:00",
  • "documentTaxDate": "2020-10-29T16:54:46.150+01:00",
  • "documentDueDate": "2020-10-29T16:54:46.150+01:00",
  • "totalAmount": 333744627,
  • "totalAmountNet": 403831000,
  • "totalAmountTax": 70086373,
  • "totalInvoiced": 403831000,
  • "roundingCompensation": 0,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "ref1",
  • "paymentRef2": "ref2",
  • "paymentRef3": "ref3",
  • "documentCreatedDate": "2020-10-29T16:54:47.787+01:00",
  • "documentCreatedBy": "usr01",
  • "billCycle": {
    },
  • "accounts": {
    },
  • "subscribers": { },
  • "offerSubscriptions": {
    },
  • "invoiceTotalSectionsCount": 3,
  • "invoiceTotalSections": [
    ],
  • "_entities": {
    }
}

Publish OCS Invoice to Formatter - Bill Run

Publishes OCS Invoice created during regular Bill Run for formatting.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

x-ocs-io-bc-ref-id
required
string

Ref ID of the Bill Cycle

x-ocs-io-bc-code
required
string

Code of the Bill Cycle

x-ocs-io-bc-type
required
string

Type of the Bill Cycle (INITIAL, PERIODICAL, ADJUSTMENT, FINAL)

x-ocs-io-bc-run-ref-id
required
string

Ref ID of the Bill Cycle Run

x-ocs-io-account-ref-id
required
string

Ref ID of the Account for which Regular OCS Invoice is created

x-ocs-io-account-external-id
string

External ID of the Account for which Regular OCS Invoice is created

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Total Amount of the Document, after rounding.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

Array of objects (TaxSummaryItemEx)

Items of Tax Summary for the Document.

dueAmountType
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

required
object (BillCycleEx)

Billing Cycle including Billing Period start and end.

object (ControlGroupEx)

Control Group. Applicable only for generating of Control Group OCS Invoice.

Array of objects (InvoicePageIndexEntryEx)

Index of Invoice Pages.

Array of objects (InvoicePageEx)

All Invoice Pages.

Array of objects (ChargingEventEx)

All events (if applicable.)

Array of objects (RelatedDocumentEx)

Related AR Documents, list of AR / Liability documents matching defined criteria.

Array of objects (RelatedPaymentEx)

Related AR Payments matching defined criteria.

extension
object

Placeholder for Deployment specific extension.

Responses

Request samples

Content type
application/json
{
  • "refId": "0",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "ec5a40ee-090a-4eb0-9823-3380f98b5771",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "pdf",
  • "documentName": "PDF",
  • "documentIssuedDate": "2020-10-29T16:54:46.150+01:00",
  • "documentTaxDate": "2020-10-29T16:54:46.150+01:00",
  • "documentDueDate": "2020-10-29T16:54:46.150+01:00",
  • "totalAmount": 333744627,
  • "totalAmountNet": 403831000,
  • "totalAmountTax": 70086373,
  • "totalInvoiced": 403831000,
  • "roundingCompensation": 0,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "ref1",
  • "paymentRef2": "ref2",
  • "paymentRef3": "ref3",
  • "documentCreatedDate": "2020-10-29T16:54:47.787+01:00",
  • "documentCreatedBy": "usr01",
  • "billCycle": {
    },
  • "accounts": {
    },
  • "subscribers": { },
  • "offerSubscriptions": {
    },
  • "invoiceTotalSectionsCount": 3,
  • "invoiceTotalSections": [
    ],
  • "_entities": {
    }
}

Publish OCS Invoice to Formatter - On-Demand

Publishes OCS Invoice created as result of On-Demand request for formatting.

Authorizations:
(appIdapiKey)
header Parameters
x-ocs-io-message-code
required
string

Code of the Pub-Sub message

x-ocs-io-message-payload
required
string

Name (JAVA's Simple Name) of the Message's Payload

x-ocs-io-bc-ref-id
required
string

Ref ID of the Bill Cycle

x-ocs-io-bc-code
required
string

Code of the Bill Cycle

x-ocs-io-bc-type
required
string

Type of the Bill Cycle (INITIAL, PERIODICAL, ADJUSTMENT, FINAL)

x-ocs-io-bc-run-ref-id
required
string

Ref ID of the Bill Cycle Run

x-ocs-io-account-ref-id
required
string

Ref ID of the Account for which On-Demand OCS Invoice is created

x-ocs-io-account-external-id
string

External ID of the Account for which On-Demand OCS Invoice is created

Request Body schema: application/json
required

Payload of the request

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. OCS or CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 80 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Total Amount of the Document, after rounding.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

Array of objects (TaxSummaryItemEx)

Items of Tax Summary for the Document.

dueAmountType
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

required
object (BillCycleEx)

Billing Cycle including Billing Period start and end.

object (ControlGroupEx)

Control Group. Applicable only for generating of Control Group OCS Invoice.

Array of objects (InvoicePageIndexEntryEx)

Index of Invoice Pages.

Array of objects (InvoicePageEx)

All Invoice Pages.

Array of objects (ChargingEventEx)

All events (if applicable.)

Array of objects (RelatedDocumentEx)

Related AR Documents, list of AR / Liability documents matching defined criteria.

Array of objects (RelatedPaymentEx)

Related AR Payments matching defined criteria.

extension
object

Placeholder for Deployment specific extension.

Responses

Request samples

Content type
application/json
{
  • "refId": "0",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "ec5a40ee-090a-4eb0-9823-3380f98b5771",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "pdf",
  • "documentName": "PDF",
  • "documentIssuedDate": "2020-10-29T16:54:46.150+01:00",
  • "documentTaxDate": "2020-10-29T16:54:46.150+01:00",
  • "documentDueDate": "2020-10-29T16:54:46.150+01:00",
  • "totalAmount": 333744627,
  • "totalAmountNet": 403831000,
  • "totalAmountTax": 70086373,
  • "totalInvoiced": 403831000,
  • "roundingCompensation": 0,
  • "taxSummary": [
    ],
  • "vatExemption": false,
  • "paymentRef1": "ref1",
  • "paymentRef2": "ref2",
  • "paymentRef3": "ref3",
  • "documentCreatedDate": "2020-10-29T16:54:47.787+01:00",
  • "documentCreatedBy": "usr01",
  • "billCycle": {
    },
  • "accounts": {
    },
  • "subscribers": { },
  • "offerSubscriptions": {
    },
  • "invoiceTotalSectionsCount": 3,
  • "invoiceTotalSections": [
    ],
  • "_entities": {
    }
}

CustomerEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Customer name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Customer.

Array of objects (AccountEx)

Accounts belonging to the Customer.

{
  • "refId": "string",
  • "externalId": "string",
  • "customerSegment": {
    },
  • "customName": "string",
  • "customAttributes": {
    },
  • "state": {
    },
  • "stateHistory": [
    ],
  • "offerSubscriptions": [
    ],
  • "accounts": [
    ]
}

AccountEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Account name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

object (AccountBillCycleEx)

Account's Current Billing Cycle.

object (AccountBillCycleEx)

Account's Current Billing Cycle.

Array of objects (AccountBillCycleEx)

History of the Account's Bill Cycles.

paymentResponsible
boolean

Indicates whether Account is Payment Responsible.

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

hasSubOrdinate
boolean

Indicates whether Account has Sub-Ordinate Account(s.)

subOrdinates
Array of strings

List of Sub-Ordinate Account's Ref IDs.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Account.

Array of objects (SubscriberEx)

Subscribers belonging to the Account.

{
  • "refId": "string",
  • "externalId": "string",
  • "accountType": {
    },
  • "accountSegment": {
    },
  • "customName": "string",
  • "customAttributes": {
    },
  • "billCycle": {
    },
  • "billCycleChangeTo": {
    },
  • "billCycleHistory": [
    ],
  • "paymentResponsible": true,
  • "state": {
    },
  • "stateHistory": [
    ],
  • "parentId": {
    },
  • "customer": {
    },
  • "hasSubOrdinate": true,
  • "subOrdinates": [
    ],
  • "paymentResponsibleId": {
    },
  • "offerSubscriptions": [
    ],
  • "subscribers": [
    ]
}

AccountInvEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Account name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

paymentResponsible
boolean

Indicates whether Account is Payment Responsible.

totalAmount
integer <int64>

Total Amount calculated on the Account level. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount calculated on the Account level including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount calculated on the Account level. Not present for Customers with VAT Exemption.

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryInvEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

subOrdinateAccountRefIds
Array of strings

List of Account's Sub-Ordinates Ref IDs.

subscriberRefIds
Array of strings

List of Account's Subscribers Ref IDs.

offerSubscriptionRefIds
Array of strings

List of Account's Offer Subscription Ref IDs.

invoiceSectionsCount
integer <int64>

Count of Invoice Sections.

Array of objects (InvoiceSectionEx)

Invoice Sections (if applicable.)

{
  • "refId": "string",
  • "externalId": "string",
  • "accountType": {
    },
  • "accountSegment": {
    },
  • "customName": "string",
  • "customAttributes": {
    },
  • "paymentResponsible": true,
  • "totalAmount": 0,
  • "totalAmountNet": 0,
  • "totalAmountTax": 0,
  • "state": {
    },
  • "stateHistory": [
    ],
  • "parentId": {
    },
  • "customer": {
    },
  • "subOrdinateAccountRefIds": [
    ],
  • "subscriberRefIds": [
    ],
  • "offerSubscriptionRefIds": [
    ],
  • "invoiceSectionsCount": 0,
  • "invoiceSections": [
    ]
}

SubscriberEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Subscriber name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

primaryResourceValue
required
string [ 1 .. 255 ] characters

Primary Resource Value.

Array of objects (SubscriberResourceEx)

Resources assigned to Subscriber.

Array of objects (OfferSubscriptionEx)

Offer Subscriptions assigned to Subscriber.

{
  • "refId": "string",
  • "externalId": "string",
  • "subscriberSegment": {
    },
  • "customName": "string",
  • "customAttributes": {
    },
  • "state": {
    },
  • "stateHistory": [
    ],
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "string",
  • "subscriberResources": [
    ],
  • "offerSubscriptions": [
    ]
}

SubscriberInvEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

customName
string <= 255 characters

Custom Subscriber name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

totalAmount
integer <int64>

Total Amount calculated on the Subscriber level. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount calculated on the Subscriber level including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount calculated on the Subscriber level. Not present for Customers with VAT Exemption.

required
object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryInvEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

primaryResourceValue
required
string [ 1 .. 255 ] characters

Primary Resource Value.

Array of objects (SubscriberResourceEx)

Resources assigned to Subscriber.

offerSubscriptionRefIds
Array of strings[ items [ 1 .. 40 ] characters ]

List of Account's Offer Subscription Ref IDs.

invoiceSectionsCount
integer <int64>

Count of Invoice Sections.

Array of objects (InvoiceSectionEx)

Invoice Sections (if applicable.)

{
  • "refId": "string",
  • "externalId": "string",
  • "subscriberSegment": {
    },
  • "customName": "string",
  • "customAttributes": {
    },
  • "totalAmount": 0,
  • "totalAmountNet": 0,
  • "totalAmountTax": 0,
  • "state": {
    },
  • "stateHistory": [
    ],
  • "account": {
    },
  • "primaryResourceType": {
    },
  • "primaryResourceValue": "string",
  • "subscriberResources": [
    ],
  • "offerSubscriptionRefIds": [
    ],
  • "invoiceSectionsCount": 0,
  • "invoiceSections": [
    ]
}

SubscriberResourceEx

refId
required
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

resourceValue
required
string [ 1 .. 255 ] characters

Value of the Resource.

validFrom
required
string <date-time>

From when Resource is Valid.

validTo
string <date-time>

Till when Resource is valid.

{
  • "refId": "string",
  • "externalId": "string",
  • "resourceType": {
    },
  • "resourceValue": "string",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z"
}

OfferSubscriptionEx

refId
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

isTransient
boolean

Indicates whether Subscription is transient.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

{
  • "refId": "string",
  • "externalId": "string",
  • "state": {
    },
  • "stateHistory": [
    ],
  • "offer": {
    },
  • "isTransient": true,
  • "customName": "string",
  • "customAttributes": {
    }
}

OfferSubscriptionInvEx

refId
string [ 1 .. 40 ] characters

Ref ID.

externalId
string <= 255 characters

External ID.

object (StateInfoEx)

Extension of the StateInfo entity which shall be used for Extraction purposes

Array of objects (StateHistoryInvEx)

History (array) of State changes per entity (Account, Subscriber, OfferSubscription) which shall be used for Extraction purposes.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

isTransient
boolean

Indicates whether Subscription is transient.

customName
string <= 255 characters

Custom Subscription name.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

hideOnInvoce
boolean

Indicates whether Offer Subscription is hidden on the Invoice (not printed.).

{
  • "refId": "string",
  • "externalId": "string",
  • "state": {
    },
  • "stateHistory": [
    ],
  • "offer": {
    },
  • "isTransient": true,
  • "customName": "string",
  • "customAttributes": {
    },
  • "hideOnInvoce": true
}

MonetaryTransactionEx

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Monetary Transaction.

sourceEntityRefIf
string [ 1 .. 40 ] characters

Source Entity (From) Ref ID.

targetEntityRefId
string [ 1 .. 40 ] characters

Target Entity (To) Ref ID.

transactionAmount
required
integer <int64>

Amount of the Transaction.

required
object (CurrencyEx)

Definition of the Currency.

transactionCreatedDate
required
string <date-time>

Date/Time when Transaction was created.

transactionCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created the Transaction.

transactionCancelled
boolean

Indicates whether Transaction is cancelled.

transactionCancelledDate
string <date-time>

Date/Time when Transaction was cancelled.

transactionCancelledBy
string [ 1 .. 80 ] characters

Identification of the user who cancelled the Transaction.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

{
  • "refId": "string",
  • "sourceEntityRefIf": "string",
  • "targetEntityRefId": "string",
  • "transactionAmount": 0,
  • "currency": {
    },
  • "transactionCreatedDate": "2019-08-24T14:15:22Z",
  • "transactionCreatedBy": "string",
  • "transactionCancelled": true,
  • "transactionCancelledDate": "2019-08-24T14:15:22Z",
  • "transactionCancelledBy": "string",
  • "cancellationReason": {
    }
}

DocumentEx

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Document.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

documentNo
required
string [ 1 .. 80 ] characters

Number of the Document (generated by RM module).

externalDocumentNo
string <= 80 characters

External number of the Document (generated by external system, e.g. CRM).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (CurrencyEx)

Definition of the Currency.

documentCode
required
string [ 1 .. 60 ] characters

Code of the Document as configured in external Product Catalogue.

documentName
required
string [ 1 .. 60 ] characters

Name of the Document as configured in external Product Catalogue.

documentIssuedDate
string <date-time>

Date when Document was issued.

documentTaxDate
required
string <date-time>

Tax performance date of the Document.

documentDueDate
required
string <date-time>

Due date of the Document.

recommendedPaymentDate
string <date-time>

Recommended Payment Date.

totalAmount
required
integer <int64>

Total Amount of the Document. Excluding Tax.

totalAmountNet
integer <int64>

Net Total Amount of the Document including Tax. Not present for Customers with VAT Exemption.

totalAmountTax
integer <int64>

Tax part of the Total Amount of the Document. Not present for Customers with VAT Exemption.

totalInvoiced
integer <int64>

Invoiced Amount of the Document, after rounding. This amount may consider other due documents / over-payments. This is the amount which is expected to be paid by Payer in order to settle all debts.

roundingCompensation
integer <int64>

Rounding Compensation, difference between Total Amount Net and Total Invoiced.

taxExemptionType
string (TaxExemptionTypeEnum)
Enum: "NONE" "ACCOUNT" "OFFER_TAX" "OTHER"

Tax Exemption Types:

  • 'NONE' - No Tax exemption
  • 'ACCOUNT' - Tax Exemption is set on Payment Responsible Account level
  • 'OFFER_TAX' - Invoice/Document contains at least one Tax which is marked as subject of Tax Exemption
  • 'OTHER' - Other reason for Tax Exemption
taxResidence
string <= 255 characters

Tax Residence of the Payment Responsible Account.

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Document.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Document.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

paymentInfo
string (PaymentInfo)
Enum: "BANK_TRANSFER" "DIRECT_DEBIT" "POSTPONED" "DO_NOT_PAY"

Payment Info values:

  • 'BANK_TRANSFER' - Payment should be settled by Payer.
  • 'DIRECT_DEBIT' - Payment will be requested by Provider via Direct Debit, Card payment, etc.
  • 'POSTPONED' - Do not pay, Debt amount is postponed to future Documents.
  • 'DO_NOT_PAY' - Do not pay.
documentCreatedDate
required
string <date-time>

Date/Time when Document was created.

documentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who created this Document.

dueAmount
required
integer <int64>

Due amount of the account receivable or liability including Tax.

dueAmountType
required
string (DueAmountTYpe)
Enum: "AR" "LIABILITY"

Due Amount Types:

  • 'AR' - Provider receives, Payer is liable
  • 'LIABILITY' - Provider is liable, Payer will receive
documentPaidDate
string <date-time>

Date/Time when Document was paid (criteria when Document is considered as paid have been met).

object (BillCycleEx)

Billing Cycle including Billing Period start and end.

correctiveTaxDocumentReason
string <= 255 characters

Reason of corrective. Valid only for Corrective Tax document.

object (CustomAttributes)

Custom attributes, Key - Value (String) Map

parentDocumentRefId
string <= 40 characters

Foreign Key to ParentDocument. Valid only for Corrective Tax document.

documentCancelledDate
string <date-time>

Date/Time when Document was cancelled.

documentCancelledBy
string <= 80 characters

Identification of the user who cancelled this Document.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

cancellationAmount
integer <int64>

Cancellation amount of the account receivable or liability including Tax (= Due Amount at the time of Cancel).

{
  • "refId": "string",
  • "documentSource": {
    },
  • "documentType": {
    },
  • "documentNo": "string",
  • "externalDocumentNo": "string",
  • "customer": {
    },
  • "account": {
    },
  • "currency": {
    },
  • "documentCode": "string",
  • "documentName": "string",
  • "documentIssuedDate": "2019-08-24T14:15:22Z",
  • "documentTaxDate": "2019-08-24T14:15:22Z",
  • "documentDueDate": "2019-08-24T14:15:22Z",
  • "recommendedPaymentDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "totalAmountNet": 0,
  • "totalAmountTax": 0,
  • "totalInvoiced": 0,
  • "roundingCompensation": 0,
  • "taxExemptionType": "NONE",
  • "taxResidence": "string",
  • "paymentRef1": "string",
  • "paymentRef2": "string",
  • "paymentRef3": "string",
  • "paymentMethod": {
    },
  • "deliveryMethod": {
    },
  • "paymentInfo": "BANK_TRANSFER",
  • "documentCreatedDate": "2019-08-24T14:15:22Z",
  • "documentCreatedBy": "string",
  • "dueAmount": 0,
  • "dueAmountType": "AR",
  • "documentPaidDate": "2019-08-24T14:15:22Z",
  • "billCycle": {
    },
  • "correctiveTaxDocumentReason": "string",
  • "customAttributes": {
    },
  • "parentDocumentRefId": "string",
  • "documentCancelledDate": "2019-08-24T14:15:22Z",
  • "documentCancelledBy": "string",
  • "cancellationReason": {
    },
  • "cancellationAmount": 0
}

PaymentEx

refId
required
string [ 1 .. 40 ] characters

Ref ID of the Payment.

paymentNo
required
string [ 1 .. 80 ] characters

Number of the Payment (generated by RM module).

externalPaymentNo
string <= 80 characters

External number of the Payment (generated by external system, e.g. Bank or Payment Gateway).

paymentType
required
string (PaymentType)
Enum: "IN" "OUT" "PROMISE_TO_PAY" "PAYMENT_OUT_REQ"

Payment Types:

  • 'IN' - Incoming Payment
  • 'OUT' - Outgoing Payment
  • 'PROMISE_TO_PAY' - Promised Incoming Payment, used for OnLine payments
  • 'PAYMENT_OUT_REQ' - Request for Outgoing Payment
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

paymentAmount
required
integer <int64>

Amount of the Payment.

required
object (CurrencyEx)

Definition of the Currency.

paymentDateReceived
string <date-time>

Date/Time when Payment was received on provider's bank account. Valid only for incoming payments.

paymentDateSent
string <date-time>

Date/Time when Payment was sent from payer's bank account (Incoming) from provider's bank account (Outgoing).")

paymentRef1
string <= 30 characters

Payment Reference No.1 associated with the Payment.

paymentRef2
string <= 30 characters

Payment Reference No.2 associated with the Payment.

paymentRef3
string <= 30 characters

Payment Reference No.3 associated with the Payment.

bankAccountNumber
string <= 30 characters

Payer's (Billing Account) bank account number, including prefix, without bank number code.

bankNumberCode
string <= 10 characters

Payer's (Billing Account) bank number code.

channelType
string <= 60 characters

Type of channel (e.g. card, bank transfer, etc.).

iban
string <= 50 characters

Payer's (Billing Account) bank account number in international format.

bic
string <= 30 characters

Payer's (Billing Account) BIC code of the bank.

bankAccountName
string <= 50 characters

Payer's (Billing Account) bank account name.

object (MoneyOrder)

Person and Address details for Payment of type Money Order

recipientNote
string <= 255 characters

Recipient's note/description of the Payment. Valid only for incoming payments.

payerNote
string <= 255 characters

Payer's note/description of the Payment.

bankAccountNumberProvider
string <= 30 characters

Provider's bank account number, including prefix, without bank number code.

bankNumberCodeProvider
string <= 10 characters

Provider's bank number code.

ibanProvider
string <= 50 characters

Provider's bank account number in international format.

bicProvider
string <= 30 characters

Provider's BIC code of the bank.

bankAccountNameProvider
string <= 50 characters

Provider's bank account name.

paymentCreatedDate
required
string <date-time>

Date/Time when Payment was created.

paymentCreatedBy
required
string [ 1 .. 80 ] characters

Identification of the user who creates the Payment.

paymentIdentifiedDate
string <date-time>

Date/Time when Payment was lastly identified. Valid only for incoming payments.

paymentIdentifiedBy
string <= 80 characters

Identification of the user who lastly idenfifed the Payment. Valid only for incoming payments.

paymentAssignedDate
string <date-time>

Date/Time when Payment was lastly assigned.

paymentAssignedBy
string <= 80 characters

Identification of the user who lastly assigned the Payment.

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

usedAmount
integer <int64>

Amount used in case of amount transactions.

remainingAmount
integer <int64>

Remaining amount of payment after using some amount in case of amount transactions.

paymentCancelledDate
string <date-time>

Date/Time when Payment was cancelled.

paymentCancelledBy
string <= 80 characters

Identification of the user who cancelled the Payment.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

cancellationAmount
integer <int64>

Cancellation amount (= Remaining Amount at the time of Cancel).

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

promisedPaymentRefId
string <= 40 characters

Ref ID of the Promised Payment done via OnLine channels. Populated only for PaymentType='PROMISE_TO_PAY'.

promisedPaymentDueDate
string <date-time>

Date/Time Due of the Promised Payment. Populated only for PaymentType='PROMISE_TO_PAY'.

{
  • "refId": "string",
  • "paymentNo": "string",
  • "externalPaymentNo": "string",
  • "paymentType": "IN",
  • "paymentMethod": {
    },
  • "paymentAmount": 0,
  • "currency": {
    },
  • "paymentDateReceived": "2019-08-24T14:15:22Z",
  • "paymentDateSent": "2019-08-24T14:15:22Z",
  • "paymentRef1": "string",
  • "paymentRef2": "string",
  • "paymentRef3": "string",
  • "bankAccountNumber": "string",
  • "bankNumberCode": "string",
  • "channelType": "string",
  • "iban": "string",
  • "bic": "string",
  • "bankAccountName": "string",
  • "moneyOrder": {
    },
  • "recipientNote": "string",
  • "payerNote": "string",
  • "bankAccountNumberProvider": "string",
  • "bankNumberCodeProvider": "string",
  • "ibanProvider": "string",
  • "bicProvider": "string",
  • "bankAccountNameProvider": "string",
  • "paymentCreatedDate": "2019-08-24T14:15:22Z",
  • "paymentCreatedBy": "string",
  • "paymentIdentifiedDate": "2019-08-24T14:15:22Z",
  • "paymentIdentifiedBy": "string",
  • "paymentAssignedDate": "2019-08-24T14:15:22Z",
  • "paymentAssignedBy": "string",
  • "account": {
    },
  • "usedAmount": 0,
  • "remainingAmount": 0,
  • "paymentCancelledDate": "2019-08-24T14:15:22Z",
  • "paymentCancelledBy": "string",
  • "cancellationReason": {
    },
  • "cancellationAmount": 0,
  • "edrFileLoader": {
    },
  • "edrFileExtractor": {
    },
  • "edrFile": {
    },
  • "promisedPaymentRefId": "string",
  • "promisedPaymentDueDate": "2019-08-24T14:15:22Z"
}

ChargingEventEx

refId
required
string [ 1 .. 40 ] characters

RefId of the Event.

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

object (IdType)

ID of the Entity. In the Request either refId or externalId is allowed to be populated. In the Response, both values are populated (in case External ID was provided).

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

required
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

resource
string <= 255 characters

Resource made the Event.

chargeType
string (ChargeTypeEnum)
Enum: "CREDIT" "DEBIT" "DISCOUNT" "ADJUSTMENT" "REFUND" "STORNO"

Charge Types:

  • 'CREDIT' - Credit event
  • 'DEBIT' - Debit event
  • 'DISCOUNT' - Discount associated with Debit event
  • 'ADJUSTMENT' - Adjustment event associated with Debit event
  • 'REFUND' - Refund event associated with Debit Event
  • 'STORNO' - Debit event storno
chargingTaxIncluded
boolean

Indicates whether Charging was performed with Tax Included charges.

taxValue
integer <int64>

Tax Value applied.

proRateRatio
integer <int64>

In case of Pro-Rating, Ratio which was used. In 0.01%

proRateMode
string (ProRateModeEnum)
Enum: "SECOND" "DAY" "NOON" "CUSTOMER_FRIENDLY" "PROVIDER_FRIENDLY"

Pro-Rate Modes:

  • 'SECOND' - Second precision of calculation as Charged
  • 'DAY' - Period is calculated as Charged, when at least one second from a Day the Subscription was Active
  • 'NOON' - Period is calculated as Charted, when at least one second till Noon the Subscription was Active
  • 'CUSTOMER_FRIENDLY' - Period is calculated as Non-Charted, when at least one second from a Day the Subscription was Not Active
  • 'PROVIDER_FRIENDLY' - Period is calculated as Charted, when at least one second from a Day the Subscription was Active
object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

object (EntityType)

ID of the Entity. RefId populated always, name only in case of EntityModel, internalCode (aka code) only in case of EntityCodeModel.

eventEntry
required
string <date-time>

Timestamp when event was entered.

eventStart
required
string <date-time>

Start Timestamp of the event.

eventEnd
string <date-time>

End Timestamp of the event.

eventCount
required
integer <int64>

Events count.

volume
required
integer <int64>

Volume of the event as in the Charging Request.

unitsOfMeasurement
required
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
eventTotalVolume
required
integer <int64>

Total Volume of the event after Charging completed.

eventTotalPrice
integer <int64>

Total Price of the event after Charging completed, incl. all discounts, promos, free units, etc. Rounded to Currency precision and Rounding Level definition. Excluding Tax.

eventTotalPriceNet
integer <int64>

Sum of Total Price and Total Price Tax. Rounded to Currency precision and Rounding Level definition.

eventTotalPriceTax
integer <int64>

Tax part of the Total Price. Rounded to Currency precision and Rounding Level definition.

eventCataloguePrice
integer <int64>

Catalogue Price per Units and UoM. Excluding Tax.

eventCataloguePriceNet
integer <int64>

Catalogue Price per Units and UoM. Including Tax.

eventCataloguePricePerUnit
integer <int64>

Catalogue Price per Unit.

eventCataloguePricePerUnitUoM
string (UnitsOfMeasurementEnum)
Enum: "EVENT" "SECOND" "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" "YEAR" "BYTE" "KILOBYTE" "MEGABYTE" "GIGABYTE" "TERABYTE" "MONEY" "PERCENT" "PERMILLE" "PCS" "UNIT" "WATT" "KILOWATT" "MEGAWATT" "GIGAWATT" "TERAWATT"

Units Of Measurement values:

  • 'EVENT' - UoM is Event.
  • 'SECOND' - UoM is Second.
  • 'MINUTE' - UoM is Minute.
  • 'HOUR' - UoM is Hour.
  • 'DAY' - UoM is Day.
  • 'WEEK' - UoM is Week.
  • 'MONTH' - UoM is Month.
  • 'YEAR' - UoM is Year.
  • 'BYTE' - UoM is Byte (B).
  • 'KILOBYTE' - UoM is KiloByte (KB).
  • 'MEGABYTE' - UoM is MegaByte (MB).
  • 'GIGABYTE' - UoM is GigaByte (GB).
  • 'TERABYTE' - UoM is TeraByte (TB).
  • 'MONEY' - UoM is Money.
  • 'PERCENT' - UoM is Percent.
  • 'PERMILLE' - UoM is Permille.
  • 'PCS' - UoM is Piece.
  • 'UNIT' - UoM is Unit.
  • 'WATT' - UoM is Watt.
  • 'KILOWATT' - UoM is Kilowatt (kW).
  • 'MEGAWATT' - UoM is Megawatt (MW).
  • 'GIGAWATT' - UoM is Gigawatt (GW).
  • 'TERAWATT' - UoM is Terawatt (TW).
ratedTotalVolume
integer <int64>

Total Volume after Rating.

ratedTotalPrice
integer <int64>

Total Price after Rating. Excluding Tax.

overrideUnitPrice
integer <int64>

Price passed to Charging Request which overrides Offer Price. Excluding Tax.

overrideUnitPriceNet
integer <int64>

Net Price passed to Charging Request which overrides Offer Price. Including Tax.

reservationId
string

ID of the Reservation in case ECUR or SCUR charging.

request
object

Request.

ratingResult
object

Rating Result.

{
  • "refId": "string",
  • "offerSubscription": {
    },
  • "customer": {
    },
  • "account": {
    },
  • "subscriber": {
    },
  • "offer": {
    },
  • "product": {
    },
  • "service": {
    },
  • "productService": {
    },
  • "offerValue": {
    },
  • "productValue": {
    },
  • "usageType": {
    },
  • "resourceType": {
    },
  • "resource": "string",
  • "chargeType": "CREDIT",
  • "chargingTaxIncluded": true,
  • "taxValue": 0,
  • "proRateRatio": 0,
  • "proRateMode": "SECOND",
  • "chargingClass": {
    },
  • "glCode": {
    },
  • "tax": {
    },
  • "taxValueDef": {
    },
  • "glCodeTax": {
    },
  • "currency": {
    },
  • "eventEntry": "2019-08-24T14:15:22Z",
  • "eventStart": "2019-08-24T14:15:22Z",
  • "eventEnd": "2019-08-24T14:15:22Z",
  • "eventCount": 0,
  • "volume": 0,
  • "unitsOfMeasurement": "EVENT",
  • "eventTotalVolume": 0,
  • "eventTotalPrice": 0,
  • "eventTotalPriceNet": 0,
  • "eventTotalPriceTax": 0,
  • "eventCataloguePrice": 0,
  • "eventCataloguePriceNet": 0,
  • "eventCataloguePricePerUnit": 0,
  • "eventCataloguePricePerUnitUoM": "EVENT",
  • "ratedTotalVolume": 0,
  • "ratedTotalPrice": 0,
  • "overrideUnitPrice": 0,
  • "overrideUnitPriceNet": 0,
  • "reservationId": "string",
  • "request": { },
  • "ratingResult": { }
}