API docs by Redocly

STAQR Commerce OpenAPI definition Legacy API (1.0)

Download OpenAPI specification:

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

This Swagger documentation contains all Legacy API endpoints

Deprecated

Search for a billing account with a given code Deprecated

query Parameters
billingAccountCode
string
inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"
includeUserAccounts
boolean

Responses

Response samples

Content type
{
}

Create or update Billing Account based on cod Deprecated

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
{
}

filter counters by period date Deprecated

query Parameters
billingAccountCode
string
date
string <date-time>

Responses

Response samples

Content type
{
}

List BillingAccount filter by customerAccountCode Deprecated

query Parameters
customerAccountCode
string

Responses

Response samples

Content type
{
}

Get a customer account Deprecated

query Parameters
customerAccountCode
string
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
{
}

Create or update a customer account Deprecated

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
{
}

Filter counters by period date. Deprecated

query Parameters
customerAccountCode
string
date
string <date-time>

Responses

Response samples

Content type
{
}

List CustomerAccount filtered by customerCode Deprecated

query Parameters
customerCode
string

Responses

Response samples

Content type
{
}

Anonymization of a specific customer Deprecated

query Parameters
customerCode
string

The customer code

Responses

Response samples

Content type
{
}

Search for a customer with a given code Deprecated

query Parameters
customerCode
string

The customer code

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
{
}

Create a new customer brand Deprecated

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

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create a new customer category Deprecated

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

exoneratedFromTaxes
boolean

The exonerated from taxes

exonerationTaxEl
string

The exoneration tax el

exonerationReason
string

The exoneration reason

accountingCode
required
string

The accounting code

taxCategoryCode
string

Account tax category code

taxCategoryEl
string

Expression to determine tax category code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create new or update existing customer Deprecated

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
{
}

Create new or update an existing customer brand Deprecated

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

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create new or update an existing customer category Deprecated

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

exoneratedFromTaxes
boolean

The exonerated from taxes

exonerationTaxEl
string

The exoneration tax el

exonerationReason
string

The exoneration reason

accountingCode
required
string

The accounting code

taxCategoryCode
string

Account tax category code

taxCategoryEl
string

Expression to determine tax category code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Exports an account hierarchy given a specific customer Deprecated

query Parameters
customerCode
string

The customer code

Responses

Response samples

Content type
{
}

Filter counters by period date

query Parameters
customerCode
string

The customer code

date
required
string <date-time>

The date to compare

Responses

Response samples

Content type
{
}

List customers matching a given criteria Deprecated

query Parameters
query
string

query Search criteria

fields
string

fields Data retrieval options/fieldnames separated by a comma

offset
integer <int32>

offset Pagination - from record number

limit
integer <int32>

limit Pagination - number of records to retrieve

sortBy
string
Default: "code"

Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields

sortOrder
string
Default: "ASCENDING"
Enum: "ASCENDING" "DESCENDING"

sort order

inheritCF
string
Default: "INHERIT_NO_MERGE"
Enum: "INHERIT_NONE" "INHERIT_NO_MERGE" "INHERIT_MERGED" "ACCUMULATED"

Should inherited custom fields be retrieved. Defaults to INHERIT_NO_MERGE

Responses

Response samples

Content type
{
}

List customers matching a given criteria Deprecated

Request Body schema:
fullTextFilter
string

Full text search filter. Mutually exclusive with filters attribute. fullTextFilter has priority

object

Search filters (key = Filter key, value = search pattern or value).

fields
string

Data retrieval options/fieldnames separated by a comma

offset
integer <int32>

Pagination - from record number

limit
integer <int32>

Pagination - number of items to retrieve

sortBy
string

Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields

sortOrder
string
Enum: "ASCENDING" "DESCENDING"

Sorting - sort ordee

multiSortOrder
string
totalNumberOfRecords
integer <int32>
loadReferenceDepth
integer <int32>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Update an existing customer brand Deprecated

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

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing customer category Deprecated

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

exoneratedFromTaxes
boolean

The exonerated from taxes

exonerationTaxEl
string

The exoneration tax el

exonerationReason
string

The exoneration reason

accountingCode
required
string

The accounting code

taxCategoryCode
string

Account tax category code

taxCategoryEl
string

Expression to determine tax category code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Billing account management

Update existing billing account

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
{
}

Create a new billing account

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
{
}

Search for a billing account with a given code

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
{
}

Remove a billing account with a Billing Account Code

path Parameters
billingAccountCode
required
string

Responses

Response samples

Content type
{
}

List all billing accounts.

Responses

Response samples

Content type
{
}

Application

Get version of application

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
{
}

Get version of application

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
{
}

Get version of application

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
{
}

Customer account management

Update a customer account

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
{
}

Create a customer account

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
{
}

Create a credit category

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
{
}

Get a customer account

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
{
}

Delete a customer account

path Parameters
customerAccountCode
required
string

Responses

Response samples

Content type
{
}

List all customer accounts.

Responses

Response samples

Content type
{
}

Transfer an amount from one customer to another

Request Body schema:
fromCustomerAccountCode
required
string
toCustomerAccountCode
required
string
amount
number

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Customer management

Update an existing customer

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
{
}

Create a new customer

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 brand

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

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create a new customer brand

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

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Update an existing customer category

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

exoneratedFromTaxes
boolean

The exonerated from taxes

exonerationTaxEl
string

The exoneration tax el

exonerationReason
string

The exoneration reason

accountingCode
required
string

The accounting code

taxCategoryCode
string

Account tax category code

taxCategoryEl
string

Expression to determine tax category code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Create a new customer category

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

exoneratedFromTaxes
boolean

The exonerated from taxes

exonerationTaxEl
string

The exoneration tax el

exonerationReason
string

The exoneration reason

accountingCode
required
string

The accounting code

taxCategoryCode
string

Account tax category code

taxCategoryEl
string

Expression to determine tax category code

Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Updates a new customer sequence with a given code.

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

object (GenericSequenceDto)
seller
required
string

Code of the seller

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Creates a new customer sequence

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

object (GenericSequenceDto)
seller
required
string

Code of the seller

Responses

Request samples

Content type
{
}

Response samples

Content type
{
}

Search for a customer with a given code

path Parameters
customerCode
required
string

The customer code

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
{
}

Remove customer with a given code

path Parameters
customerCode
required
string

The customer code

Responses

Response samples

Content type
{
}

Update the Provider's customer number sequence configuration

Request Body schema:
prefix
string^[\p{Upper}-]{1,16}$

Prefix of sequence

sequenceSize
integer <int64>

Size of the sequence. Maximum allowable for RUM is 35

currentSequenceNb
integer <int64>

Current value of the sequence

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

Calculates and returns the next value of the mandate number

Responses

Response samples

Content type
{
}

List all customers.

Responses

Response samples

Content type
{
}

List customers matching a given criteria

Request Body schema:
fullTextFilter
string

Full text search filter. Mutually exclusive with filters attribute. fullTextFilter has priority

object

Search filters (key = Filter key, value = search pattern or value).

fields
string

Data retrieval options/fieldnames separated by a comma

offset
integer <int32>

Pagination - from record number

limit
integer <int32>

Pagination - number of items to retrieve

sortBy
string

Sorting - field to sort by - a field from a main entity being searched. See Data model for a list of fields

sortOrder
string
Enum: "ASCENDING" "DESCENDING"

Sorting - sort ordee

multiSortOrder
string
totalNumberOfRecords
integer <int32>
loadReferenceDepth
integer <int32>

Responses

Request samples

Content type
{ }

Response samples

Content type
{
}

list47

query Parameters
firstRow
integer <int32>

from record number. Deprecated in v.4.7, use 'from' instead

numberOfRows
integer <int32>

Pagination - number of records to retrieve. Deprecated in v.4.7, use 'limit' instead

offset
integer <int32>

Pagination - from record number

limit
integer <int32>

Pagination - number of records to retrieve

sortBy
string
Default: "c.code"

sort by field

sortOrder
string
Default: "ASCENDING"
Enum: "ASCENDING" "DESCENDING"

sort Order

Request Body schema:

The customer's data

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
{
}