API docs by Redocly

STAQR Commerce OpenAPI definition V1 (1.0)

Download OpenAPI specification:

E-mail: commerce@staqr.com License: STAQR Commerce Proprietary License Terms of Service

This Swagger documentation contains API v1 endpoints

Seller

List all sellers.

List all sellers.

Authorizations:
auth

Responses

Create seller.

Create seller.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

currencyCode
string
countryCode
string
languageCode
string
parentSeller
string
object (CustomersDto)
object (CustomFieldsDto)

The custom fields

object
object (BusinessEntityDto)
object (ContactInformationDto)

The contact information

object (AddressDto)
vatNo
string
registrationNo
string
legalText
string
legalType
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for seller with a given code.

Search for seller with a given code.

Authorizations:
auth
path Parameters
sellerCode
required
string
query Parameters
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

Responses

Response samples

Content type
{
}

Update seller.

Update seller.

Authorizations:
auth
path Parameters
sellerCode
required
string

Add the sellerCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

currencyCode
string
countryCode
string
languageCode
string
parentSeller
string
object (CustomersDto)
object (CustomFieldsDto)

The custom fields

object
object (BusinessEntityDto)
object (ContactInformationDto)

The contact information

object (AddressDto)
vatNo
string
registrationNo
string
legalText
string
legalType
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove seller with a given code.

Remove seller with a given code.

Authorizations:
auth
path Parameters
sellerCode
required
string

Responses

Response samples

Content type
{
}

BillingCycle

Search for list of billingCycles.

Search for list of billingCycles.

Authorizations:
auth

Responses

Create a new billing cycle.

Create a new billing cycle.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

billingTemplateName
string
billingTemplateNameEL
string [ 0 .. 2000 ] characters
invoiceDateDelay
integer <int32>
invoiceDateDelayEL
required
string [ 0 .. 2000 ] characters
dueDateDelay
integer <int32>
dueDateDelayEL
string [ 0 .. 2000 ] characters
invoiceDateProductionDelay
integer <int32>
invoiceDateProductionDelayEL
string [ 0 .. 2000 ] characters
lastTransactionDateDelayEL
string [ 0 .. 2000 ] characters
lastTransactionDateEL
string [ 0 .. 2000 ] characters
calendar
required
string
invoicingThreshold
number
splitPerPaymentMethod
boolean
invoiceTypeCode
string
invoiceTypeEl
string
object (CustomFieldsDto)

The custom fields

type
string
Enum: "BILLINGACCOUNT" "SUBSCRIPTION" "ORDER"
referenceDate
string
Enum: "TODAY" "NEXT_INVOICE_DATE" "LAST_TRANSACTION_DATE" "END_DATE"
scriptInstanceCode
string
checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"
collectionDateDelayEl
string
computeDatesAtValidation
boolean
thresholdPerEntity
boolean
billingRunValidationScriptCode
string
Array of objects (LanguageDescriptionDto)
lastTransactionDateDelay
integer <int32>
transactionDateDelayEL
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for billing cycle with a given code.

Search for billing cycle with a given code.

Authorizations:
auth
path Parameters
billingCycleCode
required
string

Responses

Response samples

Content type
{
}

Update an existing billing cycle.

Update an existing billing cycle.

Authorizations:
auth
path Parameters
billingCycleCode
required
string

Add the billingCycleCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

billingTemplateName
string
billingTemplateNameEL
string [ 0 .. 2000 ] characters
invoiceDateDelay
integer <int32>
invoiceDateDelayEL
required
string [ 0 .. 2000 ] characters
dueDateDelay
integer <int32>
dueDateDelayEL
string [ 0 .. 2000 ] characters
invoiceDateProductionDelay
integer <int32>
invoiceDateProductionDelayEL
string [ 0 .. 2000 ] characters
lastTransactionDateDelayEL
string [ 0 .. 2000 ] characters
lastTransactionDateEL
string [ 0 .. 2000 ] characters
calendar
required
string
invoicingThreshold
number
splitPerPaymentMethod
boolean
invoiceTypeCode
string
invoiceTypeEl
string
object (CustomFieldsDto)

The custom fields

type
string
Enum: "BILLINGACCOUNT" "SUBSCRIPTION" "ORDER"
referenceDate
string
Enum: "TODAY" "NEXT_INVOICE_DATE" "LAST_TRANSACTION_DATE" "END_DATE"
scriptInstanceCode
string
checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"
collectionDateDelayEl
string
computeDatesAtValidation
boolean
thresholdPerEntity
boolean
billingRunValidationScriptCode
string
Array of objects (LanguageDescriptionDto)
lastTransactionDateDelay
integer <int32>
transactionDateDelayEL
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing billing cycle with a given code.

Remove an existing billing cycle with a given code.

Authorizations:
auth
path Parameters
billingCycleCode
required
string

Responses

Response samples

Content type
{
}

InvoiceCategory

Search for list of invoice categories.

Search for list of invoice categories.

Authorizations:
auth

Responses

Create invoice category. Description per language can be defined

Create invoice category. Description per language can be defined

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
occTemplateCode
required
string
occTemplateNegativeCode
string
object (CustomFieldsDto)

The custom fields

sortIndex
integer <int32>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search invoice with a given code.

Search invoice with a given code.

Authorizations:
auth
path Parameters
invoiceCategoryCode
required
string

Responses

Response samples

Content type
{
}

Update invoice category.

Update invoice category.

Authorizations:
auth
path Parameters
invoiceCategoryCode
required
string

Add the invoiceCategoryCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
occTemplateCode
required
string
occTemplateNegativeCode
string
object (CustomFieldsDto)

The custom fields

sortIndex
integer <int32>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove invoice with a given code.

Remove invoice with a given code.

Authorizations:
auth
path Parameters
invoiceCategoryCode
required
string

Responses

Response samples

Content type
{
}

InvoiceSequence

List of invoiceSequence.

List of invoiceSequence.

Authorizations:
auth

Responses

Create invoiceSequence.

Create invoiceSequence.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

sequenceSize
integer <int32>
currentInvoiceNb
integer <int64>
sequencePattern
string
sequenceType
string
Enum: "RUM" "CUSTOMER_NO" "SEQUENCE" "NUMERIC" "ALPHA_UP" "UUID" "REGEXP"

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search invoiceSequence with a given code.

Search invoiceSequence with a given code.

Authorizations:
auth
path Parameters
invoiceSequenceCode
required
string

Responses

Response samples

Content type
{
}

Update invoiceSequence.

Update invoiceSequence.

Authorizations:
auth
path Parameters
invoiceSequenceCode
required
string

Add the invoiceSequenceCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

sequenceSize
integer <int32>
currentInvoiceNb
integer <int64>
sequencePattern
string
sequenceType
string
Enum: "RUM" "CUSTOMER_NO" "SEQUENCE" "NUMERIC" "ALPHA_UP" "UUID" "REGEXP"

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

InvoiceSubCategory

Search for list of invoiceSubCategories.

Search for list of invoiceSubCategories.

Authorizations:
auth

Responses

Create invoice sub category.

Create invoice sub category.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

invoiceCategory
required
string
accountingCode
required
string
Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

occTemplateCode
required
string
occTemplateNegativeCode
string
sortIndex
integer <int32>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for invoice sub category with a given code.

Search for invoice sub category with a given code.

Authorizations:
auth
path Parameters
invoiceSubCategoryCode
required
string

Responses

Response samples

Content type
{
}

Update invoice sub category.

Update invoice sub category.

Authorizations:
auth
path Parameters
invoiceSubCategoryCode
required
string

Add the invoiceSubCategoryCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

invoiceCategory
required
string
accountingCode
required
string
Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

occTemplateCode
required
string
occTemplateNegativeCode
string
sortIndex
integer <int32>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove invoice sub category with a given code.

Remove invoice sub category with a given code.

Authorizations:
auth
path Parameters
invoiceSubCategoryCode
required
string

Responses

Response samples

Content type
{
}

InvoiceType

List of invoiceType.

List of invoiceType.

Authorizations:
auth

Responses

Create invoiceType. Description per language can be defined

Create invoiceType. Description per language can be defined

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

occTemplateCode
required
string
occTemplateNegativeCode
string
occTemplateCodeEl
string
occTemplateNegativeCodeEl
string
customInvoiceXmlScriptInstanceCode
string
object (SequenceDto)
invoiceValidationScriptCode
string
object
appliesTo
Array of strings
matchingAuto
boolean
invoiceAccountable
boolean
billingTemplateName
string
pdfFilenameEL
string
xmlFilenameEL
string
billingTemplateNameEL
string
object (CustomFieldsDto)

The custom fields

useSelfSequence
boolean
mailingType
string
emailTemplateCode
string
excludeFromAgedTrialBalance
boolean

Exclude from Aged Trial Balance

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search invoiceType with a given code.

Search invoiceType with a given code.

Authorizations:
auth
path Parameters
invoiceTypeCode
required
string

Responses

Response samples

Content type
{
}

Update invoiceType. Description per language can be defined

Update invoiceType. Description per language can be defined

Authorizations:
auth
path Parameters
invoiceTypeCode
required
string

Add the invoiceTypeCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

occTemplateCode
required
string
occTemplateNegativeCode
string
occTemplateCodeEl
string
occTemplateNegativeCodeEl
string
customInvoiceXmlScriptInstanceCode
string
object (SequenceDto)
invoiceValidationScriptCode
string
object
appliesTo
Array of strings
matchingAuto
boolean
invoiceAccountable
boolean
billingTemplateName
string
pdfFilenameEL
string
xmlFilenameEL
string
billingTemplateNameEL
string
object (CustomFieldsDto)

The custom fields

useSelfSequence
boolean
mailingType
string
emailTemplateCode
string
excludeFromAgedTrialBalance
boolean

Exclude from Aged Trial Balance

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove invoiceType with a given code.

Remove invoiceType with a given code.

Authorizations:
auth
path Parameters
invoiceTypeCode
required
string

Responses

Response samples

Content type
{
}

User management

List all users.

Authorizations:
auth

Responses

Create user

Authorizations:
auth
Request Body schema:
username
required
string

the username of the user

password
string

Used when creating keycloak user

email
required
string

email of the user

firstName
string

first name

lastName
string

last name

roles
Array of strings

list of role associated to user

Array of objects (SecuredEntityDto)

list of secured entities associated to the user

userLevel
string

the user level

createdAt
string <date-time>

date time creation of the user

lastLoginDate
string <date-time>

the last login date

object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update user

Authorizations:
auth
path Parameters
userCode
required
string

Add the userCode here

Request Body schema:
username
required
string

the username of the user

password
string

Used when creating keycloak user

email
required
string

email of the user

firstName
string

first name

lastName
string

last name

roles
Array of strings

list of role associated to user

Array of objects (SecuredEntityDto)

list of secured entities associated to the user

userLevel
string

the user level

createdAt
string <date-time>

date time creation of the user

lastLoginDate
string <date-time>

the last login date

object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Deprecated

Search user with a given username. Deprecated

Authorizations:
auth
query Parameters
username
required
string

The username of user

Responses

Response samples

Content type
{
}

Search for a user account with a given code Deprecated

Authorizations:
auth
path Parameters
userAccountCode
required
string
query Parameters
includeSubscriptions
boolean
Default: false
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

Responses

Response samples

Content type
{
}

List CustomerAccount filtered by customerCode Deprecated

Authorizations:
auth
query Parameters
customerCode
string

Responses

Response samples

Content type
{
}

Get a customer account Deprecated

Authorizations:
auth
path Parameters
customerAccountCode
required
string
query Parameters
calculateBalances
boolean
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"
withAccountOperations
boolean
includeBillingAccounts
boolean

Responses

Response samples

Content type
{
}

Search for a customer with a given code Deprecated

Authorizations:
auth
path Parameters
customerCode
required
string
query Parameters
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

The type of the customer

includeCustomerAccounts
boolean

Indicate if account of the customer will included

Responses

Response samples

Content type
{
}

Search for a billing account with a given code Deprecated

Authorizations:
auth
path Parameters
billingAccountCode
required
string
query Parameters
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"
includeUserAccounts
boolean

Responses

Response samples

Content type
{
}

List BillingAccount filter by customerAccountCode Deprecated

Authorizations:
auth
query Parameters
customerAccountCode
string

Responses

Response samples

Content type
{
}

list entity template

Authorizations:
auth
query Parameters
customEntityTemplateCode
string

Responses

Calendar

List Calendars matching a given criteria

List Calendars matching a given criteria

Authorizations:
auth

Responses

Create a new calendar.

Create a new calendar.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

calendarType
required
string
Enum: "YEARLY" "DAILY" "PERIOD" "INTERVAL" "INTERSECT" "UNION" "APPEND" "BANKING" "FIXED"

calendar type

fixedDates
Array of strings

list of fixed date

Array of objects (DayInYearDto)

list of the day

Array of objects (HourInDayDto)

list of the hour

periodLength
integer <int32>

Period length

periodUnit
string
Enum: "MONTH" "DAY_OF_MONTH" "HOUR_OF_DAY" "MINUTE" "SECOND"

Period measurement unit

nbPeriods
integer <int32>

Number of periods

joinCalendar1Code
string

Code of the first calendar to intersect/union

joinCalendar2Code
string

Code of the second calendar to intersect/union

intervalType
string
Enum: "DAY" "HOUR" "WDAY"

Interval type

Array of objects (CalendarDateIntervalDto)

List of intervals

weekendBegin
integer <int32>

The weekend begin

weekendEnd
integer <int32>
endDate
string <date-time>

The end dat

startDate
string <date-time>

The start date

initDateEL
string [ 0 .. 2000 ] characters

Calendar initialization date - expression to determine a value for calendar initialization date

Array of objects (CalendarHolidayDto)

list of the days of holiday

Array of objects (LanguageDescriptionDto)

lsit of language description

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for calendar with a given code.

Search for calendar with a given code.

Authorizations:
auth
path Parameters
calendarCode
required
string

Responses

Response samples

Content type
{
}

Update calendar.

Update calendar.

Authorizations:
auth
path Parameters
calendarCode
required
string

Add the calendarCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

calendarType
required
string
Enum: "YEARLY" "DAILY" "PERIOD" "INTERVAL" "INTERSECT" "UNION" "APPEND" "BANKING" "FIXED"

calendar type

fixedDates
Array of strings

list of fixed date

Array of objects (DayInYearDto)

list of the day

Array of objects (HourInDayDto)

list of the hour

periodLength
integer <int32>

Period length

periodUnit
string
Enum: "MONTH" "DAY_OF_MONTH" "HOUR_OF_DAY" "MINUTE" "SECOND"

Period measurement unit

nbPeriods
integer <int32>

Number of periods

joinCalendar1Code
string

Code of the first calendar to intersect/union

joinCalendar2Code
string

Code of the second calendar to intersect/union

intervalType
string
Enum: "DAY" "HOUR" "WDAY"

Interval type

Array of objects (CalendarDateIntervalDto)

List of intervals

weekendBegin
integer <int32>

The weekend begin

weekendEnd
integer <int32>
endDate
string <date-time>

The end dat

startDate
string <date-time>

The start date

initDateEL
string [ 0 .. 2000 ] characters

Calendar initialization date - expression to determine a value for calendar initialization date

Array of objects (CalendarHolidayDto)

list of the days of holiday

Array of objects (LanguageDescriptionDto)

lsit of language description

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove calendar with a given code.

Remove calendar with a given code.

Authorizations:
auth
path Parameters
calendarCode
required
string

Responses

Response samples

Content type
{
}

UnitOfMeasure

List UnitOfMeasures matching a given criteria

List UnitOfMeasures matching a given criteria

Authorizations:
auth

Responses

Create a new unitOfMeasure

Create a new unitOfMeasure

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

symbol
required
string
multiplicator
integer <int64>
parentUOMCode
string
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a unitOfMeasure with a given code

Search for a unitOfMeasure with a given code

Authorizations:
auth
path Parameters
unitOfMeasureCode
required
string

Responses

Response samples

Content type
{
}

Update an existing unitOfMeasure

Update an existing unitOfMeasure

Authorizations:
auth
path Parameters
unitOfMeasureCode
required
string

Add the unitOfMeasureCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

symbol
required
string
multiplicator
integer <int64>
parentUOMCode
string
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing unitOfMeasure with a given code

Remove an existing unitOfMeasure with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Contact

List Contacts matching a given criteria

List Contacts matching a given criteria

Authorizations:
auth

Responses

Create a new CRM Contact

Create a new CRM Contact

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

assistantName
string
assistantPhone
string
position
string
company
string
websiteUrl
string
importedFrom
string
importedBy
string
socialIdentifier
string
reference
string
comment
string
agreedToUA
boolean
object (CommunicationPolicy)
tags
Array of strings unique
contactCategoryCodes
Array of strings unique
vip
boolean
prospect
boolean
Array of objects (AddressBookContactDto) unique
isVip
boolean
isProspect
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a contact with a given code

Find a contact with a given code

Authorizations:
auth
query Parameters
code
string

Responses

Response samples

Content type
{
}

Update a contact CRM informatopn

Update a contact CRM informatopn

Authorizations:
auth
path Parameters
contactCode
required
string

Add the contactCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

assistantName
string
assistantPhone
string
position
string
company
string
websiteUrl
string
importedFrom
string
importedBy
string
socialIdentifier
string
reference
string
comment
string
agreedToUA
boolean
object (CommunicationPolicy)
tags
Array of strings unique
contactCategoryCodes
Array of strings unique
vip
boolean
prospect
boolean
Array of objects (AddressBookContactDto) unique
isVip
boolean
isProspect
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Delete a contact with a given code

Delete a contact with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Tax

List taxes matching a given criteria

List taxes matching a given criteria

Authorizations:
auth

Responses

Create tax. Description per language can be defined

Create tax. Description per language can be defined

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

percent
number
accountingCode
string
Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

composite
boolean
subTaxes
Array of objects (TaxDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search tax with a given code.

Search tax with a given code.

Authorizations:
auth
path Parameters
taxCode
required
string

Responses

Response samples

Content type
{
}

Update tax. Description per language can be defined

Update tax. Description per language can be defined

Authorizations:
auth
path Parameters
taxCode
required
string

Add the taxCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

percent
number
accountingCode
string
Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

composite
boolean
subTaxes
Array of objects (TaxDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove tax with a given code.

Remove tax with a given code.

Authorizations:
auth
path Parameters
taxCode
required
string

Responses

Response samples

Content type
{
}

TaxCategory

List taxCategories matching a given criteria

List taxCategories matching a given criteria

Authorizations:
auth

Responses

Create a new Tax category

Create a new Tax category

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a Tax category with a given code

Search for a Tax category with a given code

Authorizations:
auth
query Parameters
code
string

Responses

Response samples

Content type
{
}

Update an existing Tax category

Update an existing Tax category

Authorizations:
auth
path Parameters
taxCategoryCode
required
string

Add the taxCategoryCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing Tax category with a given code

Remove an existing Tax category with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

TaxClass

List taxClasses matching a given criteria

List taxClasses matching a given criteria

Authorizations:
auth

Responses

Create a new Tax class

Create a new Tax class

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a Tax class with a given code

Search for a Tax class with a given code

Authorizations:
auth
query Parameters
code
string

Responses

Response samples

Content type
{
}

Update an existing Tax class

Update an existing Tax class

Authorizations:
auth
path Parameters
taxClassCode
required
string

Add the taxClassCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing Tax class with a given code

Remove an existing Tax class with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

TaxMapping

List taxMappings matching a given criteria

List taxMappings matching a given criteria

Authorizations:
auth

Responses

Create a new Tax mapping

Create a new Tax mapping

Authorizations:
auth
Request Body schema:
id
integer <int64>
accountTaxCategoryCode
string
chargeTaxClassCode
string
validFrom
string <date-time>
validTo
string <date-time>
sellerCountryCode
string
buyerCountryCode
string
filterEL
string [ 0 .. 2000 ] characters
taxCode
string
taxEL
string [ 0 .. 2000 ] characters
taxScriptCode
string
priority
integer <int32>
source
string [ 0 .. 2000 ] characters
originId
integer <int64>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Search for a Tax mapping with a given id

Search for a Tax mapping with a given id

Authorizations:
auth
query Parameters
id
string

Responses

Response samples

Content type
{
}

Update an existing Tax mapping

Update an existing Tax mapping

Authorizations:
auth
path Parameters
taxMappingCode
required
string

Add the taxMappingCode here

Request Body schema:
id
integer <int64>
accountTaxCategoryCode
string
chargeTaxClassCode
string
validFrom
string <date-time>
validTo
string <date-time>
sellerCountryCode
string
buyerCountryCode
string
filterEL
string [ 0 .. 2000 ] characters
taxCode
string
taxEL
string [ 0 .. 2000 ] characters
taxScriptCode
string
priority
integer <int32>
source
string [ 0 .. 2000 ] characters
originId
integer <int64>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Remove an existing Tax mapping with a given id

Remove an existing Tax mapping with a given id

Authorizations:
auth
path Parameters
id
required
string

Responses

Response samples

Content type
{
}

CreditCategory

List creditCategories matching a given criteria 

  List creditCategories matching a given criteria
Authorizations:
auth

Responses

Create a new credit category

Create a new credit category

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update a credit category payment

Update a credit category payment

Authorizations:
auth
path Parameters
creditCategoryCode
required
string

Add the creditCategoryCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Delete a credit category with his given code

Delete a credit category with his given code

Authorizations:
auth
path Parameters
creditCategoryCode
required
string

Responses

Response samples

Content type
{
}

BusinessProductModel

List Business Product Models matching a given criteria

List Business Product Models matching a given criteria

Authorizations:
auth

Responses

Create a new business product model

Create a new business product model

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (ProductTemplateDto)
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing business product model with a given code

Remove an existing business product model with a given code

Authorizations:
auth
path Parameters
businessProductModelCode
required
string

Responses

Response samples

Content type
{
}

Update an existing business product model

Update an existing business product model

Authorizations:
auth
path Parameters
businessProductModelCode
required
string

Add the businessProductModelCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (ProductTemplateDto)
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing business product model with a given code

Remove an existing business product model with a given code

Authorizations:
auth
path Parameters
businessProductModelCode
required
string

Responses

Response samples

Content type
{
}

BusinessOfferModel

List business offer models.

List business offer models.

Authorizations:
auth
query Parameters
query
string
fields
string
offset
integer <int32>
limit
integer <int32>
sortBy
string
Default: "code"
sortOrder
string
Default: "ASCENDING"
Enum: "ASCENDING" "DESCENDING"

Responses

Create a new business offer model.

Create a new business offer model.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (OfferTemplateDto)
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing business offer model with a given code.

Remove an existing business offer model with a given code.

Authorizations:
auth
path Parameters
businessOfferModelCode
required
string
query Parameters
loadOfferServiceTemplate
boolean
Default: false
loadOfferProductTemplate
boolean
Default: false
loadServiceChargeTemplate
boolean
Default: false
loadProductChargeTemplate
boolean
Default: false

Responses

Response samples

Content type
{
}

Update an existing business offer model.

Update an existing business offer model.

Authorizations:
auth
path Parameters
businessOfferModelCode
required
string

Add the businessOfferModelCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (OfferTemplateDto)
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing business offer model with a given code.

Remove an existing business offer model with a given code.

Authorizations:
auth
path Parameters
businessOfferModelCode
required
string

Responses

Response samples

Content type
{
}

BusinessServiceModel

List Business Service Models matching a given criteria

List Business Service Models matching a given criteria

Authorizations:
auth

Responses

Create a new business service model

Create a new business service model

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (ServiceTemplateDto)
duplicateService
boolean
duplicatePricePlan
boolean
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a business service model with a given code

Search for a business service model with a given code

Authorizations:
auth
path Parameters
businessServiceModelCode
required
string

Responses

Response samples

Content type
{
}

Update an existing business service model

Update an existing business service model

Authorizations:
auth
path Parameters
businessServiceModelCode
required
string

Add the businessServiceModelCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
required
object (ServiceTemplateDto)
duplicateService
boolean
duplicatePricePlan
boolean
Array of objects (LanguageDescriptionDto)
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing business service model with a given code

Remove an existing business service model with a given code

Authorizations:
auth
path Parameters
businessServiceModelCode
required
string

Responses

Response samples

Content type
{
}

TriggeredEdr

Gets a triggeredEdrs list.

Gets a triggeredEdrs list.

Authorizations:
auth

Responses

Create a new triggered edr. template

Create a new triggered edr. template

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

subscriptionEl
string
meveoInstanceCode
string
conditionEl
string
quantityEl
required
string
param1El
string
param2El
string
param3El
string
param4El
string
commerceInstanceEL
string
triggeredEdrScript
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find triggered edr with a given code.

Find triggered edr with a given code.

Authorizations:
auth
path Parameters
triggeredEdrCode
required
string

Responses

Response samples

Content type
{
}

Update an existing triggered edr. template

Update an existing triggered edr. template

Authorizations:
auth
path Parameters
triggeredEdrCode
required
string

Add the triggeredEdrCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

subscriptionEl
string
meveoInstanceCode
string
conditionEl
string
quantityEl
required
string
param1El
string
param2El
string
param3El
string
param4El
string
commerceInstanceEL
string
triggeredEdrScript
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing triggered edr template with a given code.

Remove an existing triggered edr template with a given code.

Authorizations:
auth
path Parameters
triggeredEdrCode
required
string

Responses

Response samples

Content type
{
}

EmailTemplate

List email templates

List email templates

Authorizations:
auth

Responses

Create an email template by dto 

  Create an email template by dto
Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

media
string
Enum: "POSTAL_MAIL" "EMAIL" "SMS" "IM" "FAX" "VOICE" "WEBSERVICE" "QUEUE" "FTP_FILE" "CFT_FILE" "DATABASE" "DUNNING_MEDIA"
tagStartDelimiter
string
tagEndDelimiter
string
startDate
string <date-time>
endDate
string <date-time>
type
string
Enum: "DUNNING" "INVOICE" "OTHER"
subject
required
string
htmlContent
string
textContent
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find an email template with a given code

Find an email template with a given code

Authorizations:
auth
query Parameters
code
string

Responses

Response samples

Content type
{
}

update an emailTemplate by dto 

  update an emailTemplate by dto
Authorizations:
auth
path Parameters
emailTemplateCode
required
string

Add the emailTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

media
string
Enum: "POSTAL_MAIL" "EMAIL" "SMS" "IM" "FAX" "VOICE" "WEBSERVICE" "QUEUE" "FTP_FILE" "CFT_FILE" "DATABASE" "DUNNING_MEDIA"
tagStartDelimiter
string
tagEndDelimiter
string
startDate
string <date-time>
endDate
string <date-time>
type
string
Enum: "DUNNING" "INVOICE" "OTHER"
subject
required
string
htmlContent
string
textContent
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

remove an emailTemplate by code

remove an emailTemplate by code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

MeveoInstance

List meveoInstances

List meveoInstances

Authorizations:
auth

Responses

Create a meveoInstance by dto. 

  Create a meveoInstance by dto.
Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

productName
string
productVersion
string
owner
string
md5
string
status
string
Enum: "UNKNOWN" "PARENT" "CHILD" "PARTNER"
creationDate
string <date-time>
updateDate
string <date-time>
keyEntreprise
string
macAddress
string
machineVendor
string
installationMode
string
nbCores
string
memory
string
hdSize
string
osName
string
osVersion
string
osArch
string
javaVmVersion
string
javaVmName
string
javaVendor
string
javaVersion
string
asVendor
string
asVersion
string
url
required
string
authUsername
string
authPassword
string
user
string
customer
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a meveoInstance by code

Find a meveoInstance by code

Authorizations:
auth
query Parameters
code
string

Responses

Response samples

Content type
{
}

Update a meveoInstance by dto 

  Update a meveoInstance by dto
Authorizations:
auth
path Parameters
meveoInstanceCode
required
string

Add the meveoInstanceCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

productName
string
productVersion
string
owner
string
md5
string
status
string
Enum: "UNKNOWN" "PARENT" "CHILD" "PARTNER"
creationDate
string <date-time>
updateDate
string <date-time>
keyEntreprise
string
macAddress
string
machineVendor
string
installationMode
string
nbCores
string
memory
string
hdSize
string
osName
string
osVersion
string
osArch
string
javaVmVersion
string
javaVmName
string
javaVendor
string
javaVersion
string
asVendor
string
asVersion
string
url
required
string
authUsername
string
authPassword
string
user
string
customer
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove a meveoInstance by code

Remove a meveoInstance by code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

AccountingCode

List AccountingCodes matching a given criteria

List AccountingCodes matching a given criteria

Authorizations:
auth

Responses

Creates a new AccountingCode.

Creates a new AccountingCode.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
parentAccountingCode
string
chartOfAccountTypeEnum
string
Enum: "ASSETS" "LIABILITIES" "EQUITY" "REVENUE" "EXPENSE"
chartOfAccountViewTypeEnum
string
Enum: "VIEW" "REGULAR"
reportingAccount
string
notes
string
migrated
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Finds an AccountingCode.

Finds an AccountingCode.

Authorizations:
auth
query Parameters
accountingCode
string

Responses

Response samples

Content type
{
}

Updates AccountingCode. An existing AccountingCode is search using the code field.

Updates AccountingCode. An existing AccountingCode is search using the code field.

Authorizations:
auth
path Parameters
accountingCodeCode
required
string

Add the accountingCodeCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
parentAccountingCode
string
chartOfAccountTypeEnum
string
Enum: "ASSETS" "LIABILITIES" "EQUITY" "REVENUE" "EXPENSE"
chartOfAccountViewTypeEnum
string
Enum: "VIEW" "REGULAR"
reportingAccount
string
notes
string
migrated
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Removes an AccountingCode entity.

Removes an AccountingCode entity.

Authorizations:
auth
path Parameters
accountingCode
required
string

Responses

Response samples

Content type
{
}

Enable a Accounting code with a given code

Enable a Accounting code with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Accounting code with a given code

Disable a Accounting code with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

CounterTemplate

List CounterTemplates matching a given criteria

List CounterTemplates matching a given criteria

Authorizations:
auth

Responses

Create counter template.

Create counter template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
calendar
string
calendarCodeEl
string [ 0 .. 2000 ] characters
unity
string
type
string
Enum: "USAGE" "NOTIFICATION" "USAGE_AMOUNT"
ceiling
number
counterLevel
string
Enum: "SI" "SU" "UA" "BA" "CA" "CUST"
ceilingExpressionEl
string [ 0 .. 2000 ] characters
notificationLevels
string
accumulator
boolean
accumulatorType
string
Enum: "MULTI_VALUE" "SINGLE_VALUE"
filterEl
string
keyEl
string
valueEl
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search counter template with a given code.

Search counter template with a given code.

Authorizations:
auth
path Parameters
counterTemplateCode
required
string

Responses

Response samples

Content type
{
}

Update counter template.

Update counter template.

Authorizations:
auth
path Parameters
counterTemplateCode
required
string

Add the counterTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
calendar
string
calendarCodeEl
string [ 0 .. 2000 ] characters
unity
string
type
string
Enum: "USAGE" "NOTIFICATION" "USAGE_AMOUNT"
ceiling
number
counterLevel
string
Enum: "SI" "SU" "UA" "BA" "CA" "CUST"
ceilingExpressionEl
string [ 0 .. 2000 ] characters
notificationLevels
string
accumulator
boolean
accumulatorType
string
Enum: "MULTI_VALUE" "SINGLE_VALUE"
filterEl
string
keyEl
string
valueEl
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove counter template with a given code.

Remove counter template with a given code.

Authorizations:
auth
path Parameters
counterTemplateCode
required
string

Responses

Response samples

Content type
{
}

Enable a Counter template with a given code

Enable a Counter template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Counter template with a given code

Disable a Counter template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

RecurringChargeTemplate

list_4

Authorizations:
auth

Responses

Create a new recurring charge template.

Create a new recurring charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
calendar
required
string

the calendar

durationTermInMonth
integer <int32>

The duration term in month

subscriptionProrata
boolean

The subscription prorata

terminationProrata
boolean

The termination prorata

applyInAdvance
boolean

The apply in advance

shareLevel
integer <int32>

The share level

calendarCodeEl
string [ 0 .. 2000 ] characters

The calendar code expression language

durationTermInMonthEl
string [ 0 .. 2000 ] characters

The duration term in month on expression language

subscriptionProrataEl
string [ 0 .. 2000 ] characters

The subscription prorata on expression language

terminationProrataEl
string [ 0 .. 2000 ] characters

The termination prorata on expression language

applyInAdvanceEl
string [ 0 .. 2000 ] characters

The apply in advance on expression language

applyTerminatedChargeToDateEL
string

Expression to determine and override the date that recurring charge should be charged to upon charge/service termination

recurrenceType
string
Default: "CALENDAR"
Enum: "CALENDAR" "PERIOD"

recrrence type

attributeDurationCode
string

code of attribute duration

attributeCalendarCode
string

code of attribute calendar

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a recurring charge template with a given code.

Find a recurring charge template with a given code.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Return the list of recurringChargeTemplates.

Return the list of recurringChargeTemplates.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

Add the recurringChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
calendar
required
string

the calendar

durationTermInMonth
integer <int32>

The duration term in month

subscriptionProrata
boolean

The subscription prorata

terminationProrata
boolean

The termination prorata

applyInAdvance
boolean

The apply in advance

shareLevel
integer <int32>

The share level

calendarCodeEl
string [ 0 .. 2000 ] characters

The calendar code expression language

durationTermInMonthEl
string [ 0 .. 2000 ] characters

The duration term in month on expression language

subscriptionProrataEl
string [ 0 .. 2000 ] characters

The subscription prorata on expression language

terminationProrataEl
string [ 0 .. 2000 ] characters

The termination prorata on expression language

applyInAdvanceEl
string [ 0 .. 2000 ] characters

The apply in advance on expression language

applyTerminatedChargeToDateEL
string

Expression to determine and override the date that recurring charge should be charged to upon charge/service termination

recurrenceType
string
Default: "CALENDAR"
Enum: "CALENDAR" "PERIOD"

recrrence type

attributeDurationCode
string

code of attribute duration

attributeCalendarCode
string

code of attribute calendar

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing recurring charge template.

Update an existing recurring charge template.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

The recurring charge template code

Responses

Response samples

Content type
{
}

Create new or update an existing recurring charge template

Create new or update an existing recurring charge template

Authorizations:
auth
path Parameters
code
required
string

The code of recurring charge template to be enabled

Responses

Response samples

Content type
{
}

Enable a Recurring charge template with a given code

Enable a Recurring charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of recurring charge template to be disabled

Responses

Response samples

Content type
{
}

ChargeTemplates

Create a new recurring charge template.

Create a new recurring charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
calendar
required
string

the calendar

durationTermInMonth
integer <int32>

The duration term in month

subscriptionProrata
boolean

The subscription prorata

terminationProrata
boolean

The termination prorata

applyInAdvance
boolean

The apply in advance

shareLevel
integer <int32>

The share level

calendarCodeEl
string [ 0 .. 2000 ] characters

The calendar code expression language

durationTermInMonthEl
string [ 0 .. 2000 ] characters

The duration term in month on expression language

subscriptionProrataEl
string [ 0 .. 2000 ] characters

The subscription prorata on expression language

terminationProrataEl
string [ 0 .. 2000 ] characters

The termination prorata on expression language

applyInAdvanceEl
string [ 0 .. 2000 ] characters

The apply in advance on expression language

applyTerminatedChargeToDateEL
string

Expression to determine and override the date that recurring charge should be charged to upon charge/service termination

recurrenceType
string
Default: "CALENDAR"
Enum: "CALENDAR" "PERIOD"

recrrence type

attributeDurationCode
string

code of attribute duration

attributeCalendarCode
string

code of attribute calendar

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a recurring charge template with a given code.

Find a recurring charge template with a given code.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Return the list of recurringChargeTemplates.

Return the list of recurringChargeTemplates.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

Add the recurringChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
calendar
required
string

the calendar

durationTermInMonth
integer <int32>

The duration term in month

subscriptionProrata
boolean

The subscription prorata

terminationProrata
boolean

The termination prorata

applyInAdvance
boolean

The apply in advance

shareLevel
integer <int32>

The share level

calendarCodeEl
string [ 0 .. 2000 ] characters

The calendar code expression language

durationTermInMonthEl
string [ 0 .. 2000 ] characters

The duration term in month on expression language

subscriptionProrataEl
string [ 0 .. 2000 ] characters

The subscription prorata on expression language

terminationProrataEl
string [ 0 .. 2000 ] characters

The termination prorata on expression language

applyInAdvanceEl
string [ 0 .. 2000 ] characters

The apply in advance on expression language

applyTerminatedChargeToDateEL
string

Expression to determine and override the date that recurring charge should be charged to upon charge/service termination

recurrenceType
string
Default: "CALENDAR"
Enum: "CALENDAR" "PERIOD"

recrrence type

attributeDurationCode
string

code of attribute duration

attributeCalendarCode
string

code of attribute calendar

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing recurring charge template.

Update an existing recurring charge template.

Authorizations:
auth
path Parameters
recurringChargeTemplateCode
required
string

The recurring charge template code

Responses

Response samples

Content type
{
}

Create new or update an existing recurring charge template

Create new or update an existing recurring charge template

Authorizations:
auth
path Parameters
code
required
string

The code of recurring charge template to be enabled

Responses

Response samples

Content type
{
}

Enable a Recurring charge template with a given code

Enable a Recurring charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of recurring charge template to be disabled

Responses

Response samples

Content type
{
}

Create one shot charge template.

Create one shot charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
oneShotChargeTemplateType
required
string
Enum: "oneShotChargeTemplateTypeEnum.subscription" "oneShotChargeTemplateTypeEnum.termination" "oneShotChargeTemplateTypeEnum.other"

The one shot charge template type

immediateInvoicing
boolean

The immediate invoicing

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search one shot charge templatewith a given code.

Search one shot charge templatewith a given code.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Update one shot charge template.

Update one shot charge template.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

Add the oneShotChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
oneShotChargeTemplateType
required
string
Enum: "oneShotChargeTemplateTypeEnum.subscription" "oneShotChargeTemplateTypeEnum.termination" "oneShotChargeTemplateTypeEnum.other"

The one shot charge template type

immediateInvoicing
boolean

The immediate invoicing

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Return the list of oneShotChargeTemplates.

Return the list of oneShotChargeTemplates.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

The one shot charge template code

Responses

Response samples

Content type
{
}

Create new or update an existing.

Create new or update an existing.

Authorizations:
auth
path Parameters
code
required
string

The code of One shot charge template to be enabled

Responses

Response samples

Content type
{
}

Enable a One shot charge template with a given code

Enable a One shot charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of One shot charge template to be disabled

Responses

Response samples

Content type
{
}

Create new usage charge template.

Create new usage charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
filterParam1
string [ 0 .. 255 ] characters

first filter parameter

filterParam2
string [ 0 .. 255 ] characters

second filter parameter

filterParam3
string [ 0 .. 255 ] characters

third filter parameter

filterParam4
string [ 0 .. 255 ] characters

fourth filter parameter

priority
integer <int32>

The priority

triggerNextCharge
boolean

If set to true and (charge has no counter associated) then the next matching charge with the full quantity of the EDR

triggerNextChargeEL
string

Overrides the triggerNextCharge switch

usageQuantityAttributeCode
string

code of usage attribute quantity

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find an existing usage charge template with a given code.

Find an existing usage charge template with a given code.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Update usage charge template.

Update usage charge template.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

Add the usageChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
filterParam1
string [ 0 .. 255 ] characters

first filter parameter

filterParam2
string [ 0 .. 255 ] characters

second filter parameter

filterParam3
string [ 0 .. 255 ] characters

third filter parameter

filterParam4
string [ 0 .. 255 ] characters

fourth filter parameter

priority
integer <int32>

The priority

triggerNextCharge
boolean

If set to true and (charge has no counter associated) then the next matching charge with the full quantity of the EDR

triggerNextChargeEL
string

Overrides the triggerNextCharge switch

usageQuantityAttributeCode
string

code of usage attribute quantity

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove usage charge template with a given code.

Remove usage charge template with a given code.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

The usage charge template code

Responses

Response samples

Content type
{
}

Enable a Usage charge template with a given code

Enable a Usage charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of the usage charge template to be enabled

Responses

Response samples

Content type
{
}

Disable a Usage charge template with a given code

Disable a Usage charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of the usage charge template to be disabeled

Responses

Response samples

Content type
{
}

ServiceTemplate

listGetAll_5

Authorizations:
auth

Responses

Create a new service template.

Create a new service template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
longDescription
string
invoicingCalendar
string
object (ServiceChargeTemplateRecurringsDto)
object (ServiceChargeTemplateSubscriptionsDto)
object (ServiceChargeTemplateTerminationsDto)
object (ServiceChargeTemplateUsagesDto)
object (CustomFieldsDto)

The custom fields

mandatory
boolean
somCode
string
imagePath
string
imageBase64
string
minimumAmountEl
string
minimumLabelEl
string
minimumInvoiceSubCategory
string
autoEndOfEngagement
boolean
minimumChargeTemplate
string
object (SubscriptionRenewalDto)
Array of objects (LanguageDescriptionDto)
groupedServiceCode
string
values
Array of objects
valueValidator
string
serviceTypeCode
string
display
boolean
param
string
Array of objects (MediaDto)
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a service template with a given code.

Find a service template with a given code.

Authorizations:
auth
path Parameters
serviceTemplateCode
required
string
query Parameters
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

Responses

Response samples

Content type
{
}

Update an existing service template.

Update an existing service template.

Authorizations:
auth
path Parameters
serviceTemplateCode
required
string

Add the serviceTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
longDescription
string
invoicingCalendar
string
object (ServiceChargeTemplateRecurringsDto)
object (ServiceChargeTemplateSubscriptionsDto)
object (ServiceChargeTemplateTerminationsDto)
object (ServiceChargeTemplateUsagesDto)
object (CustomFieldsDto)

The custom fields

mandatory
boolean
somCode
string
imagePath
string
imageBase64
string
minimumAmountEl
string
minimumLabelEl
string
minimumInvoiceSubCategory
string
autoEndOfEngagement
boolean
minimumChargeTemplate
string
object (SubscriptionRenewalDto)
Array of objects (LanguageDescriptionDto)
groupedServiceCode
string
values
Array of objects
valueValidator
string
serviceTypeCode
string
display
boolean
param
string
Array of objects (MediaDto)
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove service template with a given code.

Remove service template with a given code.

Authorizations:
auth
path Parameters
serviceTemplateCode
required
string

Responses

Response samples

Content type
{
}

Enable a Service template with a given code

Enable a Service template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Service template with a given code

Disable a Service template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Country

Creates a Trading Country base from the supplied country code

Creates a Trading Country base from the supplied country code. If the country code does not exists, a country and tradingCountry records are created

Authorizations:
auth
Request Body schema:
countryCode
string
name
string
currencyCode
required
string
languageCode
string
disabled
boolean
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search Trading country with a given country code.

Search Trading country with a given country code.

Authorizations:
auth
path Parameters
countryCode
required
string

Responses

Response samples

Content type
{
}

Modify a country

Modify a country. Same input parameter as create. The country and tradingCountry are created if they don't exists. The operation fails if the tradingCountry is null.

Authorizations:
auth
path Parameters
countryCode
required
string

Add the countryCode here

Request Body schema:
countryCode
string
name
string
currencyCode
required
string
languageCode
string
disabled
boolean
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Does not delete a country but the tradingCountry associated to it.

Does not delete a country but the tradingCountry associated to it.

Authorizations:
auth
path Parameters
countryCode
required
string

Responses

Response samples

Content type
{
}

Enable a Trading country with a given country code

Enable a Trading country with a given country code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Trading country with a given country code

Disable a Trading country with a given country code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Payment

List paymentMethods matching a given criteria

List paymentMethods matching a given criteria

Authorizations:
auth

Responses

Add a new payment method. It will be marked as preferred.

Add a new payment method. It will be marked as preferred.

Authorizations:
auth
Request Body schema:
paymentMethodType
required
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

type of the payment method

id
integer <int64>

id of the entity

disabled
boolean

Indicate if the payment method is disabled

alias
string

Alias

preferred
boolean
Default: false

Is it a preferred payment method

customerAccountCode
string

Customer account code

info1
string

first Additional info

info2
string

second Additional info

info3
string

third Additional info

info4
string

fourth Additional info

info5
string

fifth Additional info

object (BankCoordinatesDto)

Bank account information

mandateIdentification
string

Mandate identification for SEPA

mandateDate
string <date-time>

Mandate date for SEPA

cardType
string
Enum: "VISA" "MASTERCARD" "AMERICAN_EXPRESS" "CB" "EFTPOS_AUSTRALIA"

Card type

owner
string

Cardholder: first and last name

monthExpiration
integer <int32>

Card expiration: month

yearExpiration
integer <int32>

Card expiration: year

tokenId
string

Token ID in a payment gateway

cardNumber
string

Card number: full number , with first 12 digits hiding in read operation

issueNumber
string

Issue number

userId
string

Id of the user

email
string

Email

referenceDocumentCode
string

The code of reference document

customerCode
string
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Retrieve payment method by its id.

Retrieve payment method by its id.

Authorizations:
auth
query Parameters
id
integer <int64>

Responses

Response samples

Content type
{
}

Update existing payment method.

Update existing payment method.

Authorizations:
auth
path Parameters
paymentMethodCode
required
string

Add the paymentMethodCode here

Request Body schema:
paymentMethodType
required
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

type of the payment method

id
integer <int64>

id of the entity

disabled
boolean

Indicate if the payment method is disabled

alias
string

Alias

preferred
boolean
Default: false

Is it a preferred payment method

customerAccountCode
string

Customer account code

info1
string

first Additional info

info2
string

second Additional info

info3
string

third Additional info

info4
string

fourth Additional info

info5
string

fifth Additional info

object (BankCoordinatesDto)

Bank account information

mandateIdentification
string

Mandate identification for SEPA

mandateDate
string <date-time>

Mandate date for SEPA

cardType
string
Enum: "VISA" "MASTERCARD" "AMERICAN_EXPRESS" "CB" "EFTPOS_AUSTRALIA"

Card type

owner
string

Cardholder: first and last name

monthExpiration
integer <int32>

Card expiration: month

yearExpiration
integer <int32>

Card expiration: year

tokenId
string

Token ID in a payment gateway

cardNumber
string

Card number: full number , with first 12 digits hiding in read operation

issueNumber
string

Issue number

userId
string

Id of the user

email
string

Email

referenceDocumentCode
string

The code of reference document

customerCode
string
object (CustomFieldsDto)

The custom fields

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove payment method. If it was marked as preferred, some other payment method will be marked as preferred

Remove payment method. If it was marked as preferred, some other payment method will be marked as preferred

Authorizations:
auth
query Parameters
id
integer <int64>

Responses

Response samples

Content type
{
}

Enable a Payment method with a given id

Enable a Payment method with a given id

Authorizations:
auth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
{
}

Disable a Payment method with a given id

Disable a Payment method with a given id

Authorizations:
auth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
{
}

RatedTransaction

List ratedTransactions matching a given criteria

List ratedTransactions matching a given criteria

Authorizations:
auth

Responses

CurrencyIso

List currencies ISO matching a given criteria

List currencies ISO matching a given criteria

Authorizations:
auth

Responses

Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created

Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created

Authorizations:
auth
Request Body schema:
code
string
description
string

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Search currency with a given currency code.

Search currency with a given currency code.

Authorizations:
auth
query Parameters
currencyCode
string

Responses

Response samples

Content type
{
}

Modify a tradingCurrency

Modify a tradingCurrency. Same input parameter as create. The currency and tradingCurrency are created if they don't exists. The operation fails if the tradingCurrency is null

Authorizations:
auth
path Parameters
currencyIsoCode
required
string

Add the currencyIsoCode here

Request Body schema:
code
string
description
string

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Remove currency with a given currency code.

Remove currency with a given currency code.

Authorizations:
auth
path Parameters
currencyCode
required
string

Responses

Response samples

Content type
{
}

BusinessAccountModel

List MeveoModuleDtos matching a given criteria

List MeveoModuleDtos matching a given criteria

Authorizations:
auth

Responses

Create a new business account model.

Create a new business account model.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
hierarchyType
string
Enum: "S" "S_C" "C" "S_CA" "C_CA" "CA" "S_BA" "C_BA" "CA_BA" "BA" "S_UA" "C_UA" "CA_UA" "BA_UA" "UA"
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a business account model.

Search for a business account model.

Authorizations:
auth
path Parameters
businessAccountModelCode
required
string

Responses

Response samples

Content type
{
}

Update an existing business account model.

Update an existing business account model.

Authorizations:
auth
path Parameters
businessAccountModelCode
required
string

Add the businessAccountModelCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
license
string
Enum: "APACHE" "BSD3_N" "BSD3_R" "BSD2_S" "FREE_BSD" "GPL" "AGPL" "LGPL" "MIT" "MOZ" "CDDL" "EPL" "OPEN" "COM"
logoPicture
string
logoPictureFile
Array of strings <byte> [ items <byte > ]
object (ScriptInstanceDto)
moduleItems
Array of objects (BaseEntityDto)
hierarchyType
string
Enum: "S" "S_C" "C" "S_CA" "C_CA" "CA" "S_BA" "C_BA" "CA_BA" "BA" "S_UA" "C_UA" "CA_UA" "BA_UA" "UA"
transient
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove business account model with a given business account model code.

Remove business account model with a given business account model code.

Authorizations:
auth
path Parameters
businessAccountModelCode
required
string

Responses

Response samples

Content type
{
}

Currency

Search for list of trading currencies.

Search for list of trading currencies.

Authorizations:
auth

Responses

Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created

Creates tradingCurrency base on currency code. If the currency code does not exists, a currency record is created

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
string
description
string
disabled
boolean
prCurrencyToThis
number
Array of objects (LanguageDescriptionDto)
symbol
string
decimalPlaces
integer <int32>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Modify a tradingCurrency

Modify a tradingCurrency. Same input parameter as create. The currency and tradingCurrency are created if they don't exists. The operation fails if the tradingCurrency is null

Authorizations:
auth
path Parameters
currencyCode
required
string

Add the currencyCode here

Request Body schema:
id
integer <int64>
code
string
description
string
disabled
boolean
prCurrencyToThis
number
Array of objects (LanguageDescriptionDto)
symbol
string
decimalPlaces
integer <int32>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Remove currency with a given currency code.

Remove currency with a given currency code.

Authorizations:
auth
path Parameters
currencyCode
required
string

Responses

Response samples

Content type
{
}

Enable a Trading currency with a given currency code

Enable a Trading currency with a given currency code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Trading currency with a given currency code

Disable a Trading currency with a given currency code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

OneShotChargeTemplate

list_3

Authorizations:
auth

Responses

Create one shot charge template.

Create one shot charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
oneShotChargeTemplateType
required
string
Enum: "oneShotChargeTemplateTypeEnum.subscription" "oneShotChargeTemplateTypeEnum.termination" "oneShotChargeTemplateTypeEnum.other"

The one shot charge template type

immediateInvoicing
boolean

The immediate invoicing

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search one shot charge templatewith a given code.

Search one shot charge templatewith a given code.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Update one shot charge template.

Update one shot charge template.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

Add the oneShotChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
oneShotChargeTemplateType
required
string
Enum: "oneShotChargeTemplateTypeEnum.subscription" "oneShotChargeTemplateTypeEnum.termination" "oneShotChargeTemplateTypeEnum.other"

The one shot charge template type

immediateInvoicing
boolean

The immediate invoicing

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Return the list of oneShotChargeTemplates.

Return the list of oneShotChargeTemplates.

Authorizations:
auth
path Parameters
oneShotChargeTemplateCode
required
string

The one shot charge template code

Responses

Response samples

Content type
{
}

Create new or update an existing.

Create new or update an existing.

Authorizations:
auth
path Parameters
code
required
string

The code of One shot charge template to be enabled

Responses

Response samples

Content type
{
}

Enable a One shot charge template with a given code

Enable a One shot charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of One shot charge template to be disabled

Responses

Response samples

Content type
{
}

Invoice

List invoices matching a given criteria

List invoices matching a given criteria

Authorizations:
auth

Responses

Finds an invoice based on invoice number and return it as pdf as byte []

Finds an invoice based on invoice number and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.

Authorizations:
auth
query Parameters
invoiceId
integer <int64>
invoiceNumber
string

Responses

Response samples

Content type
{
}

Finds an invoice based on its invoice number and return it as xml string.

Finds an invoice based on its invoice number and return it as xml string.

Authorizations:
auth
query Parameters
invoiceId
integer <int64>
invoiceNumber
string

Responses

Response samples

Content type
{
}

Validate an invoice based on invoice id.

Validate an invoice based on invoice id.

Authorizations:
auth
Request Body schema:
invoiceId
required
integer <int64>
generateAO
boolean
refreshExchangeRate
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Launch all the invoicing process for a given billingAccount, that's mean

Launch all the invoicing process for a given billingAccount, that's mean.

  • Create rated transactions
  • Create an exceptional billingRun with given dates
  • Validate the pre-invoicing report
  • Validate the post-invoicing report
  • Validate the BillingRun

Authorizations:
auth
Request Body schema:
targetType
string
targetCode
string
billingAccountCode
string
openOrderCode
string
applyBillingRules
boolean
invoicingDate
required
string <date-time>
firstTransactionDate
string <date-time>
lastTransactionDate
string <date-time>
object (FilterDto)
orderNumber
string
generateXML
boolean
generatePDF
boolean
generateAO
boolean
object (CustomFieldsDto)

The custom fields

includeRatedTransactions
boolean
applyMinimum
string
skipValidation
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Finds an invoice based on invoice number and optionally an invoice type and return it as pdf as byte []

Finds an invoice based on invoice number and optionally an invoice type and return it as pdf as byte []. Invoice is not recreated, instead invoice stored as pdf in database is returned.

Authorizations:
auth
Request Body schema:
invoiceId
integer <int64>
invoiceNumber
string
invoiceType
string
generatePdf
boolean

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string.

Finds an invoice based on its invoice number and optionally an invoice type and return it as xml string.

Authorizations:
auth
Request Body schema:
invoiceId
integer <int64>
invoiceNumber
string
invoiceType
string

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Jobs management

Search for list of jobInstances

Authorizations:
auth

Responses

Create a new job

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
required
object (JobCategoryEnum)
jobTemplate
required
string

Job template

followingJob
string

Following job to execute

parameter
string

Parameter to job execution

active
boolean
Deprecated

Is job active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead

object (CustomFieldsDto)

The custom fields

timerCode
string

Job scheduling timer code

runOnNodes
string

What cluster nodes job could/should run on. A comma separated list of custer nodes. A job can/will be run on any node if value is null

limitToSingleNode
boolean

Can job be run in parallel on several cluster nodes. Value of True indicates that job can be run on a single node at a time

verboseReport
boolean

Whether a verbose error log will be kept

jobSpeed
string
Enum: "SLOW" "NORMAL" "FAST" "VERY_FAST"

Job execution speed. Defines how often job execution history gets updated

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a job with a given code

Authorizations:
auth
path Parameters
jobInstanceCode
required
string

Responses

Response samples

Content type
{
}

Update an existing job

Authorizations:
auth
path Parameters
jobInstanceCode
required
string

Add the jobInstanceCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
required
object (JobCategoryEnum)
jobTemplate
required
string

Job template

followingJob
string

Following job to execute

parameter
string

Parameter to job execution

active
boolean
Deprecated

Is job active. A negative of Disabled. Deprecated in 5.0.1. Use Disabled field instead

object (CustomFieldsDto)

The custom fields

timerCode
string

Job scheduling timer code

runOnNodes
string

What cluster nodes job could/should run on. A comma separated list of custer nodes. A job can/will be run on any node if value is null

limitToSingleNode
boolean

Can job be run in parallel on several cluster nodes. Value of True indicates that job can be run on a single node at a time

verboseReport
boolean

Whether a verbose error log will be kept

jobSpeed
string
Enum: "SLOW" "NORMAL" "FAST" "VERY_FAST"

Job execution speed. Defines how often job execution history gets updated

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing job with a given code

Authorizations:
auth
path Parameters
jobInstanceCode
required
string

The job instance's code

Responses

Response samples

Content type
{
}

Enable a Job with a given code

Authorizations:
auth
path Parameters
code
required
string

The job instance's code

Responses

Response samples

Content type
{
}

Disable a Job with a given code

Authorizations:
auth
path Parameters
code
required
string

The job instance's code

Responses

Response samples

Content type
{
}

OfferTemplate

list_2

Authorizations:
auth
query Parameters
offerTemplateCode
string
validFrom
string <date-time>
validTo
string <date-time>
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

Responses

Create offer template.

Create offer template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
validFrom
string <date-time>
validTo
string <date-time>
newValidFrom
string <date-time>
newValidTo
string <date-time>
name
required
string
Array of objects (OfferTemplateCategoryDto)
Array of objects (ChannelDto)
Array of objects (DigitalResourceDto)
modelCode
string
lifeCycleStatus
required
string
Enum: "IN_STUDY" "IN_DESIGN" "IN_TEST" "ACTIVE" "LAUNCHED" "RETIRED" "OBSOLETE" "REJECTED"
object (CustomFieldsDto)

The custom fields

imagePath
string
imageBase64
string
Array of objects (LanguageDescriptionDto)
longDescription
string
Array of objects (LanguageDescriptionDto)
globalRatingScriptInstance
string
sellers
Array of strings
Array of objects (CustomerCategoryDto)
bomCode
string

the bom code

offerTemplateCategoryCode
string
Array of objects (OfferServiceTemplateDto)

list of the offer service templates

Array of objects (OfferProductTemplateDto)
Array of objects (OfferProductsDto)

list of The offer component

Array of objects (DiscountPlanDto)

list of The offer product template

Array of objects (OfferTemplateAttributeDTO)

list of attributes

Array of objects (AttributeDTO)
commercialRuleCodes
Array of strings

list of codes of commercial rules

mediaCodes
Array of strings unique

list of the codes media

allowedOfferChange
Array of strings

list of allowed offer change

object (SubscriptionRenewalDto)
minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine labe value

minimumInvoiceSubCategory
string

Corresponding to minimum invoice subcategory

autoEndOfEngagement
boolean

indicate end of engagement

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

tagCodes
Array of strings unique

list of tag code

statusDate
string <date-time>

last update status datetime

isModel
boolean

allowing to create,update and delete an offer from a model

offerModelCode
string

Offer template code

generateQuoteEdrPerProduct
boolean

allow to generate each edr per product

offerChangeRestricted
boolean
codeOnly
boolean

Responses

Response Schema:
status
required
string
Enum: "SUCCESS" "FAIL" "WARNING"

Tells whether the instance of this status object is ok or not

errorCode
object (ApiErrorCodeEnum)

error code

message
required
string

A detailed error message if applicable, can contain the entity id that was created

entityId
integer <int64>

The entity identifier after creation of an entity

entityCode
string

The entity code after creation of an entity

nrAffected
integer <int32>

Number of items/records affected by the action

Request samples

Content type
{
}

Response samples

Content type
{
}

Search offer template with a given code and validity dates

Search offer template with a given code and validity dates. If no validity dates are provided, an offer template valid on a current date will be returned.

Authorizations:
auth
path Parameters
offerTemplateCode
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"
loadOfferServiceTemplate
boolean
Default: false
loadOfferProductTemplate
boolean
Default: false
loadServiceChargeTemplate
boolean
Default: false
loadProductChargeTemplate
boolean
Default: false
loadAllowedDiscountPlan
boolean
Default: false

Responses

Response samples

Content type
{
}

Update offer template.

Update offer template.

Authorizations:
auth
path Parameters
offerTemplateCode
required
string

Add the offerTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
validFrom
string <date-time>
validTo
string <date-time>
newValidFrom
string <date-time>
newValidTo
string <date-time>
name
required
string
Array of objects (OfferTemplateCategoryDto)
Array of objects (ChannelDto)
Array of objects (DigitalResourceDto)
modelCode
string
lifeCycleStatus
required
string
Enum: "IN_STUDY" "IN_DESIGN" "IN_TEST" "ACTIVE" "LAUNCHED" "RETIRED" "OBSOLETE" "REJECTED"
object (CustomFieldsDto)

The custom fields

imagePath
string
imageBase64
string
Array of objects (LanguageDescriptionDto)
longDescription
string
Array of objects (LanguageDescriptionDto)
globalRatingScriptInstance
string
sellers
Array of strings
Array of objects (CustomerCategoryDto)
bomCode
string

the bom code

offerTemplateCategoryCode
string
Array of objects (OfferServiceTemplateDto)

list of the offer service templates

Array of objects (OfferProductTemplateDto)
Array of objects (OfferProductsDto)

list of The offer component

Array of objects (DiscountPlanDto)

list of The offer product template

Array of objects (OfferTemplateAttributeDTO)

list of attributes

Array of objects (AttributeDTO)
commercialRuleCodes
Array of strings

list of codes of commercial rules

mediaCodes
Array of strings unique

list of the codes media

allowedOfferChange
Array of strings

list of allowed offer change

object (SubscriptionRenewalDto)
minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine labe value

minimumInvoiceSubCategory
string

Corresponding to minimum invoice subcategory

autoEndOfEngagement
boolean

indicate end of engagement

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

tagCodes
Array of strings unique

list of tag code

statusDate
string <date-time>

last update status datetime

isModel
boolean

allowing to create,update and delete an offer from a model

offerModelCode
string

Offer template code

generateQuoteEdrPerProduct
boolean

allow to generate each edr per product

offerChangeRestricted
boolean
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

List offerTemplates matching a given criteria

List offerTemplates matching a given criteria

Authorizations:
auth
path Parameters
offerTemplateCode
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Create or update offer template based on a given code.

Create or update offer template based on a given code.

Authorizations:
auth
path Parameters
code
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Enable a Offer template with a given code

Enable a Offer template with a given code

Authorizations:
auth
path Parameters
code
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Access

Create a new access

Create a new access

Authorizations:
auth
Request Body schema:
code
string

code of the access

subscription
required
string

code of the subscription

subscriptionValidityDate
string <date-time>

code of existing

startDate
string <date-time>

start date of the access

endDate
string <date-time>

end date of the access

object (CustomFieldsDto)

The custom fields

disabled
boolean
subscriptionValidity
string <date-time>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create new or update an existing access

Create new or update an existing access

Authorizations:
auth
Request Body schema:
code
string

code of the access

subscription
required
string

code of the subscription

subscriptionValidityDate
string <date-time>

code of existing

startDate
string <date-time>

start date of the access

endDate
string <date-time>

end date of the access

object (CustomFieldsDto)

The custom fields

disabled
boolean
subscriptionValidity
string <date-time>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing access

Update an existing access

Authorizations:
auth
path Parameters
accessCode
required
string

Add the accessCode here

Request Body schema:
code
string

code of the access

subscription
required
string

code of the subscription

subscriptionValidityDate
string <date-time>

code of existing

startDate
string <date-time>

start date of the access

endDate
string <date-time>

end date of the access

object (CustomFieldsDto)

The custom fields

disabled
boolean
subscriptionValidity
string <date-time>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

List Access filtered by subscriptionCode.

List Access filtered by subscriptionCode.

Authorizations:
auth
query Parameters
subscriptionCode
string

Responses

Response samples

Content type
{
}

Search for an access with a given access code and subscription code.

Search for an access with a given access code and subscription code.

Authorizations:
auth
query Parameters
accessCode
string
subscriptionCode
string
subscriptionValidityDate
string <date-time>
startDate
string <date-time>
endDate
string <date-time>
usageDate
string <date-time>

Responses

Response samples

Content type
{
}

CountryIso

List countries ISO matching a given criteria

List countries ISO matching a given criteria

Authorizations:
auth

Responses

Creates a tradingCountry base from the supplied country code

Creates a tradingCountry base from the supplied country code. If the country code does not exists, a country and tradingCountry records are created

Authorizations:
auth
Request Body schema:
countryCode
string
description
string
Array of objects (LanguageDescriptionDto)
currencyCode
required
string
languageCode
required
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search country with a given country code.

Search country with a given country code.

Authorizations:
auth
query Parameters
countryCode
string

Responses

Response samples

Content type
{
}

Modify a country

Modify a country. Same input parameter as create. The country and tradingCountry are created if they don't exists. The operation fails if the tradingCountry is null.

Authorizations:
auth
path Parameters
countryIsoCode
required
string

Add the countryIsoCode here

Request Body schema:
countryCode
string
description
string
Array of objects (LanguageDescriptionDto)
currencyCode
required
string
languageCode
required
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Does not delete a country but the tradingCountry associated to it.

Does not delete a country but the tradingCountry associated to it.

Authorizations:
auth
path Parameters
countryCode
required
string

Responses

Response samples

Content type
{
}

AccountHierarchy

Update account hierarchy

Authorizations:
auth
path Parameters
accountHierarchyCode
required
string

Add the accountHierarchyCode here

Request Body schema:
email
required
string

email

customerId
string
customerCode
string

code of the customer

sellerCode
string

code of the seller

customerBrandCode
string

code of the customer brand

customerCategoryCode
string

code of the customer category

currencyCode
string

code of the currency

countryCode
string

code of the customer country

languageCode
string

code of the language

titleCode
string

code of the title

firstName
string

first name of the account user

lastName
string

last name of the account user

birthDate
string <date-time>

date of the birthday

phoneNumber
string

phone number

billingCycleCode
string

code of the billing cycle

address1
string

the first adresse, to be used for account

address2
string

the second adresse, to be used for account

address3
string

the third adresse, to be used for account

zipCode
string

zip code

state
string
city
string

city of the user account

usePrefix
boolean
invoicingThreshold
number
taxCategoryCode
string

Account tax category code - overrides the value from a customer category

Array of objects (DiscountPlanDto)

List of discount plans

discountPlansForTermination
Array of strings

List of discount plans to be disassociated in a billing account

object (CustomFieldsDto)

The custom fields

limit
integer <int32>
sortField
string
index
integer <int32>
Array of objects (PaymentMethodDto)

The payment methods

paymentMethod
integer <int32>
jobTitle
string

Job title. Account Entity

registrationNo
string

Registration number

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

customerAccountCheckThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold for customer Account

customerCheckThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold for customer

vatNo
string
mailingType
string

The mailing Type

emailTemplate
string

Email template

ccedEmails
string

cc Emails

object (MinimumAmountElDto)
customerInvoicingThreshold
number

The invoicing threshold for the customer

customerAccountInvoicingThreshold
number

The invoicing threshold for the customer account

thresholdPerEntity
boolean

check the threshold per entity/invoice for BA

customerAccountThresholdPerEntity
boolean
customerThresholdPerEntity
boolean
generalClientAccountCode
string

General client account code

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create account hierarchy

Authorizations:
auth
Request Body schema:
email
required
string

email

customerId
string
customerCode
string

code of the customer

sellerCode
string

code of the seller

customerBrandCode
string

code of the customer brand

customerCategoryCode
string

code of the customer category

currencyCode
string

code of the currency

countryCode
string

code of the customer country

languageCode
string

code of the language

titleCode
string

code of the title

firstName
string

first name of the account user

lastName
string

last name of the account user

birthDate
string <date-time>

date of the birthday

phoneNumber
string

phone number

billingCycleCode
string

code of the billing cycle

address1
string

the first adresse, to be used for account

address2
string

the second adresse, to be used for account

address3
string

the third adresse, to be used for account

zipCode
string

zip code

state
string
city
string

city of the user account

usePrefix
boolean
invoicingThreshold
number
taxCategoryCode
string

Account tax category code - overrides the value from a customer category

Array of objects (DiscountPlanDto)

List of discount plans

discountPlansForTermination
Array of strings

List of discount plans to be disassociated in a billing account

object (CustomFieldsDto)

The custom fields

limit
integer <int32>
sortField
string
index
integer <int32>
Array of objects (PaymentMethodDto)

The payment methods

paymentMethod
integer <int32>
jobTitle
string

Job title. Account Entity

registrationNo
string

Registration number

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

customerAccountCheckThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold for customer Account

customerCheckThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold for customer

vatNo
string
mailingType
string

The mailing Type

emailTemplate
string

Email template

ccedEmails
string

cc Emails

object (MinimumAmountElDto)
customerInvoicingThreshold
number

The invoicing threshold for the customer

customerAccountInvoicingThreshold
number

The invoicing threshold for the customer account

thresholdPerEntity
boolean

check the threshold per entity/invoice for BA

customerAccountThresholdPerEntity
boolean
customerThresholdPerEntity
boolean
generalClientAccountCode
string

General client account code

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Wallet

Create a new operation

Create a new operation

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
string
description
string
userAccount
string
subscription
string
walletTemplate
string
seller
string
chargeInstance
string
chargeInstanceId
integer <int64>
currency
string
type
string
Enum: "CREDIT" "DEBIT"
status
string
Enum: "OPEN" "TREATED" "CANCELED" "RESERVED" "F_TO_RERATE" "TO_RERATE" "RERATED" "SCHEDULED" "REJECTED"
ratingUnitDescription
string
pricePlanCode
string
taxCode
string
taxPercent
number
unitAmountWithoutTax
number
unitAmountWithTax
number
unitAmountTax
number
quantity
number
amountWithoutTax
number
amountWithTax
number
amountTax
number
parameter1
string
parameter2
string
parameter3
string
parameterExtra
string
orderNumber
string
startDate
string <date-time>
endDate
string <date-time>
operationDate
string <date-time>
subscriptionDate
string <date-time>
offerCode
string
rawAmountWithoutTax
number
rawAmountWithTax
number
object (WoRatedTransactionDto)
walletId
integer <int64>
object (CustomFieldsDto)

The custom fields

taxClassCode
string
sortIndex
integer <int32>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

List wallet operations matching a given criteria

List wallet operations matching a given criteria

Authorizations:
auth
query Parameters
withRTs
boolean
Default: false

Responses

User account management

List all user accounts.

Authorizations:
auth

Responses

Create a new user account

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

parentUserAccountCode
string
userAccountCodes
Array of strings
billingAccount
required
string
billingAccountDescription
string
customerAccount
string
customerAccountDescription
string
customer
string
customerDescription
string
subscriptionDate
string <date-time>
terminationDate
string <date-time>
status
string
Enum: "ACTIVE" "CANCELED" "TERMINATED" "CLOSED"
statusDate
string <date-time>
terminationReason
string
isConsumer
boolean
Array of objects (GDPRInfoDto)
object (SubscriptionsDto)
parentUserAccount
object (UserAccountDto) Recursive

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing user account

Authorizations:
auth
path Parameters
userAccountCode
required
string

Add the userAccountCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

parentUserAccountCode
string
userAccountCodes
Array of strings
billingAccount
required
string
billingAccountDescription
string
customerAccount
string
customerAccountDescription
string
customer
string
customerDescription
string
subscriptionDate
string <date-time>
terminationDate
string <date-time>
status
string
Enum: "ACTIVE" "CANCELED" "TERMINATED" "CLOSED"
statusDate
string <date-time>
terminationReason
string
isConsumer
boolean
Array of objects (GDPRInfoDto)
object (SubscriptionsDto)
parentUserAccount
object (UserAccountDto) Recursive

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing user account with a given code

Authorizations:
auth
path Parameters
userAccountCode
required
string

Responses

Response Schema:
status
required
string
Enum: "SUCCESS" "FAIL" "WARNING"

Tells whether the instance of this status object is ok or not

errorCode
object (ApiErrorCodeEnum)

error code

message
required
string

A detailed error message if applicable, can contain the entity id that was created

entityId
integer <int64>

The entity identifier after creation of an entity

entityCode
string

The entity code after creation of an entity

nrAffected
integer <int32>

Number of items/records affected by the action

Response samples

Content type
{
}

DiscountPlanItem

List DiscountPlanItems matching a given criteria

List DiscountPlanItems matching a given criteria

Authorizations:
auth

Responses

Create a new discount plan item.

Create a new discount plan item.

Authorizations:
auth
Request Body schema:
code
required
string

The code

discountPlanCode
required
string

Discount plan code

invoiceCategoryCode
string

Invoice category code

invoiceSubCategoryCode
string

Invoice sub category code

accountingCode
string
Deprecated

Accounting code

expressionEl
string

Expression to determine if discount applies

disabled
boolean

Is entity disabled. Value is ignored in Update action - use enable/disable API instead

discountPlanItemType
string
Default: "PERCENTAGE"
Enum: "PERCENTAGE" "FIXED"

Type of discount, whether absolute or percentage

discountValue
required
number

The absolute or percentage discount amount

discountValueEL
required
string

The absolute or percentage discount amount EL

targetAccountingArticleCodes
Array of strings unique

The target accounting article codes

pricePlanMatrixCode
string

Price plan matrix code

object (CustomFieldsDto)

The custom fields

allowToNegate
boolean
Default: false
  • If true, then allows to negate the amount of affected invoice lines
  • If fase, then amount for the discount line produce by the discount plan item cannot exceed the amount of discounted lines
description
string

description of discount plan item

priority
integer <int64>

The lower number, the higher the priority is

accountingArticleCode
string

accounting article code

applyByArticle
boolean

Apply by article

sequence
integer <int32>

defines the order in which discount plans are applied

lastDiscount
boolean

last discount

Responses

Request samples

Content type
"discountPlanItem[]"

Response samples

Content type
{
}

Find a discount plan item with a given code.

Find a discount plan item with a given code.

Authorizations:
auth
path Parameters
discountPlanItemCode
required
string

Responses

Response samples

Content type
{
}

update an existed discount plan item.

update an existed discount plan item.

Authorizations:
auth
path Parameters
discountPlanItemCode
required
string

Add the discountPlanItemCode here

Request Body schema:
code
required
string

The code

discountPlanCode
required
string

Discount plan code

invoiceCategoryCode
string

Invoice category code

invoiceSubCategoryCode
string

Invoice sub category code

accountingCode
string
Deprecated

Accounting code

expressionEl
string

Expression to determine if discount applies

disabled
boolean

Is entity disabled. Value is ignored in Update action - use enable/disable API instead

discountPlanItemType
string
Default: "PERCENTAGE"
Enum: "PERCENTAGE" "FIXED"

Type of discount, whether absolute or percentage

discountValue
required
number

The absolute or percentage discount amount

discountValueEL
required
string

The absolute or percentage discount amount EL

targetAccountingArticleCodes
Array of strings unique

The target accounting article codes

pricePlanMatrixCode
string

Price plan matrix code

object (CustomFieldsDto)

The custom fields

allowToNegate
boolean
Default: false
  • If true, then allows to negate the amount of affected invoice lines
  • If fase, then amount for the discount line produce by the discount plan item cannot exceed the amount of discounted lines
description
string

description of discount plan item

priority
integer <int64>

The lower number, the higher the priority is

accountingArticleCode
string

accounting article code

applyByArticle
boolean

Apply by article

sequence
integer <int32>

defines the order in which discount plans are applied

lastDiscount
boolean

last discount

Responses

Request samples

Content type
"discountPlanItem[]"

Response samples

Content type
{
}

remove a discount plan item by code.

remove a discount plan item by code.

Authorizations:
auth
path Parameters
discountPlanItemCode
required
string

Responses

Response samples

Content type
{
}

Enable a Discount plan item with a given code

Enable a Discount plan item with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Discount plan item with a given code

Disable a Discount plan item with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Customer account management

List all customer accounts.

Authorizations:
auth

Responses

Create a customer account

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customer
required
string
currency
required
string
language
required
string
status
string
Enum: "ACTIVE" "CLOSE"
creditCategory
string
dateStatus
string <date-time>
dateDunningLevel
string <date-time>
dunningLevel
string
Enum: "R0" "R1" "R2" "R3" "R4" "R5" "R6"
mandateIdentification
string
mandateDate
string <date-time>
balance
number
totalBalance
number
totalBalanceExigible
number
totalInvoiceBalance
number
accountBalance
number
creditBalance
number
terminationDate
string <date-time>
dueDateDelayEL
string
Array of objects (PaymentMethodDto)
excludedFromPayment
boolean
paymentMethod
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"
object (BillingAccountsDto)
Array of objects (AccountOperationDto)
invoicingThreshold
number
checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"
thresholdPerEntity
boolean
Array of objects (GDPRInfoDto)
generalClientAccountCode
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update a customer account

Authorizations:
auth
path Parameters
customerAccountCode
required
string

Add the customerAccountCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customer
required
string
currency
required
string
language
required
string
status
string
Enum: "ACTIVE" "CLOSE"
creditCategory
string
dateStatus
string <date-time>
dateDunningLevel
string <date-time>
dunningLevel
string
Enum: "R0" "R1" "R2" "R3" "R4" "R5" "R6"
mandateIdentification
string
mandateDate
string <date-time>
balance
number
totalBalance
number
totalBalanceExigible
number
totalInvoiceBalance
number
accountBalance
number
creditBalance
number
terminationDate
string <date-time>
dueDateDelayEL
string
Array of objects (PaymentMethodDto)
excludedFromPayment
boolean
paymentMethod
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"
object (BillingAccountsDto)
Array of objects (AccountOperationDto)
invoicingThreshold
number
checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"
thresholdPerEntity
boolean
Array of objects (GDPRInfoDto)
generalClientAccountCode
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Delete a customer account

Authorizations:
auth
path Parameters
customerAccountCode
required
string

Responses

Response samples

Content type
{
}

Chart

List Calendars matching a given criteria

List Calendars matching a given criteria

Authorizations:
auth

Responses

Create a new chart

Create a new chart

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
object (MeasurableQuantityDto)
width
string
height
string
style
string
styleClass
string
extender
string
visible
boolean
chartType
required
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a chart with a given code

Find a chart with a given code

Authorizations:
auth
path Parameters
chartCode
required
string

Responses

Response samples

Content type
{
}

Update an existing chart

Update an existing chart

Authorizations:
auth
path Parameters
chartCode
required
string

Add the chartCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
object (MeasurableQuantityDto)
width
string
height
string
style
string
styleClass
string
extender
string
visible
boolean
chartType
required
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing chart with a given code

Remove an existing chart with a given code

Authorizations:
auth
query Parameters
chartCode
string

Responses

Response samples

Content type
{
}

Enable a Chart with a given code

Enable a Chart with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Chart with a given code

Disable a Chart with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

PdfInvoice

Find a PDF invoice with a given invoice number and a customer account code.

Find a PDF invoice with a given invoice number and a customer account code.

Authorizations:
auth
query Parameters
invoiceNumber
string
customerAccountCode
string

Responses

Response samples

Content type
{
}

ProviderContact

List of provider contacts

List of provider contacts

Authorizations:
auth

Responses

Create a provider contact 

  Create a provider contact
Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

firstName
string
lastName
string
email
string
phone
string
mobile
string
fax
string
genericMail
string
object (AddressDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a provider contact with a given code

Search for a provider contact with a given code

Authorizations:
auth
path Parameters
providerContactCode
required
string

Responses

Response samples

Content type
{
}

Update an existing provider contact

Update an existing provider contact

Authorizations:
auth
path Parameters
providerContactCode
required
string

Add the providerContactCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

firstName
string
lastName
string
email
string
phone
string
mobile
string
fax
string
genericMail
string
object (AddressDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing provider contact with a given code

Remove an existing provider contact with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Customer management

List all customers.

Authorizations:
auth

Responses

Create a new customer

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customerCategory
required
string

The customer category

customerBrand
string

The customer brand

seller
string

the code of seller

mandateIdentification
string

The mandate identification

mandateDate
string <date-time>

The mandate date

object (CustomerAccountsDto)

Use for GET / LIST only

object (AdditionalDetailsDto)

additional detail

invoicingThreshold
number

Invoicing threshold - do not invoice for a lesser amount

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

thresholdPerEntity
boolean

check the threshold per entity/invoice

anonymizationDate
string <date-time>
Array of objects (GDPRInfoDto)

information GDPR

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing customer

Authorizations:
auth
path Parameters
customerCode
required
string

Add the customerCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customerCategory
required
string

The customer category

customerBrand
string

The customer brand

seller
string

the code of seller

mandateIdentification
string

The mandate identification

mandateDate
string <date-time>

The mandate date

object (CustomerAccountsDto)

Use for GET / LIST only

object (AdditionalDetailsDto)

additional detail

invoicingThreshold
number

Invoicing threshold - do not invoice for a lesser amount

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

thresholdPerEntity
boolean

check the threshold per entity/invoice

anonymizationDate
string <date-time>
Array of objects (GDPRInfoDto)

information GDPR

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove customer with a given code

Authorizations:
auth
path Parameters
customerCode
required
string

The customer code

Responses

Response samples

Content type
{
}

Title

List titles matching a given criteria

List titles matching a given criteria

Authorizations:
auth

Responses

Create a new title

Create a new title

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

isCompany
boolean
Default: false

indicate if the title is a company

Array of objects (LanguageDescriptionDto)

list of the language description

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a title with a given code

Search for a title with a given code

Authorizations:
auth
path Parameters
titleCode
required
string

Responses

Response samples

Content type
{
}

Update an existing title

Update an existing title

Authorizations:
auth
path Parameters
titleCode
required
string

Add the titleCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

isCompany
boolean
Default: false

indicate if the title is a company

Array of objects (LanguageDescriptionDto)

list of the language description

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove an existing title with a given code

Remove an existing title with a given code

Authorizations:
auth
path Parameters
titleCode
required
string

Responses

Response samples

Content type
{
}

Catalog

Gets a productChargeTemplate list.

Gets a productChargeTemplate list.

Authorizations:
auth

Responses

Create product charge template

Create product charge template

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update product charge template

Update product charge template

Authorizations:
auth
path Parameters
productChargeTemplateCode
required
string

Add the productChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Delete a single productChargeTemplate by its code

Delete a single productChargeTemplate by its code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Enable a Product charge template with a given code

Enable a Product charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Product charge template with a given code

Disable a Product charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Gets a productTemplates list.

Gets a productTemplates list.

Authorizations:
auth

Responses

Create product template

Create product template

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
validFrom
string <date-time>
validTo
string <date-time>
newValidFrom
string <date-time>
newValidTo
string <date-time>
name
required
string
Array of objects (OfferTemplateCategoryDto)
Array of objects (ChannelDto)
Array of objects (DigitalResourceDto)
modelCode
string
lifeCycleStatus
required
string
Enum: "IN_STUDY" "IN_DESIGN" "IN_TEST" "ACTIVE" "LAUNCHED" "RETIRED" "OBSOLETE" "REJECTED"
object (CustomFieldsDto)

The custom fields

imagePath
string
imageBase64
string
Array of objects (LanguageDescriptionDto)
longDescription
string
Array of objects (LanguageDescriptionDto)
globalRatingScriptInstance
string
sellers
Array of strings
Array of objects (CustomerCategoryDto)
required
Array of objects (ProductChargeTemplateDto)
object (BusinessProductModelDto)
Array of objects (WalletTemplateDto)
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update product template

Update product template

Authorizations:
auth
path Parameters
productTemplateCode
required
string

Add the productTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
validFrom
string <date-time>
validTo
string <date-time>
newValidFrom
string <date-time>
newValidTo
string <date-time>
name
required
string
Array of objects (OfferTemplateCategoryDto)
Array of objects (ChannelDto)
Array of objects (DigitalResourceDto)
modelCode
string
lifeCycleStatus
required
string
Enum: "IN_STUDY" "IN_DESIGN" "IN_TEST" "ACTIVE" "LAUNCHED" "RETIRED" "OBSOLETE" "REJECTED"
object (CustomFieldsDto)

The custom fields

imagePath
string
imageBase64
string
Array of objects (LanguageDescriptionDto)
longDescription
string
Array of objects (LanguageDescriptionDto)
globalRatingScriptInstance
string
sellers
Array of strings
Array of objects (CustomerCategoryDto)
required
Array of objects (ProductChargeTemplateDto)
object (BusinessProductModelDto)
Array of objects (WalletTemplateDto)
codeOnly
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Delete a single productTemplate by its code and validity dates

Delete a single productTemplate by its code and validity dates. If no validity dates are provided, a product template valid on a current date will be deleted.

Authorizations:
auth
path Parameters
code
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Enable a Product template with a given code

Enable a Product template with a given code

Authorizations:
auth
path Parameters
code
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Disable a Product template with a given code

Disable a Product template with a given code

Authorizations:
auth
path Parameters
code
required
string
query Parameters
validFrom
string <date-time>
validTo
string <date-time>

Responses

Response samples

Content type
{
}

Language

Creates tradingLanguage base on language code. If the language code does not exists, a language record is created.

Creates tradingLanguage base on language code. If the language code does not exists, a language record is created.

Authorizations:
auth
Request Body schema:
code
string
description
string
disabled
boolean
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Search language given a code.

Search language given a code.

Authorizations:
auth
path Parameters
languageCode
required
string

Responses

Response samples

Content type
{
}

modify a language

modify a language. Same input parameter as create. The language and trading Language are created if they don't exists. The operation fails if the tradingLanguage is null.

Authorizations:
auth
path Parameters
languageCode
required
string

Add the languageCode here

Request Body schema:
code
string
description
string
disabled
boolean
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Does not delete a language but the tradingLanguage associated to it.

Does not delete a language but the tradingLanguage associated to it.

Authorizations:
auth
path Parameters
languageCode
required
string

Responses

Response samples

Content type
{
}

Enable a Trading language with a given language code

Enable a Trading language with a given language code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Trading language with a given language code

Disable a Trading language with a given language code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Billing account management

List all billing accounts.

Authorizations:
auth

Responses

Create a new billing account

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customerAccount
required
string

The customer account

billingCycle
required
string

The billing cycle

country
required
string

The country

tradingCurrency
string

The trading currency

language
required
string

The language

nextInvoiceDate
string <date-time>

The next invoice date

subscriptionDate
string <date-time>

The subscription date

terminationDate
string <date-time>

The termination date

electronicBilling
boolean

The electronic billing

status
string
Enum: "ACTIVE" "CANCELED" "TERMINATED" "CLOSED"

The status of billing account

statusDate
string <date-time>

The status date, it set automatically when the status was changed

terminationReason
string

The termination reason

email
string

The email

Array of objects (InvoiceDto)

list of the invoice

invoicingThreshold
number

The invoicing threshold

phone
string

The phone

minimumInvoiceSubCategory
string

Minimum Invoice SubCategory

paymentMethodType
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

Field was deprecated in 4.6 version. Use 'paymentMethods' field on CustomerAccount entity instead

object (BankCoordinatesDto)

Bank account information

paymentTerms
string

Field was deprecated in 4.6 version. Use custom fields instead

object (UserAccountsDto)

Use for GET / LIST only

Array of objects (DiscountPlanDto)

List of discount plans. Use in instantiating a discount plan instance

discountPlansForTermination
Array of strings

List of discount plans to be disassociated in a BillingAccount

Array of objects (DiscountPlanInstanceDto)

Use to return the active discount plans for this entity

mailingType
string

Mailing type

emailTemplate
string

Email Template code

ccedEmails
string

list of emails separated by comma

taxCategoryCode
string

Account tax category code - overrides the value from a customer category

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

Array of objects (GDPRInfoDto)

List of GDPR related to billing account

object (PaymentMethodDto)
thresholdPerEntity
boolean

check the threshold per entity/invoice for BA

primaryContact
string

The primary contact

tagCodes
Array of strings unique

list of the code of tags

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update existing billing account

Authorizations:
auth
path Parameters
billingAccountCode
required
string

Add the billingAccountCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

externalRef1
string

The external ref 1

externalRef2
string

The external ref 2

object (NameDto)

The name

object (AddressDto)
jobTitle
string

The job title

object (BusinessEntityDto)
object (CustomFieldsDto)

The custom fields

loaded
boolean
vatNo
string

The vat no

registrationNo
string

The registration no

object (ContactInformationDto)

The contact information

minimumAmountEl
string

Expression to determine minimum amount value

minimumLabelEl
string

Expression to determine rated transaction description to reach minimum amount value

minimumTargetAccount
string

The billing account code to be used when calculating the min amount billable for Customer and CA

minimumAmountElSpark
string

Expression to determine minimum amount value - for Spark

minimumLabelElSpark
string

Expression to determine rated transaction description to reach minimum amount value - for Spark

minimumChargeTemplate
string

Corresponding to minimum one shot charge template code

isCompany
boolean

indicate if this is a company

object (TitleDto)

The legal entity type

customerAccount
required
string

The customer account

billingCycle
required
string

The billing cycle

country
required
string

The country

tradingCurrency
string

The trading currency

language
required
string

The language

nextInvoiceDate
string <date-time>

The next invoice date

subscriptionDate
string <date-time>

The subscription date

terminationDate
string <date-time>

The termination date

electronicBilling
boolean

The electronic billing

status
string
Enum: "ACTIVE" "CANCELED" "TERMINATED" "CLOSED"

The status of billing account

statusDate
string <date-time>

The status date, it set automatically when the status was changed

terminationReason
string

The termination reason

email
string

The email

Array of objects (InvoiceDto)

list of the invoice

invoicingThreshold
number

The invoicing threshold

phone
string

The phone

minimumInvoiceSubCategory
string

Minimum Invoice SubCategory

paymentMethodType
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

Field was deprecated in 4.6 version. Use 'paymentMethods' field on CustomerAccount entity instead

object (BankCoordinatesDto)

Bank account information

paymentTerms
string

Field was deprecated in 4.6 version. Use custom fields instead

object (UserAccountsDto)

Use for GET / LIST only

Array of objects (DiscountPlanDto)

List of discount plans. Use in instantiating a discount plan instance

discountPlansForTermination
Array of strings

List of discount plans to be disassociated in a BillingAccount

Array of objects (DiscountPlanInstanceDto)

Use to return the active discount plans for this entity

mailingType
string

Mailing type

emailTemplate
string

Email Template code

ccedEmails
string

list of emails separated by comma

taxCategoryCode
string

Account tax category code - overrides the value from a customer category

checkThreshold
string
Enum: "BEFORE_DISCOUNT" "AFTER_DISCOUNT" "POSITIVE_RT" "POSITIVE_IL"

The option on how to check the threshold

Array of objects (GDPRInfoDto)

List of GDPR related to billing account

object (PaymentMethodDto)
thresholdPerEntity
boolean

check the threshold per entity/invoice for BA

primaryContact
string

The primary contact

tagCodes
Array of strings unique

list of the code of tags

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove a billing account with a Billing Account Code

Authorizations:
auth
path Parameters
billingAccountCode
required
string

Responses

Response samples

Content type
{
}

Price Plan

List all price plans.

Authorizations:
auth

Responses

create a price plan

create a price plan matrix

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
eventCode
required
string

The event code

seller
string

The seller code

country
string

The country code

currency
string

The currency code

minQuantity
number

The min quantity

maxQuantity
number

The max quantity

offerTemplate
string

The offer template code

object (OfferTemplateDto)
startSubscriptionDate
string <date-time>

The start subscription date

endSubscriptionDate
string <date-time>

The end subscription date

startRatingDate
string <date-time>

The start rating date

endRatingDate
string <date-time>

The end rating date

minSubscriptionAgeInMonth
integer <int64>

The min subscription age in month

maxSubscriptionAgeInMonth
integer <int64>

The max subscription age in month

amountWithoutTax
number

The amount without tax

amountWithTax
number

The amount with tax

amountWithoutTaxEL
string

The amount without tax EL

amountWithTaxEL
string

The amount with tax EL

minimumAmountWithoutTaxEl
string

The minimum amount without tax el

minimumAmountWithTaxEl
string

The minimum amount with tax el

priority
integer <int32>

The priority

criteria1
string

The criteria 1

criteria2
string

The criteria 2

criteria3
string

The criteria 3

criteriaEL
string

The criteria EL

validityCalendarCode
string

The validity calendar code

scriptInstance
string

The script instance

object (CustomFieldsDto)

The custom fields

Array of objects (LanguageDescriptionDto)
woDescriptionEL
string
ratingWithTaxEL
string [ 0 .. 2000 ] characters
ratingWithoutTaxEL
string [ 0 .. 2000 ] characters

Expression to calculate price without tax

invoiceSubCategoryEL
string

Expression for getting the InvoiceSubCategory

totalAmountEL
string

Expression to calculate price with/without tax. It overrides quantity x unitPrice when set

minimumAmountEL
string

Minimum allowed amount for a walletOperation. If this amount is less than the walletOperation this amount is save and the old value is save in rawAmount

parameter1El
string

An El expression used to override wallet operation's parameter1El

parameter2El
string

An El expression used to override wallet operation's parameter2El

parameter3El
string

An El expression used to override wallet operation's parameter3El

Responses

Request samples

Content type
{
}

find a price plan matrix with a given code

Find a price plan matrix with a given code

Authorizations:
auth
path Parameters
pricePlanCode
required
string

Responses

Response Schema:
object (ActionStatus)
object (PricePlanMatrixDto)

Response samples

Content type
{
}

Update an existing price plan matrix

Update an existing price plan matrix

Authorizations:
auth
path Parameters
pricePlanCode
required
string

Add the pricePlanCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
eventCode
required
string

The event code

seller
string

The seller code

country
string

The country code

currency
string

The currency code

minQuantity
number

The min quantity

maxQuantity
number

The max quantity

offerTemplate
string

The offer template code

object (OfferTemplateDto)
startSubscriptionDate
string <date-time>

The start subscription date

endSubscriptionDate
string <date-time>

The end subscription date

startRatingDate
string <date-time>

The start rating date

endRatingDate
string <date-time>

The end rating date

minSubscriptionAgeInMonth
integer <int64>

The min subscription age in month

maxSubscriptionAgeInMonth
integer <int64>

The max subscription age in month

amountWithoutTax
number

The amount without tax

amountWithTax
number

The amount with tax

amountWithoutTaxEL
string

The amount without tax EL

amountWithTaxEL
string

The amount with tax EL

minimumAmountWithoutTaxEl
string

The minimum amount without tax el

minimumAmountWithTaxEl
string

The minimum amount with tax el

priority
integer <int32>

The priority

criteria1
string

The criteria 1

criteria2
string

The criteria 2

criteria3
string

The criteria 3

criteriaEL
string

The criteria EL

validityCalendarCode
string

The validity calendar code

scriptInstance
string

The script instance

object (CustomFieldsDto)

The custom fields

Array of objects (LanguageDescriptionDto)
woDescriptionEL
string
ratingWithTaxEL
string [ 0 .. 2000 ] characters
ratingWithoutTaxEL
string [ 0 .. 2000 ] characters

Expression to calculate price without tax

invoiceSubCategoryEL
string

Expression for getting the InvoiceSubCategory

totalAmountEL
string

Expression to calculate price with/without tax. It overrides quantity x unitPrice when set

minimumAmountEL
string

Minimum allowed amount for a walletOperation. If this amount is less than the walletOperation this amount is save and the old value is save in rawAmount

parameter1El
string

An El expression used to override wallet operation's parameter1El

parameter2El
string

An El expression used to override wallet operation's parameter2El

parameter3El
string

An El expression used to override wallet operation's parameter3El

Responses

Request samples

Content type
{
}

Remove an existing price plan matrix with a given code

Remove an existing price plan matrix with a given code

Authorizations:
auth
path Parameters
pricePlanCode
required
string

The price plan code

Responses

Response Schema:
status
required
string
Enum: "SUCCESS" "FAIL" "WARNING"

Tells whether the instance of this status object is ok or not

errorCode
object (ApiErrorCodeEnum)

error code

message
required
string

A detailed error message if applicable, can contain the entity id that was created

entityId
integer <int64>

The entity identifier after creation of an entity

entityCode
string

The entity code after creation of an entity

nrAffected
integer <int32>

Number of items/records affected by the action

Response samples

Content type
{
}

Enable a Price plan with a given code

Enable a Price plan with a given code

Authorizations:
auth
path Parameters
code
required
string

The price plan code

Responses

Disable a Price plan with a given code

Disable a Price plan with a given code

Authorizations:
auth
path Parameters
code
required
string

The price plan code

Responses

OfferTemplateCategory

List DiscountPlanItems matching a given criteria

List DiscountPlanItems matching a given criteria

Authorizations:
auth

Responses

Create a new offer template category

Create a new offer template category

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
name
string
offerTemplateCategoryCode
string
href
string
version
integer <int32>
lastModified
string <date-time>
active
boolean
parentId
integer <int64>
imagePath
string
imageBase64
string
object (CustomFieldsDto)

The custom fields

Array of objects (LanguageDescriptionDto)
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a offer template category with a given code

Find a offer template category with a given code

Authorizations:
auth
path Parameters
offerTemplateCategoryCode
required
string

Responses

Response samples

Content type
{
}

Update an existing offer template category

Update an existing offer template category

Authorizations:
auth
path Parameters
offerTemplateCategoryCode
required
string

Add the offerTemplateCategoryCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
name
string
offerTemplateCategoryCode
string
href
string
version
integer <int32>
lastModified
string <date-time>
active
boolean
parentId
integer <int64>
imagePath
string
imageBase64
string
object (CustomFieldsDto)

The custom fields

Array of objects (LanguageDescriptionDto)
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Enable a Offer template category with a given code

Enable a Offer template category with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Disable a Offer template category with a given code

Disable a Offer template category with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

DiscountPlan

listGetAll_3

Authorizations:
auth

Responses

Create a new discount plan

Create a new discount plan

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
startDate
string <date-time>

Effective start date

endDate
string <date-time>

Effective end date

defaultDuration
integer <int32>

Length of effectivity.
If start date is not null and end date is null, we use the defaultDuration from the discount plan.
If start date is null, and defaultDuration is not null, defaultDuration is ignored.

durationUnit
string
Enum: "MONTH" "DAY"

Unit of duration

object (CustomFieldsDto)

The custom fields

Array of objects (DiscountPlanItemDto)

list of discount plan item

expressionEl
string

expression language

discountPlanType
required
string
Enum: "QUOTE" "OFFER" "PRODUCT" "INVOICE" "INVOICE_LINE" "PROMO_CODE"

Type of the discount plan. Defines on which entity the discount plan can be applied

status
string
Enum: "ACTIVE" "INACTIVE" "DRAFT" "IN_USE" "EXPIRED"

Status of the discount plan. The default value is DRAFT

statusDate
string <date-time>

Datetime of last status update, Automatically filed at creation and status update

initialQuantity
integer <int64>

The initial available quantity for the discount plan, For types QUOTE, INVOICE, INVOICE_LINE, the value is forced to 0

usedQuantity
integer <int64>

How many times the discount plan has been used.
If intialQuantity is not 0, then reaching the initialQuantity expires the discount plan.
The value is incremented every time the discountPlan is instantiated on any Billing Account, Subscription, or ProductInstance

applicationLimit
integer <int64>

How many times the discount can be applied on a given entity (BillingAccount, Subscription, Product Instance).
Default value is 0 = infinite.
Useful for one-time discounts.

applicationFilterEL
string

A boolean EL that must evaluate to true to allow the discount plan to be applied
It will have access to the variables.
entity: the entity on which we want to apply the discount

incompatibleDiscountPlans
Array of objects (DiscountPlanDto)

A list of discounts plans that cannot be active at the same time on an entity instance.

Array of objects (ApplicableEntityDto)

A list of entities (CustomerCategory, Offer, Product, Article).

applicableOnOverriddenPrice
boolean
sequence
integer <int32>

defines the order in which discount plans are applied

applicableOnDiscountedPrice
boolean

determines whether the discount plan is applicable on the gross or discounted amount

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find a discount plan with a given code

Find a discount plan with a given code

Authorizations:
auth
path Parameters
discountPlanCode
required
string

Responses

Response samples

Content type
{
}

Update an existing discount plan

Update an existing discount plan

Authorizations:
auth
path Parameters
discountPlanCode
required
string

Add the discountPlanCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
startDate
string <date-time>

Effective start date

endDate
string <date-time>

Effective end date

defaultDuration
integer <int32>

Length of effectivity.
If start date is not null and end date is null, we use the defaultDuration from the discount plan.
If start date is null, and defaultDuration is not null, defaultDuration is ignored.

durationUnit
string
Enum: "MONTH" "DAY"

Unit of duration

object (CustomFieldsDto)

The custom fields

Array of objects (DiscountPlanItemDto)

list of discount plan item

expressionEl
string

expression language

discountPlanType
required
string
Enum: "QUOTE" "OFFER" "PRODUCT" "INVOICE" "INVOICE_LINE" "PROMO_CODE"

Type of the discount plan. Defines on which entity the discount plan can be applied

status
string
Enum: "ACTIVE" "INACTIVE" "DRAFT" "IN_USE" "EXPIRED"

Status of the discount plan. The default value is DRAFT

statusDate
string <date-time>

Datetime of last status update, Automatically filed at creation and status update

initialQuantity
integer <int64>

The initial available quantity for the discount plan, For types QUOTE, INVOICE, INVOICE_LINE, the value is forced to 0

usedQuantity
integer <int64>

How many times the discount plan has been used.
If intialQuantity is not 0, then reaching the initialQuantity expires the discount plan.
The value is incremented every time the discountPlan is instantiated on any Billing Account, Subscription, or ProductInstance

applicationLimit
integer <int64>

How many times the discount can be applied on a given entity (BillingAccount, Subscription, Product Instance).
Default value is 0 = infinite.
Useful for one-time discounts.

applicationFilterEL
string

A boolean EL that must evaluate to true to allow the discount plan to be applied
It will have access to the variables.
entity: the entity on which we want to apply the discount

incompatibleDiscountPlans
Array of objects (DiscountPlanDto)

A list of discounts plans that cannot be active at the same time on an entity instance.

Array of objects (ApplicableEntityDto)

A list of entities (CustomerCategory, Offer, Product, Article).

applicableOnOverriddenPrice
boolean
sequence
integer <int32>

defines the order in which discount plans are applied

applicableOnDiscountedPrice
boolean

determines whether the discount plan is applicable on the gross or discounted amount

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

List DiscountPlans matching a given criteria

List DiscountPlans matching a given criteria

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Enable a Discount plan with a given code

Enable a Discount plan with a given code

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

Subscription

List subscriptions matching a given criteria

List subscriptions matching a given criteria

Authorizations:
auth

Responses

Create a subscription. It does not activate it

Create a subscription. It does not activate it

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

versionNumber
required
integer <int32>
nextVersion
integer <int64>
previousVersion
integer <int64>
userAccount
required
string
offerTemplate
required
string
subscriptionDate
required
string <date-time>
terminationDate
string <date-time>
endAgreementDate
string <date-time>
status
string
Enum: "CREATED" "ACTIVE" "CANCELED" "RESILIATED" "CLOSED" "SUSPENDED" "PENDING"
statusDate
string <date-time>
validityDate
string <date-time>
object (CustomFieldsDto)

The custom fields

object (AccessesDto)
object (ServiceInstancesDto)
object (ProductsDto)
Array of objects (ProductInstanceDto)
Array of objects (ProductToInstantiateDto)
terminationReason
string
orderNumber
string
minimumAmountEl
string
minimumLabelEl
string
minimumInvoiceSubCategory
string
minimumChargeTemplate
string
subscribedTillDate
string <date-time>
renewed
boolean
renewalNotifiedDate
string <date-time>
object (SubscriptionRenewalDto)
billingCycle
required
string
seller
required
string

Seller code

autoEndOfEngagement
boolean
ratingGroup
string
electronicBilling
boolean
email
string
mailingType
string
emailTemplate
string
ccedEmails
string
Array of objects (DiscountPlanDto)
discountPlansForTermination
Array of strings
Array of objects (DiscountPlanInstanceDto)
object (PaymentMethodDto)
customerService
string
salesPersonName
string

The sales person name

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a subscription with a given code.

Search for a subscription with a given code.

Authorizations:
auth
path Parameters
subscriptionCode
required
string
query Parameters
mergedCF
boolean
Default: false
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"
validityDate
string <date-time>

Responses

Response samples

Content type
{
}

Updates a subscription. It cannot update a subscription with status=RESILIATED

Updates a subscription. It cannot update a subscription with status=RESILIATED

Authorizations:
auth
path Parameters
subscriptionCode
required
string

Add the subscriptionCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

versionNumber
required
integer <int32>
nextVersion
integer <int64>
previousVersion
integer <int64>
userAccount
required
string
offerTemplate
required
string
subscriptionDate
required
string <date-time>
terminationDate
string <date-time>
endAgreementDate
string <date-time>
status
string
Enum: "CREATED" "ACTIVE" "CANCELED" "RESILIATED" "CLOSED" "SUSPENDED" "PENDING"
statusDate
string <date-time>
validityDate
string <date-time>
object (CustomFieldsDto)

The custom fields

object (AccessesDto)
object (ServiceInstancesDto)
object (ProductsDto)
Array of objects (ProductInstanceDto)
Array of objects (ProductToInstantiateDto)
terminationReason
string
orderNumber
string
minimumAmountEl
string
minimumLabelEl
string
minimumInvoiceSubCategory
string
minimumChargeTemplate
string
subscribedTillDate
string <date-time>
renewed
boolean
renewalNotifiedDate
string <date-time>
object (SubscriptionRenewalDto)
billingCycle
required
string
seller
required
string

Seller code

autoEndOfEngagement
boolean
ratingGroup
string
electronicBilling
boolean
email
string
mailingType
string
emailTemplate
string
ccedEmails
string
Array of objects (DiscountPlanDto)
discountPlansForTermination
Array of strings
Array of objects (DiscountPlanInstanceDto)
object (PaymentMethodDto)
customerService
string
salesPersonName
string

The sales person name

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Activate a given Subscription.

Activate a given Subscription.

Authorizations:
auth
Request Body schema:
subscriptionCode
required
string

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Suspend an existing subscription

Suspend an existing subscription

Authorizations:
auth
Request Body schema:
subscriptionCode
required
string
subscriptionValidityDate
string <date-time>
actionDate
string <date-time>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update existing services

Update existing services

Authorizations:
auth
Request Body schema:
subscriptionCode
required
string
subscriptionValidityDate
string <date-time>
Array of objects (ServiceToUpdateDto)
autoEndOfEngagement
boolean
rateUntilDate
string <date-time>
minimumAmountEl
string
minimumLabelEl
string
Array of objects (AttributeInstanceDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Terminate a subscription. If subscription status is RESILIATED, an error is thrown

Terminate a subscription. If subscription status is RESILIATED, an error is thrown

Authorizations:
auth
Request Body schema:
subscriptionCode
required
string
subscriptionValidityDate
string <date-time>
terminationReason
required
string
terminationDate
required
string <date-time>

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

UsageChargeTemplate

listGetAll_6

Authorizations:
auth

Responses

Create new usage charge template.

Create new usage charge template.

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
filterParam1
string [ 0 .. 255 ] characters

first filter parameter

filterParam2
string [ 0 .. 255 ] characters

second filter parameter

filterParam3
string [ 0 .. 255 ] characters

third filter parameter

filterParam4
string [ 0 .. 255 ] characters

fourth filter parameter

priority
integer <int32>

The priority

triggerNextCharge
boolean

If set to true and (charge has no counter associated) then the next matching charge with the full quantity of the EDR

triggerNextChargeEL
string

Overrides the triggerNextCharge switch

usageQuantityAttributeCode
string

code of usage attribute quantity

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Find an existing usage charge template with a given code.

Find an existing usage charge template with a given code.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

Responses

Response samples

Content type
{
}

Update usage charge template.

Update usage charge template.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

Add the usageChargeTemplateCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
invoiceSubCategory
string

The invoice sub category

amountEditable
boolean

The amount can be editable

Array of objects (LanguageDescriptionDto)

list of the language description

inputUnitDescription
string
ratingUnitDescription
string
unitMultiplicator
number
inputUnitOfMeasureCode
string

code of unit measure

ratingUnitOfMeasureCode
string

code of rating unit of measure

inputUnitEL
string

input unit expression language

outputUnitEL
string

output unit expression language

unitNbDecimal
integer <int32>

EDR and WO quantity field value precision

roundingModeDtoEnum
string
Enum: "NEAREST" "DOWN" "UP" "HALF_EVEN"

EDR and WO quantity field value rounding

revenueRecognitionRuleCode
string

The revenue recognition rule code

filterExpression
string [ 0 .. 2000 ] characters

The filter expression

taxClassCode
string

code of tax class

taxClassEl
string

Expression to determine tax class

ratingScriptCode
string

Code of a rating script

object (CustomFieldsDto)

The custom fields

object (TriggeredEdrTemplatesDto)

The triggered edrs

dropZeroWo
boolean

Enable/disable removing WO rated to 0

sortIndexEl
string [ 0 .. 2000 ] characters

Sorting index EL

status
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

ChargeTemplate status

linkedAttributes
Array of strings
filterParam1
string [ 0 .. 255 ] characters

first filter parameter

filterParam2
string [ 0 .. 255 ] characters

second filter parameter

filterParam3
string [ 0 .. 255 ] characters

third filter parameter

filterParam4
string [ 0 .. 255 ] characters

fourth filter parameter

priority
integer <int32>

The priority

triggerNextCharge
boolean

If set to true and (charge has no counter associated) then the next matching charge with the full quantity of the EDR

triggerNextChargeEL
string

Overrides the triggerNextCharge switch

usageQuantityAttributeCode
string

code of usage attribute quantity

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Remove usage charge template with a given code.

Remove usage charge template with a given code.

Authorizations:
auth
path Parameters
usageChargeTemplateCode
required
string

The usage charge template code

Responses

Response samples

Content type
{
}

Enable a Usage charge template with a given code

Enable a Usage charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of the usage charge template to be enabled

Responses

Response samples

Content type
{
}

Disable a Usage charge template with a given code

Disable a Usage charge template with a given code

Authorizations:
auth
path Parameters
code
required
string

The code of the usage charge template to be disabeled

Responses

Response samples

Content type
{
}

Entity Customization

create entity template

Authorizations:
auth
Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
name
string
storeAsTable
boolean
storeInES
boolean
Array of objects (CustomFieldTemplateDto)
Array of objects (EntityCustomActionDto)
disableable
boolean
versioned
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

update entity template

Authorizations:
auth
path Parameters
entityCode
required
string

Add the entityCode here

Request Body schema:
id
integer <int64>
code
required
string

The code of the entity

description
string

The description of the entity

updatedCode
string

The changed code

disabled
boolean
name
string
storeAsTable
boolean
storeInES
boolean
Array of objects (CustomFieldTemplateDto)
Array of objects (EntityCustomActionDto)
disableable
boolean
versioned
boolean

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

delete entity template

Authorizations:
auth
path Parameters
customEntityTemplateCode
required
string

Responses

Response samples

Content type
{
}

enable entity template

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

disable entity template

Authorizations:
auth
path Parameters
code
required
string

Responses

Response samples

Content type
{
}

LanguageIso

List languages ISO matching a given criteria

List languages ISO matching a given criteria

Authorizations:
auth

Responses

Creates tradingLanguage base on language code. If the language code does not exists, a language record is created.

Creates tradingLanguage base on language code. If the language code does not exists, a language record is created.

Authorizations:
auth
Request Body schema:
code
string
description
string

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Search language given a code.

Search language given a code.

Authorizations:
auth
path Parameters
languageCode
required
string

Responses

Response samples

Content type
{
}

modify a language

modify a language. Same input parameter as create. The language and trading Language are created if they don't exists. The operation fails if the tradingLanguage is null.

Authorizations:
auth
path Parameters
languageCode
required
string

Add the languageCode here

Request Body schema:
code
string
description
string

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Does not delete a language but the tradingLanguage associated to it.

Does not delete a language but the tradingLanguage associated to it.

Authorizations:
auth
path Parameters
languageCode
required
string

Responses

Response samples

Content type
{
}