Skip to main content
API docs by Redocly

STAQR Commerce OpenAPI definition V2 (1.0)

Download OpenAPI specification:Download

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

This Swagger documentation contains STAQR Commerce API v2 endpoints

AccountingPeriods

Create a new AccountingPeriod

Create a new AccountingPeriod

Request Body schema: application/json
required

the AccountingPeriod input object

startDate
string <date-time>

Indicate the start date

endDate
string <date-time>

Indicate the end date

subAccountingPeriodType
string

Indicate the SubAccountingPeriod type

regularUserLockOption
string

Indicate the RegularUserLockOption

customLockNumberDays
integer <int32>

Indicate the CustomLockNumberDays

customLockOption
string

Indicate the CustomLockOption

accountingOperationAction
string

Indicate the AccountingOperationAction

forceCustomDay
integer <int32>

Indicate the ForceCustomDay

forceOption
string

Indicate the ForceOption

fiscalYear
string

Indicate the fiscal year

useSubAccountingPeriods
boolean

Indicate if use SubAccountingPeriods

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "subAccountingPeriodType": "string",
  • "regularUserLockOption": "string",
  • "customLockNumberDays": 0,
  • "customLockOption": "string",
  • "accountingOperationAction": "string",
  • "forceCustomDay": 0,
  • "forceOption": "string",
  • "fiscalYear": "string",
  • "useSubAccountingPeriods": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Generate next AccountingPeriod

Generate next AccountingPeriod

Responses

update an new AccountingPeriod

Update an AccountingPeriod

path Parameters
fiscalYear
required
string

fiscalYear of the Invoice

Request Body schema: application/json
required

the AccountingPeriod input object

startDate
string <date-time>

Indicate the start date

endDate
string <date-time>

Indicate the end date

subAccountingPeriodType
string

Indicate the SubAccountingPeriod type

regularUserLockOption
string

Indicate the RegularUserLockOption

customLockNumberDays
integer <int32>

Indicate the CustomLockNumberDays

customLockOption
string

Indicate the CustomLockOption

accountingOperationAction
string

Indicate the AccountingOperationAction

forceCustomDay
integer <int32>

Indicate the ForceCustomDay

forceOption
string

Indicate the ForceOption

fiscalYear
string

Indicate the fiscal year

useSubAccountingPeriods
boolean

Indicate if use SubAccountingPeriods

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "subAccountingPeriodType": "string",
  • "regularUserLockOption": "string",
  • "customLockNumberDays": 0,
  • "customLockOption": "string",
  • "accountingOperationAction": "string",
  • "forceCustomDay": 0,
  • "forceOption": "string",
  • "fiscalYear": "string",
  • "useSubAccountingPeriods": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

update allUsers status

Update a SubaccountingPeriod

path Parameters
fiscalYear
required
string

fiscalYear of the Invoice

number
required
string

subaccounting period number

status
required
string

status

query Parameters
reason
string

reason of reopening sub-accounting period

Responses

update regularUsers status

Update a SubaccountingPeriod

path Parameters
fiscalYear
required
string

fiscalYear of the Invoice

number
required
string

subaccounting period number

status
required
string

status

query Parameters
reason
string

reason of reopening sub-accounting period

Responses

AuxiliaryCode

Get the auxiliary account information corresponding to the giver customer account

Returns auxiliary account information corresponding to the giver customer account

path Parameters
customerAccountCode
required
string

Responses

AccountOperation

Assign an account operation to a customer

Assign an account operation to a customer

path Parameters
id
required
integer <int64>

Account operation id

Request Body schema: application/json
required

Customer account

object (CustomerAccount)

Customer account

code
string

Customer account code

id
integer <int64>

Customer account id

Responses

Request samples

Content type
application/json
{
  • "customerAccount": {
    }
}

Post

Refund By SCT

set the accountingDate field by the value of transactionDate, and set account operations status to POSTED

Request Body schema: application/json
property name*
additional property
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

API to match Account operations

Process matching for AccountOperations

Request Body schema: application/json
required
Array of objects (AccountOperationAndSequence)

List of AccountOperation and Sequence for matching

Array
sequence
integer <int32>

Matching sequence

id
integer <int64>

AccountOperation Id

Responses

Request samples

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

Refund By SCT

set the accountingDate field by the value of transactionDate, and set account operations status to POSTED

Request Body schema: application/json
property name*
additional property
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

API to match Account operations

Process unMatching for AccountOperations

Request Body schema: application/json
required
Array of objects (UnMatchingAccountOperationDetail)

List of AccountOperation for matching

Array
matchingAmountIds
Array of integers <int64> [ items <int64 > ]

MatchingAmount Id

id
required
integer <int64>

AccountOperation Id

Responses

Request samples

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

Create a defferal Payment

Create a defferal Payment

Request Body schema: application/json
required

Deferral Payments information

paymentDate
string <date-time>
paymentMethod
string
accountOperationId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "paymentMethod": "string",
  • "accountOperationId": 0
}

Create Security Deposit settings

Create Security Deposit settings

Request Body schema: application/json
required

Security Deposit Settings

object (OpenOrderSettingInput)
maxAmountPerSecurityDeposit
number
maxAmountPerCustomer
number
auxiliaryAccountCodeEl
string

Auxiliary account code El

auxiliaryAccountLabelEl
string

Auxiliary account label El

activateDunning
boolean

Activate dunning

useSecurityDeposit
boolean

use security deposit

autoRefund
boolean

Auto refund

useAuxiliaryAccounting
boolean

Use auxiliary accounting

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "openOrderSetting": {
    },
  • "maxAmountPerSecurityDeposit": 0,
  • "maxAmountPerCustomer": 0,
  • "auxiliaryAccountCodeEl": "string",
  • "auxiliaryAccountLabelEl": "string",
  • "activateDunning": true,
  • "useSecurityDeposit": true,
  • "autoRefund": true,
  • "useAuxiliaryAccounting": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update Security Deposit settings

Update Security Deposit settings

path Parameters
id
required
integer <int64>

contain the code of Security deposit settings te be updated by its id

Request Body schema: application/json
required

Security Deposit Settings

object (OpenOrderSettingInput)
maxAmountPerSecurityDeposit
number
maxAmountPerCustomer
number
auxiliaryAccountCodeEl
string

Auxiliary account code El

auxiliaryAccountLabelEl
string

Auxiliary account label El

activateDunning
boolean

Activate dunning

useSecurityDeposit
boolean

use security deposit

autoRefund
boolean

Auto refund

useAuxiliaryAccounting
boolean

Use auxiliary accounting

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "openOrderSetting": {
    },
  • "maxAmountPerSecurityDeposit": 0,
  • "maxAmountPerCustomer": 0,
  • "auxiliaryAccountCodeEl": "string",
  • "auxiliaryAccountLabelEl": "string",
  • "activateDunning": true,
  • "useSecurityDeposit": true,
  • "autoRefund": true,
  • "useAuxiliaryAccounting": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Cancel Security Deposit

Cancel Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be canceled by its id

Request Body schema: application/json
required

Security Deposit input

cancelReason
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "cancelReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Create a Security Deposit

Create a Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Credit Security Deposit

Credit Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be credited by its id

Request Body schema: application/json
required

Security Deposit input

reference
required
string
amountToCredit
required
number
isToMatching
required
boolean
paymentInfo
required
string
paymentInfo1
required
string
paymentInfo2
required
string
paymentInfo3
required
string
paymentInfo4
required
string
paymentInfo5
required
string
paymentMethod
required
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"
customerAccountCode
required
string
occTemplateCode
required
string
bankLot
required
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "amountToCredit": 0,
  • "isToMatching": true,
  • "paymentInfo": "string",
  • "paymentInfo1": "string",
  • "paymentInfo2": "string",
  • "paymentInfo3": "string",
  • "paymentInfo4": "string",
  • "paymentInfo5": "string",
  • "paymentMethod": "CHECK",
  • "customerAccountCode": "string",
  • "occTemplateCode": "string",
  • "bankLot": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Instantiate Security Deposit

Instantiate Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Pay invoice manually with Security Deposit

Pay invoice manually with Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be the invoice with it

Request Body schema: application/json
required

Security Deposit input

amount
required
number
required
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "accountOperation": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Refund Security Deposit

Refund Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be refunded by its id

Request Body schema: application/json
required

Security Deposit input

refundReason
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "refundReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update Security Deposit

Update Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be updated by its id

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Create Security Deposit template

Create Security Deposit template

Request Body schema: application/json
required

Security Deposit Template

object (Resource)
status
required
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

The Status

maxAmount
number

The Max Amount

minAmount
number

The Min Amount

templateName
required
string

The Template Name

allowValidityDate
boolean

The Allow Validity Date

allowValidityPeriod
boolean

The Allow Validity Period

numberOfInstantiation
integer <int32>

The Number Of Instantiation

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "currency": {
    },
  • "status": "DRAFT",
  • "maxAmount": 0,
  • "minAmount": 0,
  • "templateName": "string",
  • "allowValidityDate": true,
  • "allowValidityPeriod": true,
  • "numberOfInstantiation": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update Security Deposit template

Update Security Deposit template

path Parameters
id
required
integer <int64>

contain the code of Security deposit template te be updated by its id

Request Body schema: application/json
required

Security Deposit template

object (Resource)
status
required
string
Enum: "DRAFT" "ACTIVE" "ARCHIVED"

The Status

maxAmount
number

The Max Amount

minAmount
number

The Min Amount

templateName
required
string

The Template Name

allowValidityDate
boolean

The Allow Validity Date

allowValidityPeriod
boolean

The Allow Validity Period

numberOfInstantiation
integer <int32>

The Number Of Instantiation

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "currency": {
    },
  • "status": "DRAFT",
  • "maxAmount": 0,
  • "minAmount": 0,
  • "templateName": "string",
  • "allowValidityDate": true,
  • "allowValidityPeriod": true,
  • "numberOfInstantiation": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Change status of Security Deposit Template

Change status of Security Deposit Template

Request Body schema: application/json
required

Security Deposit template List

status
required
string
required
Array of objects (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "securityDepositTemplates": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Global settings

Create Global settings

Request Body schema: application/json
required

Global settings

object (QuoteSettings)
object (Dunning)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "quoteSettings": {
    },
  • "dunning": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Global settings

Update Global settings

path Parameters
id
required
integer <int64>

Global settings id

Request Body schema: application/json
required

Global settings

object (QuoteSettings)
object (Dunning)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "quoteSettings": {
    },
  • "dunning": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Create Open Order settings

Create Open Order settings

Request Body schema: application/json
required

Open Order settings

useOpenOrders
boolean
applyMaximumValidity
boolean
applyMaximumValidityValue
integer <int32>
defineMaximumValidity
boolean
defineMaximumValidityValue
integer <int32>
applyMaximumValidityUnit
string
Enum: "Days" "Weeks" "Months" "Years"
useManagmentValidationForOOQuotation
boolean
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "useOpenOrders": true,
  • "applyMaximumValidity": true,
  • "applyMaximumValidityValue": 0,
  • "defineMaximumValidity": true,
  • "defineMaximumValidityValue": 0,
  • "applyMaximumValidityUnit": "Days",
  • "useManagmentValidationForOOQuotation": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

mark account operation as exported

mark account operation as exported

Request Body schema: application/json
required

id of the Invoice

status
string
Enum: "POSTED" "REJECTED" "EXPORTED" "EXPORT_FAILED"

new status of account operations

accountOperations
Array of integers <int64> [ items <int64 > ]

ids of account operations to update

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "status": "POSTED",
  • "accountOperations": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Create invoice lines

Create invoice lines

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json
required

invoice lines to create

skipValidation
boolean

Indicate if the invoice line will skip validation

Array of objects (InvoiceLine)

Responses

Request samples

Content type
application/json
{
  • "skipValidation": true,
  • "invoiceLines": [
    ]
}

Remove invoice lines

Remove invoice line

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json

invoice lines to remove

ids
Array of integers <int64> [ items <int64 > ]
skipValidation
boolean

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "skipValidation": true
}

calculate invoice

calculate invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Calucate subtotals

calculate sub total of invoice linked to invoice type

path Parameters
id
required
integer <int64>

Invoice identifier

Responses

Cancel invoice

Cancel invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

This API will allow creating adjustment based on an existing validated invoice.

This API will allow creating adjustment based on an existing validated invoice.
Either can we choose specific invoice lines from a specific invoice or the whole invoice to be used on the newly created adjustment.

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json
required

InvoiceLines to replicate

globalAdjustment
boolean
invoiceLinesIds
Array of integers <int64> [ items <int64 > ]

Containing list of invoice line Ids to replicate in the new adjustment.

Responses

Request samples

Content type
application/json
{
  • "globalAdjustment": true,
  • "invoiceLinesIds": [
    ]
}

this endpoint allow to duplicate invoice

duplicate invoice with the new status

path Parameters
invoicId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "actionStatus": {
    },
  • "paging": {
    },
  • "invoices": [
    ]
}

Duplicate invoice lines

Duplicate invoice lines

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json

invoice lines to remove

skipValidation
boolean
invoiceLineIds
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "skipValidation": true,
  • "invoiceLineIds": [
    ]
}

Launch all the invoicing process for a given billingAccount

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

Request Body schema: application/json
object (FilterDto)

Filters on RT

isDraft
boolean

Indicate if the invoice is DRAFT

billingAccountCode
string

Billing account code

object (CustomFieldsDto)

custom field associated the contact category

targetType
string

Billing Cycle Type

orderNumber
string

Order number

lastTransactionDate
string <date-time>

Last transaction date

invoicingDate
string <date-time>

Invoicing date

firstTransactionDate
string <date-time>

First transaction date

applyMinimum
string

Apply mode for invoice minimum rules

openOrderCode
string

OpenOrder code

targetCode
string

Target entity code

code
string
Array of objects
id
integer <int64>
applyBillingRules
boolean

Apply Billing Rules

includeRatedTransactions
boolean

Includes rated transactions in the return value

skipValidation
boolean

Indicate if validation is skipped

generateXML
boolean

Generate XML

generatePDF
boolean

Generate PDF

generateAO
boolean

Generate AO

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "isDraft": true,
  • "billingAccountCode": "string",
  • "customFields": {
    },
  • "targetType": "possible value are: BILLINGACCOUNT, SUBSCRIPTION, ORDER",
  • "orderNumber": "string",
  • "lastTransactionDate": "2019-08-24T14:15:22Z",
  • "invoicingDate": "2019-08-24T14:15:22Z",
  • "firstTransactionDate": "2019-08-24T14:15:22Z",
  • "applyMinimum": "string",
  • "openOrderCode": "string",
  • "targetCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "applyBillingRules": true,
  • "includeRatedTransactions": true,
  • "skipValidation": true,
  • "generateXML": true,
  • "generatePDF": true,
  • "generateAO": true
}

Response samples

Content type
application/json
{
  • "comment": "string",
  • "description": "string",
  • "order": {
    },
  • "statusDate": "2019-08-24T14:15:22Z",
  • "status": "possible value are : <ul><li> NEW : invoice entity has been created but incomplete </li><li>SUSPECT : invoice has been marked as suspect by automatic controls (this status doesn’t block automatic generation)</li><li>REJECTED : invoice has been rejected by automatic controls (this status block automatic generation)</li><li>DRAFT : invoice is complete but not validated. It can be edited.</li><li>CANCELED : invoice has been canceled (all related rated transactions are released. This is a final status)</li><li>VALIDATED : invoice is validated and cannot be edited anymore (this a final status)</li></ul>",
  • "quote": {
    },
  • "discountPlan": {
    },
  • "sellerCode": "string",
  • "billingAccountCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "alias": "string",
  • "subscription": {
    },
  • "discountRate": 0,
  • "paymentStatus": "possible value are : <ul><li>NONE : invoice has no payment status, no AO created.</li><li>PENDING : AO created, due date is still in the future</li><li>PAID : invoice has no payment status, no AO created.</li><li>PPAID : invoice has no payment status, no AO created</li><li>UNPAID : invoice has no payment status, no AO created.</li><li>ABANDONED : invoice has no payment status, no AO created.</li><li>REFUNDED : invoice has no payment status, no AO created.</li><li>DISPUTED : invoice has no payment status, no AO created.</li>",
  • "amount": 0,
  • "paymentMethod": {
    },
  • "dueDate": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "recordedInvoice": {
    },
  • "tradingCountry": {
    },
  • "amountWithTax": 0,
  • "amountTax": 0,
  • "billingRun": {
    },
  • "netToPay": 0,
  • "invoiceNumber": "string",
  • "initialCollectionDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "paymentMethodType": "possible value are: CHECK, DIRECTDEBIT, WIRETRANSFER, CARD, PAYPAL, STRIPE, CASH",
  • "discountAmountWithoutTax": 0,
  • "cfValues": {
    },
  • "iban": "string",
  • "amountWithoutTax": 0,
  • "xmlFilename": "string",
  • "temporaryInvoiceNumber": "string",
  • "pdfFilename": "string",
  • "invoiceLines": [
    ],
  • "rejectReason": "string",
  • "xmlDate": "2019-08-24T14:15:22Z",
  • "pdfDate": "2019-08-24T14:15:22Z",
  • "paymentStatusDate": "2019-08-24T14:15:22Z",
  • "rawAmount": 0,
  • "amountWithoutTaxBeforeDiscount": 0,
  • "productDate": "2019-08-24T14:15:22Z",
  • "adjustedInvoice": {
    },
  • "invoiceAdjustmentCurrentSellerNb": 0,
  • "invoiceAdjustmentCurrentProviderNb": 0,
  • "previousInvoiceNumber": "string",
  • "dueBalance": 0,
  • "tradingCurrency": {
    },
  • "tradingLanguage": {
    },
  • "cfAccumulatedValues": {
    },
  • "externalRef": "string",
  • "categoryInvoiceAgregates": [
    ],
  • "emailSentDate": "2019-08-24T14:15:22Z",
  • "listLinkedInvoices": [
    ],
  • "invoiceTypeCode": "string",
  • "commercialOrder": {
    },
  • "cpqQuote": {
    },
  • "invoiceLinesTolink": [
    ],
  • "discount": 0,
  • "discountAmount": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "alreadySent": true,
  • "dontSend": true,
  • "draft": true,
  • "detailedInvoice": true,
  • "alreadyAppliedMinimum": true,
  • "alreadyAddedDiscount": true,
  • "prepaid": true
}

Quarantine invoice

Quarantine invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json

Quarantine billing run

quarantineBillingRunId
integer <int64>
Array of objects (LanguageDescriptionDto)

Responses

Request samples

Content type
application/json
{
  • "quarantineBillingRunId": 0,
  • "descriptionsTranslated": [
    ]
}

Rebuild invoice

Rebuild invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Refresh rate

Refresh invoice exchange rate

path Parameters
id
required
integer <int64>

Invoice identifier

Responses

Reject invoice

Reject invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Update invoice line

Update invoice line

path Parameters
id
required
integer <int64>

id of the Invoice

lineId
required
integer <int64>

id of the InvoiceLine

Request Body schema: application/json
required

invoice lines to update

object (InvoiceLine)

The list of invoice lines

skipValidation
boolean

Indicate if the invoice line will skip validation

Responses

Request samples

Content type
application/json
{
  • "invoiceLine": {
    },
  • "skipValidation": true
}

Remove invoice line

Remove invoice line

path Parameters
id
required
integer <int64>

id of the Invoice

lineId
required
integer <int64>

id of the InvoiceLine

Request Body schema: application/json

invoice lines to remove

ids
Array of integers <int64> [ items <int64 > ]
skipValidation
boolean

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "skipValidation": true
}

Validate invoice

Validate invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Get available open orders for a commercial order

path Parameters
code
required
string

Responses

Get available open orders for a quote

path Parameters
quoteCode
required
string

Responses

Send a file to be imported. ImportExportResponseDto.executionId contains

Send a file to be imported. ImportExportResponseDto.executionId contains

Request Body schema: multipart/form-data
parts
Array of strings

Form data parts (simplified)

preamble
string

Form preamble

Responses

Response samples

Content type
{
  • "actionStatus": {
    },
  • "executionId": "string",
  • "summary": {
    },
  • "importResultDto": [
    ],
  • "fieldsNotImported": {
    },
  • "exceptionMessage": "string",
  • "done": true,
  • "failureMessageKey": "string",
  • "failureMessage": "string",
  • "failed": true
}

Create Open Order Quote

Create Open Order Quote

Request Body schema: application/json
description
string
code
required
string
billingAccountCode
required
string
tags
Array of strings unique
externalReference
string
openOrderType
required
string
Enum: "ARTICLES" "PRODUCTS"
Array of objects (ThresholdInput) unique
articles
Array of strings unique
endOfValidityDate
string <date-time>
openOrderTemplate
required
string
maxAmount
required
number
products
Array of strings unique
activationDate
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "billingAccountCode": "string",
  • "tags": [
    ],
  • "externalReference": "string",
  • "openOrderType": "ARTICLES",
  • "thresholds": [
    ],
  • "articles": [
    ],
  • "endOfValidityDate": "2019-08-24T14:15:22Z",
  • "openOrderTemplate": "string",
  • "maxAmount": 0,
  • "products": [
    ],
  • "activationDate": "2019-08-24T14:15:22Z"
}

Duplicate Open Order Quote from existing one

Duplicate Open Order Quote

path Parameters
id
required
integer <int64>

Source Open Order Quote id

Responses

Update Open Order Quote

Update Open Order Quote

path Parameters
id
required
integer <int64>

Open Order Quote id

Request Body schema: application/json
description
string
code
required
string
billingAccountCode
required
string
tags
Array of strings unique
externalReference
string
openOrderType
required
string
Enum: "ARTICLES" "PRODUCTS"
Array of objects (ThresholdInput) unique
articles
Array of strings unique
endOfValidityDate
string <date-time>
openOrderTemplate
required
string
maxAmount
required
number
products
Array of strings unique
activationDate
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "billingAccountCode": "string",
  • "tags": [
    ],
  • "externalReference": "string",
  • "openOrderType": "ARTICLES",
  • "thresholds": [
    ],
  • "articles": [
    ],
  • "endOfValidityDate": "2019-08-24T14:15:22Z",
  • "openOrderTemplate": "string",
  • "maxAmount": 0,
  • "products": [
    ],
  • "activationDate": "2019-08-24T14:15:22Z"
}

Mark WalletOperations to rerate

Mark WalletOperations to rerate

Request Body schema: application/json
required

WO advanced filter for rerate

object
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "status": "possible value are : SUCCESS, FAIL",
  • "errorCode": { },
  • "message": "string",
  • "entityId": 0,
  • "entityCode": "string",
  • "nrAffected": 0
}

Generic

The Customer Account will be moved immediately under the provided Customer.\n" + "All open wallet operation will be rerated.

The Customer Account will be moved immediately under the provided Customer. All open wallet operation will be rerated.

No consistency check is performed, no other data is modified. Especially:

counters (accumulators) set on the origin or target Customer will not be updated to reflect the move

custom fields referencing entities in the origin hierarchy will not be updated

Unless specifically developed to use field history, reports will use the customer at the time of execution

path Parameters
customerAccountCode
required
string
Request Body schema: application/json
required

Parent id or code

parentCode
string

Parent code

parentId
integer <int64>

Parent id

Responses

Request samples

Content type
application/json
{
  • "parentCode": "string",
  • "parentId": 0
}

This endpoint allows to transfer a subscription to another account

API to transfer the subscription from a consumer to an other consumer (UA)

path Parameters
subscriptionCode
required
string

The subscription code

query Parameters
openTransactionsAction
string
Default: "NONE"
Enum: "NONE" "FAIL" "MOVE" "MOVE_AND_RERATE"

Open transactions action

Request Body schema: application/json
required

Consumer id or code

consumerCode
string

Consumer code

consumerId
integer <int64>

Consumer id

Responses

Request samples

Content type
application/json
{
  • "consumerCode": "string",
  • "consumerId": 0
}

Generic single endpoint to retrieve paginated records of an entity

Use this method to get the list of entities. You need to specify the entity name, and as body, the configuration of the research." + " also you can define the offset and the limit, you can order by a field and define the sort type" + " see PagingAndFiltering doc for more details.

path Parameters
entityName
required
string

The entity name

query Parameters
extractList
boolean

extractList flag to return or not nested List

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Create a resource by giving it's name and Id

specify the entity name, the record id, and as body, the list of the fields to create

path Parameters
entityName
required
string

the entity name

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Generic single endpoint to retrieve resources by ID

Use this method to get an entity. You need to specify the entity name, the record id, and as body, the list of the wanted fields

path Parameters
entityName
required
string

the entity name

id
required
integer <int64>

The id here is the database primary key of the wanted record

query Parameters
extractList
boolean

extractList flag to return or not nested List

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {fields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a resource by giving it's name and Id

specify the entity name, the record id, and as body, the list of the fields to update

path Parameters
entityName
required
string

the entity name

id
required
integer <int64>

The id here is the database primary key of the record to update

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Generic single endpoint to retrieve resources by ID

specify the entity name, the record id, and as body, the list of the wanted fields

path Parameters
entityName
required
string

the entity name

id
required
integer <int64>

The id here is the database primary key of the wanted record

query Parameters
extractList
boolean

extractList flag to return or not nested List

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {fields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Delete a resource by giving it's name and Id

specify the entity name, the record id, and as body, the list of the fields to delete

path Parameters
entityName
required
string

the entity name

id
required
integer <int64>

The id here is the database primary key of the record to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Generic single endpoint to export paginated records of an entity

specify the entity name, and as body, the configuration of the research. also you can define the offset and the limit, you can order by a field and define the sort type see PagingAndFiltering doc for more details.

path Parameters
entityName
required
string

the entity name

fileFormat
required
string

file format

query Parameters
locale
string

Locale

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Generic single endpoint to retrieve paginated records of an entity

specify the entity name, and as body, the configuration of the research. also you can define the offset and the limit, you can order by a field and define the sort type see PagingAndFiltering doc for more details.

path Parameters
entityName
required
string

the entity name

query Parameters
extractList
boolean

extractList flag to return or not nested List

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

This endpoint is used to retrieve the full list of queryable entities

This endpoint retrieves all possible queryable entities in the database.

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

This endpoint is used to retrieve the fields and corresponding types of an entity

You need to specify an entity name.

Given the entity name, this endpoint returns the list of its fields and corresponding types. The entity name should not be written in the plural form. For example, customer.

path Parameters
entityName
required
string

The entity name

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Get versions information about STAQR Commerce components

return a list of STAQR Commerce's components version information

Responses

Get versions information about STAQR Commerce components

return a list of STAQR Commerce's components version information

Responses

Move

The Customer Account will be moved immediately under the provided Customer.\n" + "All open wallet operation will be rerated.

The Customer Account will be moved immediately under the provided Customer. All open wallet operation will be rerated.

No consistency check is performed, no other data is modified. Especially:

counters (accumulators) set on the origin or target Customer will not be updated to reflect the move

custom fields referencing entities in the origin hierarchy will not be updated

Unless specifically developed to use field history, reports will use the customer at the time of execution

path Parameters
customerAccountCode
required
string
Request Body schema: application/json
required

Parent id or code

parentCode
string

Parent code

parentId
integer <int64>

Parent id

Responses

Request samples

Content type
application/json
{
  • "parentCode": "string",
  • "parentId": 0
}

Customer Account

The Customer Account will be moved immediately under the provided Customer.\n" + "All open wallet operation will be rerated.

The Customer Account will be moved immediately under the provided Customer. All open wallet operation will be rerated.

No consistency check is performed, no other data is modified. Especially:

counters (accumulators) set on the origin or target Customer will not be updated to reflect the move

custom fields referencing entities in the origin hierarchy will not be updated

Unless specifically developed to use field history, reports will use the customer at the time of execution

path Parameters
customerAccountCode
required
string
Request Body schema: application/json
required

Parent id or code

parentCode
string

Parent code

parentId
integer <int64>

Parent id

Responses

Request samples

Content type
application/json
{
  • "parentCode": "string",
  • "parentId": 0
}

Subscription

This endpoint allows to transfer a subscription to another account

API to transfer the subscription from a consumer to an other consumer (UA)

path Parameters
subscriptionCode
required
string

The subscription code

query Parameters
openTransactionsAction
string
Default: "NONE"
Enum: "NONE" "FAIL" "MOVE" "MOVE_AND_RERATE"

Open transactions action

Request Body schema: application/json
required

Consumer id or code

consumerCode
string

Consumer code

consumerId
integer <int64>

Consumer id

Responses

Request samples

Content type
application/json
{
  • "consumerCode": "string",
  • "consumerId": 0
}

Transfer

This endpoint allows to transfer a subscription to another account

API to transfer the subscription from a consumer to an other consumer (UA)

path Parameters
subscriptionCode
required
string

The subscription code

query Parameters
openTransactionsAction
string
Default: "NONE"
Enum: "NONE" "FAIL" "MOVE" "MOVE_AND_RERATE"

Open transactions action

Request Body schema: application/json
required

Consumer id or code

consumerCode
string

Consumer code

consumerId
integer <int64>

Consumer id

Responses

Request samples

Content type
application/json
{
  • "consumerCode": "string",
  • "consumerId": 0
}

AllowedParents

List user accounts allowed to be parent of the giving user account

fine allowed parents for a giving user account

path Parameters
userAccountCode
required
string

user Account code

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

AccountingArticle

This endpoint allows to find list of accounting article resource

find list of an existing accounting article

query Parameters
offset
integer <int64>
Default: 0

The offset of the list

limit
integer <int64>
Default: 50

The limit element per page

sort
string

The sort by field

orderBy
string

The ordering by field

Request Body schema: application/json

Map of filters

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

This endpoint allows to create an accounting article resource

create new accounting article

Request Body schema: application/json
required

the accounting article object

description
required
string

description of accounting article

code
required
string

code of accounting article

analyticCode1
string

first analytic code

analyticCode2
string

second analytic code

analyticCode3
string

third analytic code

unitPrice
number

Unit Price

object (Resource)
object (CustomFieldsDto)

custom field associated the contact category

invoiceTypeEl
string

invoice type el associated to accounting article

object (Resource)
object (Resource)
required
object (Resource)
accountingCodeEl
string

Accounting code El

required
object (Resource)
Array of objects (LanguageDescriptionDto)

list of language description

columCriteriaEL
string

Column criteria EL

ignoreAggregation
boolean

Ignore aggregation

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "analyticCode1": "string",
  • "analyticCode2": "string",
  • "analyticCode3": "string",
  • "unitPrice": 0,
  • "accountingCode": {
    },
  • "customFields": {
    },
  • "invoiceTypeEl": "string",
  • "articleFamily": {
    },
  • "invoiceType": {
    },
  • "invoiceSubCategory": {
    },
  • "accountingCodeEl": "string",
  • "taxClass": {
    },
  • "languageDescriptions": [
    ],
  • "columCriteriaEL": "string",
  • "ignoreAggregation": true,
  • "links": [
    ],
  • "id": 0
}

This endpoint allows to find an existing accounting article resource

fine an existing accounting article

path Parameters
accountingArticleCode
required
string

accounting article code

Responses

This endpoint allows to delete an existing accounting article resource

delete an existing accounting article

path Parameters
accountingArticleCode
required
string

accounting article code

Responses

This endpoint allows to find accounting article resource with product and list of attributes

find an existing accounting article

path Parameters
productCode
required
string

product code

Request Body schema: application/json

Map of attributes

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

This endpoint allows to update an existing accounting article resource

update an existing accounting article

path Parameters
id
required
integer <int64>

id of Accounting article

Request Body schema: application/json
required

the accounting article object

description
required
string

description of accounting article

code
required
string

code of accounting article

analyticCode1
string

first analytic code

analyticCode2
string

second analytic code

analyticCode3
string

third analytic code

unitPrice
number

Unit Price

object (Resource)
object (CustomFieldsDto)

custom field associated the contact category

invoiceTypeEl
string

invoice type el associated to accounting article

object (Resource)
object (Resource)
required
object (Resource)
accountingCodeEl
string

Accounting code El

required
object (Resource)
Array of objects (LanguageDescriptionDto)

list of language description

columCriteriaEL
string

Column criteria EL

ignoreAggregation
boolean

Ignore aggregation

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "analyticCode1": "string",
  • "analyticCode2": "string",
  • "analyticCode3": "string",
  • "unitPrice": 0,
  • "accountingCode": {
    },
  • "customFields": {
    },
  • "invoiceTypeEl": "string",
  • "articleFamily": {
    },
  • "invoiceType": {
    },
  • "invoiceSubCategory": {
    },
  • "accountingCodeEl": "string",
  • "taxClass": {
    },
  • "languageDescriptions": [
    ],
  • "columCriteriaEL": "string",
  • "ignoreAggregation": true,
  • "links": [
    ],
  • "id": 0
}

This endpoint allows to create an article mapping resource Deprecated

create new article mapping resource

Request Body schema: application/json
required

the article mapping object

description
string

description of article mapping

code
string

code of article mapping

object (Resource)
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "mappingScript": {
    },
  • "links": [
    ],
  • "id": 0
}

AccountingCodeMapping

This endpoint create accounting code mapping

Create accounting code mapping

Request Body schema: application/json
Array of objects (AccountingCodeMapping)

Accounting code mapping list

accountingArticleCode
string

Accounting article code

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "accountingCodeMappings": [
    ],
  • "accountingArticleCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

This endpoint update accounting code mapping

Update accounting code mapping

path Parameters
accountingArticleCode
required
string

accounting article code

Request Body schema: application/json
Array of objects (AccountingCodeMapping)

Accounting code mapping list

accountingArticleCode
string

Accounting article code

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "accountingCodeMappings": [
    ],
  • "accountingArticleCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

articleMappingLine

This endpoint allows to create an article mapping line resource

create new article mapping line resource

Request Body schema: application/json
required

the article mapping line object

description
string

article mapping line description

required
object (Resource)
object (Resource)
parameter1
string

first parameter of article mapping line

parameter2
string

second parameter of article mapping line

parameter3
string

third parameter of article mapping line

object (Resource)
Array of objects (AttributeMapping)

list of attribute mapping

attributeOperator
string
Enum: "AND" "OR"

Applied operator for AttributMapping

mappingKeyEL
string

mapping expression language of article mapping line

object (Resource)
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "accountingArticle": {
    },
  • "offer": {
    },
  • "parameter1": "string",
  • "parameter2": "string",
  • "parameter3": "string",
  • "articleMapping": {
    },
  • "attributesMapping": [
    ],
  • "attributeOperator": "AND",
  • "mappingKeyEL": "string",
  • "product": {
    },
  • "charge": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

This endpoint allows to find an existing article mapping line resource

find an existing article mapping line resource

path Parameters
id
required
integer <int64>

id of the article mapping line

Responses

This endpoint allows to updating an existing article mapping line resource

update an existing article mapping line resource

path Parameters
id
required
integer <int64>

id of the article mapping line

Request Body schema: application/json
required

the article mapping line object

description
string

article mapping line description

required
object (Resource)
object (Resource)
parameter1
string

first parameter of article mapping line

parameter2
string

second parameter of article mapping line

parameter3
string

third parameter of article mapping line

object (Resource)
Array of objects (AttributeMapping)

list of attribute mapping

attributeOperator
string
Enum: "AND" "OR"

Applied operator for AttributMapping

mappingKeyEL
string

mapping expression language of article mapping line

object (Resource)
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "accountingArticle": {
    },
  • "offer": {
    },
  • "parameter1": "string",
  • "parameter2": "string",
  • "parameter3": "string",
  • "articleMapping": {
    },
  • "attributesMapping": [
    ],
  • "attributeOperator": "AND",
  • "mappingKeyEL": "string",
  • "product": {
    },
  • "charge": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

This endpoint allows to delete an existing article mapping line resource

delete an existing article mapping line resource

path Parameters
id
required
integer <int64>

id of the article mapping line

Responses

This endpoint allows to find an existing article mapping line resource

find an existing article mapping line resource

path Parameters
code
required
string

code of the article mapping line

Responses

articleMapping

This endpoint allows to find an existing article mapping resource

find an existing article mapping resource

path Parameters
code
required
string

code of the article mapping

Responses

Discount Plan instances

Return an discount plan instance

Returns the discount plan instance data

path Parameters
billingAccountId
required
integer <int64>

id of the billing Account

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

This endpoint allows to instantiate a discount plan instance resource

Instantiate new discount plan Instance

path Parameters
billingAccountId
required
integer <int64>

id of the billing Account

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Return discount plan instances by subscription

Returns the discount plan instances data by subscription

path Parameters
subscriptionId
required
integer <int64>

id of the subscription

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

This endpoint allows to instantiate a discount plan instance resource for a subscription

Instantiate new discount plan Instance for a subscription

path Parameters
subscriptionId
required
integer <int64>

id of the subscription

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

This endpoint allows to instantiate a discount plan instance resource with dates for a subscription

Instantiate new discount plan Instance with dates for a subscription

path Parameters
subscriptionId
required
integer <int64>

id of the subscription

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Return an discount plan instance

Returns the discount plan instance data

path Parameters
billingAccountId
required
integer <int64>

id of the billing Account

id
required
integer <int64>

id of the discount plan instance

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a resource by giving it's Id

specify record id, and as body, the list of the fields to update

path Parameters
billingAccountId
required
integer <int64>

The billing account id

id
required
integer <int64>

The id here is the database primary key of the record to update

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Delete a resource by giving it's Id

specify the entity name, the record id, and as body, the list of the fields to delete

path Parameters
billingAccountId
required
integer <int64>

The billing account id

id
required
integer <int64>

The id here is the database primary key of the record to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an discount plan instance by subscription

Returns the discount plan instance data by subscription

path Parameters
subscriptionId
required
integer <int64>

id of the subscription

id
required
integer <int64>

id of the discount plan instance

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a resource by giving it's Id

specify record id, and as body, the list of the fields to update

path Parameters
subscriptionId
required
integer <int64>

The subscription id

id
required
integer <int64>

The id here is the database primary key of the record to update

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Delete a resource by giving it's Id

specify the entity name, the record id, and as body, the list of the fields to delete

path Parameters
subscriptionId
required
integer <int64>

The subscription id

id
required
integer <int64>

The id here is the database primary key of the record to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Expire a discount plan Instance

specify record id, and as body, the list of the fields to update

path Parameters
billingAccountId
required
integer <int64>

The billing account id

id
required
integer <int64>

The id here is the database primary key of the record to update

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Expire a discount plan Instance

specify record id, and as body, the list of the fields to update

path Parameters
subscriptionId
required
integer <int64>

The subscription id

id
required
integer <int64>

The id here is the database primary key of the record to update

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

InvoiceLines

Return invoice line tax details

Return invoice line tax details

path Parameters
id
required
integer <int64>

Invoice line id

Responses

Invoices

Add Sub Totals

Create a new sub totals

Request Body schema: application/json
required

the add SubTotals

object (InvoiceTypeDto)

The Invoice Type

required
Array of objects (SubTotalsDto)

The sub Totals

Responses

Request samples

Content type
application/json
{
  • "invoiceType": {
    },
  • "subTotals": [
    ]
}

Return a list of invoices

Returns a list of invoices with pagination feature or non integers will simulate API error conditions

query Parameters
offset
integer <int64>
Default: 0

The offset of the list

limit
integer <int64>
Default: 50

The limit per page

sort
string

The sort by field

orderBy
string

The order by

filter
string

The filter

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Create a new invoice

Create a new invoice

Request Body schema: application/json
required

the Invoice input object

isDraft
boolean

Indicate if the invoice is DRAFT

object (Invoice)
skipValidation
boolean

Indicate if validation is skept

isVirtual
boolean

Indicate if the invoice is virtual

isIncludeBalance
boolean

Indicate if we want include balance to the invoice

isAutoValidation
boolean

Indicate if the invoice set auto validation

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "invoice": {
    },
  • "skipValidation": true,
  • "isVirtual": true,
  • "isIncludeBalance": true,
  • "isAutoValidation": true
}

Create a new basic invoice

Create a new advanced payment invoice

Request Body schema: application/json
required

the advanced Payment Invoice object

comment
string

The comment for the invoice

label
string

The label

articleCode
string

The article code for invoice

billingAccountCode
string

The billing account code

dueDate
string <date-time>

The due date

amountWithTax
number

The maount with tax

invoiceDate
string <date-time>

The Date of the invoice

invoiceTypeCode
string

The invoice type code

orderCode
string

The order code for invoice

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "label": "string",
  • "articleCode": "string",
  • "billingAccountCode": "string",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "amountWithTax": 0,
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "invoiceTypeCode": "string",
  • "orderCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete existing invoice PDF file

Delete existing invoice PDF from the invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Delete existing invoice XML file

Delete existing invoice XML from the invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Add Sub Totals

delete a sub totals

Request Body schema: application/json
required

the add SubTotals

object (InvoiceTypeDto)

The Invoice Type

required
Array of objects (SubTotalsDto)

The sub Totals

Responses

Request samples

Content type
application/json
{
  • "invoiceType": {
    },
  • "subTotals": [
    ]
}

Returns the invoice PDF

Returns the invoice pdf if exists. feberation may be forced using 'generateIfMissing' parameter

path Parameters
id
required
integer <int64>

id of the Invoice

query Parameters
generateIfMissing
boolean

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an invoice

Returns the invoice data

path Parameters
invoiceNumber
required
string

invoice Number of the Invoice

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an invoice

Returns the invoice data

path Parameters
id
required
integer <int64>

id of the Invoice

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update an invoice

Update an invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json
required

the Invoice object

comment
string

The comment for the invoice

description
string

The description of the invoice

object (Resource)
statusDate
string <date-time>

The date of the status

status
string
Enum: "NEW" "SUSPECT" "REJECTED" "DRAFT" "CANCELED" "VALIDATED"

The status of the invoice.

object (Resource)
object (Resource)
sellerCode
string

The seller code

billingAccountCode
string

The billing account code

startDate
string <date-time>

The start date

endDate
string <date-time>

The end date

alias
string

The alias

object (Resource)
discountRate
number

The discount rate

paymentStatus
string
Enum: "NONE" "PENDING" "PENDING_PLAN" "PAID" "PPAID" "UNPAID" "ABANDONED" "REFUNDED" "DISPUTED"

The payement status

amount
number

The amount of the invoice

object (Resource)
dueDate
string <date-time>

The Due date

object (CustomFieldsDto)

custom field associated the contact category

object (Resource)
object (Resource)
amountWithTax
number

The amount with tax

amountTax
number

The amount tax

object (Resource)
netToPay
number

The net to pay

invoiceNumber
string

The invoice number

initialCollectionDate
string <date-time>

The initial collection date

invoiceDate
string <date-time>

The invoice date

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

The payment method type

discountAmountWithoutTax
number

discount amount without tax

object (Resource)
iban
string

The iban

amountWithoutTax
number

The amount without tax

xmlFilename
string

The xml file name for generated invoice xml

temporaryInvoiceNumber
string

The temporary invoice number

pdfFilename
string

The pdf file name for generated invoice PDF

Array of objects (InvoiceLine)

The list of the invoice lines

rejectReason
string

The rejected reason

xmlDate
string <date-time>

The xml date

pdfDate
string <date-time>

The pdf date

paymentStatusDate
string <date-time>

The date of the payment status

rawAmount
number

The raw amount

amountWithoutTaxBeforeDiscount
number

Amount without tax before discount

productDate
string <date-time>

The product date

object (Resource)
invoiceAdjustmentCurrentSellerNb
integer <int64>

The invoice adjustment current seller

invoiceAdjustmentCurrentProviderNb
integer <int64>

The invoice adjustment current provider

previousInvoiceNumber
string

The previous invoice number

dueBalance
number

The due balance

object (Resource)
object (Resource)
object (Resource)
externalRef
string

The external ref

Array of objects (CategoryInvoiceAgregate)

The list of the caregory invoice agregates

emailSentDate
string <date-time>

The date of email sent

listLinkedInvoices
Array of integers <int64> [ items <int64 > ]

The list of linked invoices

invoiceTypeCode
string

The invoice type code

object (Resource)
object (Resource)
invoiceLinesTolink
Array of integers <int64> [ items <int64 > ]

The list of the invoice lines to link

discount
number

The discount if any

discountAmount
number

The discount amount

code
string
Array of objects
id
integer <int64>
alreadySent
boolean

Indicate if the invoice is already sent

dontSend
boolean

Indicate if the invoice doesnt send

draft
boolean

Indicate if the invoice is draft

detailedInvoice
boolean

Indicate if the invoice is detailed

alreadyAppliedMinimum
boolean

Indicate if the invoice is already applied minumun

alreadyAddedDiscount
boolean

Indicate if the invoice is discount already added

prepaid
boolean

Indicate if the invoice is a prepaid

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "description": "string",
  • "order": {
    },
  • "statusDate": "2019-08-24T14:15:22Z",
  • "status": "possible value are : <ul><li> NEW : invoice entity has been created but incomplete </li><li>SUSPECT : invoice has been marked as suspect by automatic controls (this status doesn’t block automatic generation)</li><li>REJECTED : invoice has been rejected by automatic controls (this status block automatic generation)</li><li>DRAFT : invoice is complete but not validated. It can be edited.</li><li>CANCELED : invoice has been canceled (all related rated transactions are released. This is a final status)</li><li>VALIDATED : invoice is validated and cannot be edited anymore (this a final status)</li></ul>",
  • "quote": {
    },
  • "discountPlan": {
    },
  • "sellerCode": "string",
  • "billingAccountCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "alias": "string",
  • "subscription": {
    },
  • "discountRate": 0,
  • "paymentStatus": "possible value are : <ul><li>NONE : invoice has no payment status, no AO created.</li><li>PENDING : AO created, due date is still in the future</li><li>PAID : invoice has no payment status, no AO created.</li><li>PPAID : invoice has no payment status, no AO created</li><li>UNPAID : invoice has no payment status, no AO created.</li><li>ABANDONED : invoice has no payment status, no AO created.</li><li>REFUNDED : invoice has no payment status, no AO created.</li><li>DISPUTED : invoice has no payment status, no AO created.</li>",
  • "amount": 0,
  • "paymentMethod": {
    },
  • "dueDate": "2019-08-24T14:15:22Z",
  • "customFields": {
    },
  • "recordedInvoice": {
    },
  • "tradingCountry": {
    },
  • "amountWithTax": 0,
  • "amountTax": 0,
  • "billingRun": {
    },
  • "netToPay": 0,
  • "invoiceNumber": "string",
  • "initialCollectionDate": "2019-08-24T14:15:22Z",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "paymentMethodType": "possible value are: CHECK, DIRECTDEBIT, WIRETRANSFER, CARD, PAYPAL, STRIPE, CASH",
  • "discountAmountWithoutTax": 0,
  • "cfValues": {
    },
  • "iban": "string",
  • "amountWithoutTax": 0,
  • "xmlFilename": "string",
  • "temporaryInvoiceNumber": "string",
  • "pdfFilename": "string",
  • "invoiceLines": [
    ],
  • "rejectReason": "string",
  • "xmlDate": "2019-08-24T14:15:22Z",
  • "pdfDate": "2019-08-24T14:15:22Z",
  • "paymentStatusDate": "2019-08-24T14:15:22Z",
  • "rawAmount": 0,
  • "amountWithoutTaxBeforeDiscount": 0,
  • "productDate": "2019-08-24T14:15:22Z",
  • "adjustedInvoice": {
    },
  • "invoiceAdjustmentCurrentSellerNb": 0,
  • "invoiceAdjustmentCurrentProviderNb": 0,
  • "previousInvoiceNumber": "string",
  • "dueBalance": 0,
  • "tradingCurrency": {
    },
  • "tradingLanguage": {
    },
  • "cfAccumulatedValues": {
    },
  • "externalRef": "string",
  • "categoryInvoiceAgregates": [
    ],
  • "emailSentDate": "2019-08-24T14:15:22Z",
  • "listLinkedInvoices": [
    ],
  • "invoiceTypeCode": "string",
  • "commercialOrder": {
    },
  • "cpqQuote": {
    },
  • "invoiceLinesTolink": [
    ],
  • "discount": 0,
  • "discountAmount": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "alreadySent": true,
  • "dontSend": true,
  • "draft": true,
  • "detailedInvoice": true,
  • "alreadyAppliedMinimum": true,
  • "alreadyAddedDiscount": true,
  • "prepaid": true
}

Return an invoice

Returns the invoice data

path Parameters
invoiceType
required
integer <int64>

type of the Invoice

invoiceNumber
required
string

invoice number

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Get all operations matched to the given invoice

Get all operations matched to the given invoice

path Parameters
invoiceType
required
integer <int64>

type of the Invoice

invoiceNumber
required
string

invoice number

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a validated invoice

Update a validated invoice with a set of changes to apply and return the updated invoice

path Parameters
id
required
integer <int64>

id of the Invoice

Request Body schema: application/json
required

the Invoice object

comment
string

The comment for the invoice

object (CustomFieldsDto)

custom field associated the contact category

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "customFields": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Invoicing

Advance the billing run status

Advance the billing run status

path Parameters
billingRunId
required
integer <int64>
query Parameters
executeInvoicingJob
boolean

Responses

cancel the billing run

Cancel the billing run

path Parameters
billingRunId
required
integer <int64>

Responses

Create exceptional billing run

Create exceptional billing run

Request Body schema: application/json
required

Billing run to create

object

Filters on RT

billingRunTypeEnum
string
Enum: "AUTOMATIC" "MANUAL" "FULL_AUTOMATIC"

Billing run process type

object (CustomFieldsDto)

custom field associated the contact category

invoiceType
string
invoiceDate
string <date-time>

Invoice date

collectionDate
string <date-time>

Billing run collection date

rejectAutoAction
string
Enum: "CANCEL" "MOVE"

reject auto action

suspectAutoAction
string
Enum: "CANCEL" "MOVE"

Suspect auto action

code
string
Array of objects
id
integer <int64>
skipValidationScript
boolean

Skip validation script

computeDatesAtValidation
boolean

Decide whether or not dates should be recomputed at invoice validation

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "billingRunTypeEnum": "AUTOMATIC",
  • "customFields": {
    },
  • "invoiceType": "string",
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "collectionDate": "2019-08-24T14:15:22Z",
  • "rejectAutoAction": "CANCEL",
  • "suspectAutoAction": "CANCEL",
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "skipValidationScript": true,
  • "computeDatesAtValidation": true
}

Mediation

Accepts a list of CDR lines, parses them, creates EDRs and rates them. . CDR is same format use in mediation job

Request Body schema: application/json
required

the ChargeCdrListInput object

virtual
boolean

Rating must happen in a transaction no change performed during rating is persisted if isVirtual=true

rateTriggeredEdr
boolean

Rate all TriggeredEDR created by the rating of the charge

maxDepth
integer <int32>

The max deep used in triggered EDR

returnWalletOperations
boolean

If true, the API will return the list of IDs of all wallet operations produced. Applies to non-virtual mode only.

returnWalletOperationDetails
boolean

If true, the API will return the list of details of all wallet operations produced, even if they are virtual

returnCounters
boolean

If true, the API will return the list of counter updates produced, even if they are virtual

generateRTs
boolean

If true, the API will automatically generate RTs

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "virtual": true,
  • "rateTriggeredEdr": true,
  • "maxDepth": 0,
  • "returnWalletOperations": true,
  • "returnWalletOperationDetails": true,
  • "returnCounters": true,
  • "generateRTs": true,
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them and creates EDRs. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them, creates EDRs and reserves. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

CDR

Accepts a list of CDR lines, parses them, creates EDRs and rates them. . CDR is same format use in mediation job

Request Body schema: application/json
required

the ChargeCdrListInput object

virtual
boolean

Rating must happen in a transaction no change performed during rating is persisted if isVirtual=true

rateTriggeredEdr
boolean

Rate all TriggeredEDR created by the rating of the charge

maxDepth
integer <int32>

The max deep used in triggered EDR

returnWalletOperations
boolean

If true, the API will return the list of IDs of all wallet operations produced. Applies to non-virtual mode only.

returnWalletOperationDetails
boolean

If true, the API will return the list of details of all wallet operations produced, even if they are virtual

returnCounters
boolean

If true, the API will return the list of counter updates produced, even if they are virtual

generateRTs
boolean

If true, the API will automatically generate RTs

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "virtual": true,
  • "rateTriggeredEdr": true,
  • "maxDepth": 0,
  • "returnWalletOperations": true,
  • "returnWalletOperationDetails": true,
  • "returnCounters": true,
  • "generateRTs": true,
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them and creates EDRs. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them, creates EDRs and reserves. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

EDR

Accepts a list of CDR lines, parses them, creates EDRs and rates them. . CDR is same format use in mediation job

Request Body schema: application/json
required

the ChargeCdrListInput object

virtual
boolean

Rating must happen in a transaction no change performed during rating is persisted if isVirtual=true

rateTriggeredEdr
boolean

Rate all TriggeredEDR created by the rating of the charge

maxDepth
integer <int32>

The max deep used in triggered EDR

returnWalletOperations
boolean

If true, the API will return the list of IDs of all wallet operations produced. Applies to non-virtual mode only.

returnWalletOperationDetails
boolean

If true, the API will return the list of details of all wallet operations produced, even if they are virtual

returnCounters
boolean

If true, the API will return the list of counter updates produced, even if they are virtual

generateRTs
boolean

If true, the API will automatically generate RTs

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "virtual": true,
  • "rateTriggeredEdr": true,
  • "maxDepth": 0,
  • "returnWalletOperations": true,
  • "returnWalletOperationDetails": true,
  • "returnCounters": true,
  • "generateRTs": true,
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them and creates EDRs. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Accepts a list of CDR lines, parses them, creates EDRs and reserves. CDR accepts the same format as in mediation job

Request Body schema: application/json
required

the CdrListInput object

mode
string
Enum: "STOP_ON_FIRST_FAIL" "PROCESS_ALL" "ROLLBACK_ON_ERROR"

How the CDR list is processed : STOP_ON_FIRST_FAIL, PROCESS_ALL, ROLLBACK_ON_ERROR

cdrs
Array of strings

List of CDRs to process

returnEDRs
boolean

If true, the API will return the list of IDs of all EDRs produced. Applies to non-virtual mode only.

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "STOP_ON_FIRST_FAIL",
  • "cdrs": [
    ],
  • "returnEDRs": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

RatedTransaction

This endpoint allows to cancel an existing ratedTransaction resource

cancel an existing ratedTransaction

path Parameters
id
required
integer <int64>

ratedTransaction id

Responses

This endpoint allows to create a ratedTransaction resource

create new ratedTransaction

Request Body schema: application/json
required

the ratedTransaction object

serviceInstanceCode
string
billingAccountCode
string
userAccountCode
string
parameterExtra
string
unitAmountWithoutTax
number
quantity
number
parameter1
string
parameter2
string
parameter3
string
subscriptionCode
string
usageDate
string <date-time>
chargeInstanceCode
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "serviceInstanceCode": "string",
  • "billingAccountCode": "string",
  • "userAccountCode": "string",
  • "parameterExtra": "string",
  • "unitAmountWithoutTax": 0,
  • "quantity": 0,
  • "parameter1": "string",
  • "parameter2": "string",
  • "parameter3": "string",
  • "subscriptionCode": "string",
  • "usageDate": "2019-08-24T14:15:22Z",
  • "chargeInstanceCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Return a rated transaction

Returns rated transaction data

path Parameters
code
required
string

code of the Rated transaction

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

This endpoint allows to update an existing ratedTransaction resource

update an existing ratedTransaction

path Parameters
id
required
integer <int64>

id of ratedTransaction

Request Body schema: application/json
required

the ratedTransaction object

serviceInstanceCode
string
billingAccountCode
string
userAccountCode
string
parameterExtra
string
unitAmountWithoutTax
number
quantity
number
parameter1
string
parameter2
string
parameter3
string
subscriptionCode
string
usageDate
string <date-time>
chargeInstanceCode
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "serviceInstanceCode": "string",
  • "billingAccountCode": "string",
  • "userAccountCode": "string",
  • "parameterExtra": "string",
  • "unitAmountWithoutTax": 0,
  • "quantity": 0,
  • "parameter1": "string",
  • "parameter2": "string",
  • "parameter3": "string",
  • "subscriptionCode": "string",
  • "usageDate": "2019-08-24T14:15:22Z",
  • "chargeInstanceCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Discount Plans

This endpoint allows to create a discount plan resource

create new discount plan

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Return an discount plan items

Returns the discount plan items data

path Parameters
id
required
integer <int64>

id of the discount plan

Request Body schema: application/json
required

requestDto carries the wanted fields ex: {genericFields = [code, description]}

object
genericFields
Array of strings unique
nestedEntities
Array of strings unique
excluding
Array of strings unique
nestedDepth
integer <int64>
Array of objects (GenericFieldDetails)
fullTextFilter
string
groupBy
Array of strings unique
having
Array of strings unique
joinType
string
Enum: "INNER" "LEFT" "RIGHT"
limit
integer <int64>
total
integer <int64>
object
sortBy
string
sortOrder
string
offset
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "genericFields": [
    ],
  • "nestedEntities": [
    ],
  • "excluding": [
    ],
  • "nestedDepth": 0,
  • "genericFieldDetails": [
    ],
  • "fullTextFilter": "string",
  • "groupBy": [
    ],
  • "having": [
    ],
  • "joinType": "INNER",
  • "limit": 0,
  • "total": 0,
  • "translations": {
    },
  • "sortBy": "string",
  • "sortOrder": "string",
  • "offset": 0
}

This endpoint allows to create a discount plan item resource

create new discount plan

path Parameters
id
required
integer <int64>

id of the discount plan

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Return an discount plan

Returns the discount plan data

path Parameters
id
required
integer <int64>

id of the discount plan

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a resource by giving it's Id

specify record id, and as body, the list of the fields to update

path Parameters
id
required
integer <int64>

The id here is the database primary key of the record to update

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Delete a resource by giving it's Id

specify the entity name, the record id, and as body, the list of the fields to delete

path Parameters
id
required
integer <int64>

The id here is the database primary key of the record to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an discount plan

Returns the discount plan data

path Parameters
id
required
integer <int64>

id of the discount plan

idItem
required
integer <int64>

id of the discount plan item

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update a discount plan item resource by giving it's Id

specify record id, and as body, the list of the fields to update

path Parameters
idItem
required
integer <int64>

The id here is the database primary key of the record to update

Request Body schema: application/json
required

dto the json representation of the object

string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Delete a resource by giving it's Id

specify the entity name, the record id, and as body, the list of the fields to delete

path Parameters
idItem
required
integer <int64>

The id here is the database primary key of the record to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Force Expiration the discount plan by giving it's Id

specify record id, and as body, the list of the fields to update

path Parameters
id
required
integer <int64>

The id here is the database primary key of the record to update

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Price Plan Matrix

Export price plan matrix versions

Export price plan matrix versions

Request Body schema: application/json
required

input data

property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Import

Import grid data in price versions

Import grid data in price versions

Request Body schema: application/json
required

input data

data
Array of strings <byte> [ items <byte > ]

data

pricePlanMatrixVersion
integer <int32>

price plan matrix version

pricePlanMatrixCode
string

price plan matrix code

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "pricePlanMatrixVersion": 0,
  • "pricePlanMatrixCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Import price plan versions

This API will import the zip file containing the list of price plan versions

Request Body schema: application/json
required

input data

Array of objects (ImportPricePlanVersionsItem)
fileToImport
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "pricePlanVersions": [
    ],
  • "fileToImport": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Price Plan

Import grid data in price versions

Import grid data in price versions

Request Body schema: application/json
required

input data

data
Array of strings <byte> [ items <byte > ]

data

pricePlanMatrixVersion
integer <int32>

price plan matrix version

pricePlanMatrixCode
string

price plan matrix code

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "pricePlanMatrixVersion": 0,
  • "pricePlanMatrixCode": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Import price plan versions

This API will import the zip file containing the list of price plan versions

Request Body schema: application/json
required

input data

Array of objects (ImportPricePlanVersionsItem)
fileToImport
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "pricePlanVersions": [
    ],
  • "fileToImport": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Check if the current price plan version is used

Check if the current price plan version is used in a draft quote, not completed/validated order, or in a subscription

path Parameters
pricePlanMatrixCode
required
string

code of the price plan

pricePlanMatrixVersion
required
integer <int32>

version of the pricePlanVersion

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

BillingRule

Create a billingRule linked to an existing contract

path Parameters
contractCode
required
string
Request Body schema: application/json
invoicedBACodeEL
string

Expression to provide the code of a billing account that will be invoiced this rated transaction.

criteriaEL
string

Expression to tell OC if this rule should apply to the tested rated transaction

priority
integer <int32>
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "invoicedBACodeEL": "string",
  • "criteriaEL": "string",
  • "priority": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update a billingRule linked to an existing contract

path Parameters
contractCode
required
string
id
required
integer <int64>
Request Body schema: application/json
invoicedBACodeEL
string

Expression to provide the code of a billing account that will be invoiced this rated transaction.

criteriaEL
string

Expression to tell OC if this rule should apply to the tested rated transaction

priority
integer <int32>
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "invoicedBACodeEL": "string",
  • "criteriaEL": "string",
  • "priority": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete a billingRule

path Parameters
contractCode
required
string
id
required
integer <int64>

Responses

contact

Create a ContactCategory

Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Update a ContactCategory

path Parameters
contactCategoryCode
required
string
Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Delete a ContactCategory

path Parameters
contactCategoryCode
required
string

Responses

contact_category

Create a ContactCategory

Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Update a ContactCategory

path Parameters
contactCategoryCode
required
string
Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Delete a ContactCategory

path Parameters
contactCategoryCode
required
string

Responses

crm

Create a ContactCategory

Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Update a ContactCategory

path Parameters
contactCategoryCode
required
string
Request Body schema: application/json
description
string

description of the contact category

code
string

code of the contact category

object (CustomFieldsDto)

custom field associated the contact category

Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "customFields": {
    },
  • "links": [
    ],
  • "id": 0
}

Delete a ContactCategory

path Parameters
contactCategoryCode
required
string

Responses

Document

Delete a document by providing it's Id as param

provide a document id for this endpoint, and it will delete the document along with it's related physical file

path Parameters
id
required
integer <int64>

The id here is the database primary key of the document to delete

Responses

This endpoint allows to retrieve a document's file using the document id

retrieve and return an existing document file in base64 format

path Parameters
id
required
integer <int64>

The id here is the database primary key of the document's file to fetch

Responses

This endpoint allows to update the document file content

update an existing document file content

path Parameters
id
required
integer <int64>

The id here is the database primary key of the document's file to fetch

Request Body schema: text/plain
required

the document object

string

Responses

This endpoint allows to delete a document's file using the document id

delete an existing document file from disk

path Parameters
id
required
integer <int64>

The id here is the database primary key of the document's file to delete

query Parameters
includingDocument
required
boolean
Default: false

a flag to include the document instance in the delete operation

Responses

DunningAction

Create a new Dunning Action

Create a new Dunning Action

Request Body schema: application/json
required

dunning Action

object
description
string
code
string
actionType
string
Array of objects unique
object
actionMode
string
actionChannel
string
object
attachOverdueInvoices
boolean
attachDueInvoices
boolean

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "description": "string",
  • "code": "string",
  • "actionType": "string",
  • "relatedLevels": [
    ],
  • "actionNotificationTemplate": {
    },
  • "actionMode": "string",
  • "actionChannel": "string",
  • "assignedTo": {
    },
  • "attachOverdueInvoices": true,
  • "attachDueInvoices": true
}

Update a Dunning Action

Update a Dunning Action

path Parameters
dunningActionId
required
integer <int64>

dunning Action id

Request Body schema: application/json
required

dunning Action

object
description
string
code
string
actionType
string
Array of objects unique
object
actionMode
string
actionChannel
string
object
attachOverdueInvoices
boolean
attachDueInvoices
boolean

Responses

Request samples

Content type
application/json
{
  • "script": {
    },
  • "description": "string",
  • "code": "string",
  • "actionType": "string",
  • "relatedLevels": [
    ],
  • "actionNotificationTemplate": {
    },
  • "actionMode": "string",
  • "actionChannel": "string",
  • "assignedTo": {
    },
  • "attachOverdueInvoices": true,
  • "attachDueInvoices": true
}

Delete a Dunning Action

Delete a Dunning Action

path Parameters
dunningActionId
required
integer <int64>

dunning Action id

Responses

Retrieve a Dunning Action by code

Retrieve a Dunning Action by code

path Parameters
code
required
string

dunning Action code

Responses

Collection Plan Status

Create new Collection plan status

Create new collection plan status

Request Body schema: application/json
required
description
string

indicate description for the collection

status
string
Enum: "ACTIVE" "SUCCESS" "FAILED" "PAUSED" "STOPPED"

indicate the status used in the collection

colorCode
string

indicate color code for the status

object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "ACTIVE",
  • "colorCode": "string",
  • "dunningSettings": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update an existing Collection plan status

Update new collection plan status without its dunning settings

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
description
string

indicate description for the collection

status
string
Enum: "ACTIVE" "SUCCESS" "FAILED" "PAUSED" "STOPPED"

indicate the status used in the collection

colorCode
string

indicate color code for the status

object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "ACTIVE",
  • "colorCode": "string",
  • "dunningSettings": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete an existing Collection plan status

Delete new collection plan status without its dunning settings

path Parameters
id
required
integer <int64>

Responses

Dunning Agent

Create new Dunning Agent

Create new Dunning Agent

Request Body schema: application/json
required
object (Resource)
collectionAgency
string

indicate email collection agency

agentFirstNameItem
string
agentLastNameItem
string
agentEmailItem
string
external
boolean

include collection agency

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningSettings": {
    },
  • "collectionAgency": "string",
  • "agentFirstNameItem": "string",
  • "agentLastNameItem": "string",
  • "agentEmailItem": "string",
  • "external": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

update an existing Dunning Agent

Update an existing Dunning Agent

path Parameters
dunningSettingsCode
required
string
agentEmailItem
required
string
Request Body schema: application/json
required
object (Resource)
collectionAgency
string

indicate email collection agency

agentFirstNameItem
string
agentLastNameItem
string
agentEmailItem
string
external
boolean

include collection agency

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningSettings": {
    },
  • "collectionAgency": "string",
  • "agentFirstNameItem": "string",
  • "agentLastNameItem": "string",
  • "agentEmailItem": "string",
  • "external": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

delete an existing Dunning Agent

Update an existing Dunning Agent

path Parameters
dunningSettingsCode
required
string
agentEmailItem
required
string

Responses

Collection Plan

Add DunningActionInstance

Add DunningActionInstance

Request Body schema: application/json
required
mode
string
Enum: "MANUAL" "AUTOMATIC"
description
string
object (Resource)
actionRestult
string
object (Resource)
actionType
string
Enum: "SEND_NOTIFICATION" "RETRY_PAYMENT" "WRITE_OFF_INVOICE" "ISSUE_A_CREDIT_NOTE" "SCRIPT"
actionStatus
string
Enum: "TO_BE_DONE" "DONE"
object (Resource)
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "MANUAL",
  • "description": "string",
  • "actionOwner": {
    },
  • "actionRestult": "string",
  • "dunningLevelInstance": {
    },
  • "actionType": "SEND_NOTIFICATION",
  • "actionStatus": "TO_BE_DONE",
  • "collectionPlan": {
    },
  • "dunningAction": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Add DunningLevelInstance

Add DunningLevelInstance

Request Body schema: application/json
required
sequence
integer <int32>
daysOverdue
integer <int32>
object (Resource)
object (Resource)
object (Resource)
levelStatus
string
Enum: "TO_BE_DONE" "IN_PROGRESS" "DONE"
object (Resource)
Array of objects (DunningActionInstanceInput)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "sequence": 0,
  • "daysOverdue": 0,
  • "dunningLevel": {
    },
  • "collectionPlanStatus": {
    },
  • "collectionPlan": {
    },
  • "levelStatus": "TO_BE_DONE",
  • "policyLevel": {
    },
  • "actions": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Mass Pause list of Collection plan

Mass Pause list of collection plan

Request Body schema: application/json
required

MassPauseDunningCollectionPlan input

Array of objects (Resource)

Collection plan list to check

object (Resource)
forcePause
boolean

Force pause

pauseUntil
string <date-time>

Pause until date

Responses

Request samples

Content type
application/json
{
  • "collectionPlans": [
    ],
  • "dunningPauseReason": {
    },
  • "forcePause": true,
  • "pauseUntil": "2019-08-24T14:15:22Z"
}

Mass Stop list of Collection plan

Mass Stop collection plan

Request Body schema: application/json
required

MassStopDunningCollectionPlan input

Array of objects (Resource)

Indicate dunning list of collection plan

object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "collectionPlans": [
    ],
  • "dunningStopReason": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Pause Collection plan

Pause collection plan

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Resource)
forcePause
boolean

Force pause

pauseUntil
string <date-time>

Pause until date

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningPauseReason": {
    },
  • "forcePause": true,
  • "pauseUntil": "2019-08-24T14:15:22Z",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Remove DunningActionInstance

Remove DunningActionInstance

Request Body schema: application/json
required
Array of objects (Resource)
Array
code
string
Array of objects
id
integer <int64>

Responses

Request samples

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

Remove DunningLevelInstance

Remove DunningLevelInstance

Request Body schema: application/json
required
Array of objects (Resource)
Array
code
string
Array of objects
id
integer <int64>

Responses

Request samples

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

Resume Collection plan

Resume collection plan

path Parameters
id
required
integer <int64>

Responses

Stop Collection plan

Stop collection plan

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningStopReason": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update DunningActionInstance

Update DunningActionInstance

path Parameters
actionInstanceId
required
integer <int64>
Request Body schema: application/json
required
mode
string
Enum: "MANUAL" "AUTOMATIC"
description
string
object (Resource)
actionRestult
string
object (Resource)
actionType
string
Enum: "SEND_NOTIFICATION" "RETRY_PAYMENT" "WRITE_OFF_INVOICE" "ISSUE_A_CREDIT_NOTE" "SCRIPT"
actionStatus
string
Enum: "TO_BE_DONE" "DONE"
object (Resource)
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "mode": "MANUAL",
  • "description": "string",
  • "actionOwner": {
    },
  • "actionRestult": "string",
  • "dunningLevelInstance": {
    },
  • "actionType": "SEND_NOTIFICATION",
  • "actionStatus": "TO_BE_DONE",
  • "collectionPlan": {
    },
  • "dunningAction": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update DunningLevelInstance

Update DunningLevelInstance

path Parameters
levelInstanceId
required
integer <int64>
Request Body schema: application/json
required
daysOverdue
integer <int32>
levelStatus
string
Enum: "TO_BE_DONE" "IN_PROGRESS" "DONE"
Array of objects (DunningActionInstanceInput)

Responses

Request samples

Content type
application/json
{
  • "daysOverdue": 0,
  • "levelStatus": "TO_BE_DONE",
  • "actions": [
    ]
}

CollectionPlan

List of available dunning policies

List of available dunning policies

Request Body schema: application/json
required

available dunning policies input

object (Resource)
object (Resource)

Responses

Request samples

Content type
application/json
{
  • "billingAccount": {
    },
  • "collectionPlan": {
    }
}

Check eligible collection for switch

Check eligible collection for switch

Request Body schema: application/json
required

Collection plans to check

object (Resource)
Array of objects (Resource)

Collection plan list to check

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "collectionPlans": [
    ]
}

Mass switch collection plan

Mass switch collection plan

Request Body schema: application/json
required

MassSwitchDunningCollectionPlan input

object (Resource)
object (Resource)
Array of objects (Resource)

Indicate dunning collection plan

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningPolicy": {
    },
  • "policyLevel": {
    },
  • "collectionPlanList": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Switch collection plan

Switch collection plan

path Parameters
collectionPlanId
required
integer <int64>

Collection plan id

Request Body schema: application/json
required

SwitchDunningCollectionPlan input

object (Resource)
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningPolicy": {
    },
  • "policyLevel": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Dunning

Create new Dunning Level

Create new dunning level

Request Body schema: application/json
required
code
string
Array of objects
id
integer <int64>
description
string

dunning level description

dunningActions
Array of strings

Dunning level actions

isEndOfDunningLevel
boolean

End of dunning level

dunningLevelChargeCurrency
string

Dunning level charge currency

dunningLevelMinBalanceCurrency
string

Dunning level currency

dunningLevelDaysOverdue
integer <int32>

Days overdue

dunningLevelMinBalance
number

Dunning level min balance

dunningLevelChargeType
string

Dunning level charge type

dunningLevelChargeValue
number

Dunning level charge value

isReminderLevel
boolean

Is a reminder level

isActiveLevel
boolean

Is an active level

isSoftDeclineLevel
boolean

Soft decline

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "description": "string",
  • "dunningActions": [
    ],
  • "isEndOfDunningLevel": true,
  • "dunningLevelChargeCurrency": "string",
  • "dunningLevelMinBalanceCurrency": "string",
  • "dunningLevelDaysOverdue": 0,
  • "dunningLevelMinBalance": 0,
  • "dunningLevelChargeType": "string",
  • "dunningLevelChargeValue": 0,
  • "isReminderLevel": true,
  • "isActiveLevel": true,
  • "isSoftDeclineLevel": true
}

Update an existing Dunning Level

Update a dunning level

path Parameters
dunningLevelId
required
integer <int64>
Request Body schema: application/json
required
code
string
Array of objects
id
integer <int64>
description
string

dunning level description

dunningActions
Array of strings

Dunning level actions

isEndOfDunningLevel
boolean

End of dunning level

dunningLevelChargeCurrency
string

Dunning level charge currency

dunningLevelMinBalanceCurrency
string

Dunning level currency

dunningLevelDaysOverdue
integer <int32>

Days overdue

dunningLevelMinBalance
number

Dunning level min balance

dunningLevelChargeType
string

Dunning level charge type

dunningLevelChargeValue
number

Dunning level charge value

isReminderLevel
boolean

Is a reminder level

isActiveLevel
boolean

Is an active level

isSoftDeclineLevel
boolean

Soft decline

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "description": "string",
  • "dunningActions": [
    ],
  • "isEndOfDunningLevel": true,
  • "dunningLevelChargeCurrency": "string",
  • "dunningLevelMinBalanceCurrency": "string",
  • "dunningLevelDaysOverdue": 0,
  • "dunningLevelMinBalance": 0,
  • "dunningLevelChargeType": "string",
  • "dunningLevelChargeValue": 0,
  • "isReminderLevel": true,
  • "isActiveLevel": true,
  • "isSoftDeclineLevel": true
}

Delete existing Dunning level

Delete Existing dunning level

path Parameters
dunningLevelId
required
integer <int64>

Dunning level id to delete

Responses

Get existing Dunning Level

Get Existing dunning Level

path Parameters
dunningLevelCode
required
string

code dunning level

Responses

Create new Dunning Pause Reason

Create new Dunning Pause Reason

Request Body schema: application/json
required
description
string

The pause reason's description

object (Resource)
pauseReason
string

The pause reason

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "dunningSettings": {
    },
  • "pauseReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update an existing Dunning Pause Reason

Update an existing Dunning Pause Reasons

path Parameters
id
required
integer <int64>

Entity's id to update

Request Body schema: application/json
required
description
string

The pause reason's description

object (Resource)
pauseReason
string

The pause reason

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "dunningSettings": {
    },
  • "pauseReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete existing Dunning Pause Reason

Delete Existing dunning Pause Reasons

path Parameters
id
required
integer <int64>

Id of removed dunning Pause Reasons

Responses

Create new Dunning Payment Retry

Create new Dunning Payment Retry

Request Body schema: application/json
required
object (Resource)
paymentMethod
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

The payment method

numPayRetries
integer <int32>

The number of payment retries

payRetryFrequencyUnit
string
Enum: "DAY" "MONTH"

The unit's frequency of retry

payRetryFrequency
integer <int32>

The retry's frequency

psp
string

The payment service provider

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningSettings": {
    },
  • "paymentMethod": "CHECK",
  • "numPayRetries": 0,
  • "payRetryFrequencyUnit": "DAY",
  • "payRetryFrequency": 0,
  • "psp": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update an existing Dunning Payment Retry

Update an existing Dunning Payment Retry

path Parameters
id
required
integer <int64>

Entity's id to update

Request Body schema: application/json
required
object (Resource)
paymentMethod
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"

The payment method

numPayRetries
integer <int32>

The number of payment retries

payRetryFrequencyUnit
string
Enum: "DAY" "MONTH"

The unit's frequency of retry

payRetryFrequency
integer <int32>

The retry's frequency

psp
string

The payment service provider

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "dunningSettings": {
    },
  • "paymentMethod": "CHECK",
  • "numPayRetries": 0,
  • "payRetryFrequencyUnit": "DAY",
  • "payRetryFrequency": 0,
  • "psp": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete existing Dunning Payment Retry

Delete Existing dunning Payment Retry

path Parameters
id
required
integer <int64>

Id of removed dunning Payment Retry

Responses

Archive dunning policy

Archive dunning policy

path Parameters
dunningPolicyId
required
integer <int64>

Dunning policy id

Responses

Create new Dunning policy

Create new Dunning policy

Request Body schema: application/json
required

Dunning policy to create

policyDescription
string

dunning policy description

interestForDelaySequence
integer <int32>

Interest for delay sequence

policyPriority
integer <int32>

Policy priority

Array of objects (Resource)

Dunning policy rules

object (Resource)
minBalanceTrigger
number <double>

min balance trigger

policyName
string

dunning policy name

determineLevelBy
string
Enum: "DAYS_OVERDUE" "DAYS_OVERDUE_OR_BALANCE_THRESHOLD"

Determine level by

Array of objects (DunningPolicyLevel)

Dunning policy levels

code
string
Array of objects
id
integer <int64>
isDefaultPolicy
boolean

is default policy

isActivePolicy
boolean

is policy is activated

includeDueInvoicesInThreshold
boolean

include due invoices in threshold

includePayReminder
boolean

include pay reminder

attachInvoicesToEmails
boolean

Attach invoices to emails

Responses

Request samples

Content type
application/json
{
  • "policyDescription": "string",
  • "interestForDelaySequence": 0,
  • "policyPriority": 0,
  • "dunningPolicyRules": [
    ],
  • "minBalanceTriggerCurrency": {
    },
  • "minBalanceTrigger": 0.1,
  • "policyName": "string",
  • "determineLevelBy": "DAYS_OVERDUE",
  • "dunningPolicyLevels": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "isDefaultPolicy": true,
  • "isActivePolicy": true,
  • "includeDueInvoicesInThreshold": true,
  • "includePayReminder": true,
  • "attachInvoicesToEmails": true
}

deactivate dunning policy

deactivate dunning policy

Request Body schema: application/json
required

Dunning policy ids list

property name*
additional property
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

update Dunning policy

update Dunning policy

path Parameters
dunningPolicyId
required
integer <int64>

Dunning policy id

Request Body schema: application/json
required

dunning policy to update

policyDescription
string

dunning policy description

interestForDelaySequence
integer <int32>

Interest for delay sequence

policyPriority
integer <int32>

Policy priority

Array of objects (Resource)

Dunning policy rules

object (Resource)
minBalanceTrigger
number <double>

min balance trigger

policyName
string

dunning policy name

determineLevelBy
string
Enum: "DAYS_OVERDUE" "DAYS_OVERDUE_OR_BALANCE_THRESHOLD"

Determine level by

Array of objects (DunningPolicyLevel)

Dunning policy levels

code
string
Array of objects
id
integer <int64>
isDefaultPolicy
boolean

is default policy

isActivePolicy
boolean

is policy is activated

includeDueInvoicesInThreshold
boolean

include due invoices in threshold

includePayReminder
boolean

include pay reminder

attachInvoicesToEmails
boolean

Attach invoices to emails

Responses

Request samples

Content type
application/json
{
  • "policyDescription": "string",
  • "interestForDelaySequence": 0,
  • "policyPriority": 0,
  • "dunningPolicyRules": [
    ],
  • "minBalanceTriggerCurrency": {
    },
  • "minBalanceTrigger": 0.1,
  • "policyName": "string",
  • "determineLevelBy": "DAYS_OVERDUE",
  • "dunningPolicyLevels": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "isDefaultPolicy": true,
  • "isActivePolicy": true,
  • "includeDueInvoicesInThreshold": true,
  • "includePayReminder": true,
  • "attachInvoicesToEmails": true
}

delete a dunning policy

delete dunning policy

path Parameters
dunningPolicyId
required
integer <int64>

Dunning policy id

Responses

Find dunning policy

Find dunning policy

path Parameters
dunningPolicyName
required
string

Dunning policy name

Responses

Create new Dunning Setting

Create exceptional billing run

Request Body schema: application/json
required
object (Resource)
dunningMode
string
Enum: "CUSTOMER_LEVEL" "INVOICE_LEVEL"

dunning mode

maxDunningLevels
integer <int32>
Default: 15

Max dunning level

maxDaysOutstanding
integer <int32>

Max days outstanding

interestForDelayRate
number

interest for delay rate

code
string
Array of objects
id
integer <int64>
allowInterestForDelay
boolean
Default: true

allow interest for delay

allowDunningCharges
boolean
Default: true

allow dunninf charge

applyDunningChargeFxExchangeRate
boolean
Default: true

apply dunning charge exchange rate

Responses

Request samples

Content type
application/json
{
  • "accountingArticle": {
    },
  • "dunningMode": "CUSTOMER_LEVEL",
  • "maxDunningLevels": 15,
  • "maxDaysOutstanding": 0,
  • "interestForDelayRate": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "allowInterestForDelay": true,
  • "allowDunningCharges": true,
  • "applyDunningChargeFxExchangeRate": true
}

Update an existing Dunning Setting

Update an existing Dunning settings

path Parameters
dunningId
required
integer <int64>
Request Body schema: application/json
required
object (Resource)
dunningMode
string
Enum: "CUSTOMER_LEVEL" "INVOICE_LEVEL"

dunning mode

maxDunningLevels
integer <int32>
Default: 15

Max dunning level

maxDaysOutstanding
integer <int32>

Max days outstanding

interestForDelayRate
number

interest for delay rate

code
string
Array of objects
id
integer <int64>
allowInterestForDelay
boolean
Default: true

allow interest for delay

allowDunningCharges
boolean
Default: true

allow dunninf charge

applyDunningChargeFxExchangeRate
boolean
Default: true

apply dunning charge exchange rate

Responses

Request samples

Content type
application/json
{
  • "accountingArticle": {
    },
  • "dunningMode": "CUSTOMER_LEVEL",
  • "maxDunningLevels": 15,
  • "maxDaysOutstanding": 0,
  • "interestForDelayRate": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0,
  • "allowInterestForDelay": true,
  • "allowDunningCharges": true,
  • "applyDunningChargeFxExchangeRate": true
}

Delete existing Dunning Setting

Delete Existing dunning settings

path Parameters
dunningId
required
integer <int64>

id of removed dunning settings

Responses

Duplicate an existing Dunning Setting

Duplicate Existing dunning settings

path Parameters
dunningCode
required
string

code dunning settings

Responses

Get existing Dunning Setting

Get Existing dunning settings

path Parameters
dunningCode
required
string

code dunning settings

Responses

Create new Dunning Stop Reason

Create new Dunning Stop Reason

Request Body schema: application/json
required
description
string

The stop reason's description

object (Resource)
stopReason
string

The stop reason

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "dunningSettings": {
    },
  • "stopReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Update an existing Dunning Stop Reason

Update an existing Dunning Stop Reasons

path Parameters
id
required
integer <int64>

Entity's id to update

Request Body schema: application/json
required
description
string

The stop reason's description

object (Resource)
stopReason
string

The stop reason

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "dunningSettings": {
    },
  • "stopReason": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Delete existing Dunning Stop Reason

Delete Existing dunning Stop Reasons

path Parameters
id
required
integer <int64>

Id of removed dunning Stop Reasons

Responses

PolicyRule

Add policy rule

Add policy rule

path Parameters
dunningPolicyId
required
integer <int64>

Dunning policy id

Request Body schema: application/json
required

Policy rules

Array of objects (PolicyRule)

List of policy rules

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "policyRules": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Remove policy rule

Remove policy rule

path Parameters
policyRuleID
required
integer <int64>

Policy rule id

Responses

DunningTemplate

Create a new Dunning Template

Create a new Dunning Template

Request Body schema: application/json
required

dunning Template

code
string
subject
string
htmlContent
string
actionChannel
string
type
string
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "subject": "string",
  • "htmlContent": "string",
  • "actionChannel": "string",
  • "type": "string",
  • "language": {
    }
}

update a Dunning Template

update a Dunning Template

path Parameters
dunningTemplateId
required
integer <int64>

dunning Template id

Request Body schema: application/json
required

dunning Template

code
string
subject
string
htmlContent
string
actionChannel
string
type
string
object

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "subject": "string",
  • "htmlContent": "string",
  • "actionChannel": "string",
  • "type": "string",
  • "language": {
    }
}

Delete a Dunning Template

Delete a Dunning Template

path Parameters
dunningTemplateId
required
integer <int64>

dunning Template id

Responses

duplicate a Dunning Template

duplicate a Dunning Template

path Parameters
dunningTemplateId
required
integer <int64>

dunning Template id

Responses

export data

export data

export data

Request Body schema:
required

Export configuration

entityClass
string
exportType
string
Enum: "xml" "remoteInstance"
instanceCode
string
entityCodes
Array of strings
exportTemplateName
string
fileName
string

Responses

Request samples

Content type
No sample

TrialBalance

This endpoint allows to get trial balance according to the given filters

Get trial balance report

query Parameters
period
string
Default: "CURRENT_QUARTER"
Enum: "CURRENT_MONTH" "LAST_MONTH" "CURRENT_QUARTER" "LAST_QUARTER" "CURRENT_YEAR"

The trial balance report period

codeOrLabel
string

code or label

startDate
string <date-time>

The trial balance report start date

endDate
string <date-time>

The trial balance report end date

sortBy
string

The sorting by field

sortOrder
string
Enum: "DESCENDING" "ASCENDING"

The sort order

offset
integer <int64>
Default: 0

The list offset

limit
integer <int64>
Default: 100

The record list size

Responses

NotImplementedResource

This service represent a non implemented resource

Responses

Media

Upload a media file

Upload a media file

Request Body schema: multipart/form-data
data
Array of strings <byte> [ items <byte > ]
fileName
string
fileUrl
string <url>
level
string
Enum: "OFFER_TEMPLATE" "PRODUCT" "QUOTE"

Responses

Mediation Settings

Create new Mediation Setting

create new mediation setting to enabling or disabling edr versioning

Request Body schema: application/json
Array of objects (EdrVersioningRule) unique

list of rules for edr versioning

enableEdrVersioning
boolean

enable edr versioning

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "enableEdrVersioning": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Create new Edr Version rule

create new Edr Version rule

Request Body schema: application/json
criteriaEL
string

Defines if this rule is valid to for this EDR.

object (Resource)
keyEL
string

This expression will return string that will be stored as the EDR eventKey

isNewVersionEL
string

This expression will tell us if EDR is a new version of the EDR.

priority
integer <int32>

Defines versioning rules evaluation order

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "criteriaEL": "string",
  • "mediationSetting": {
    },
  • "keyEL": "string",
  • "isNewVersionEL": "string",
  • "priority": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update new Edr Version rule

upate an existing Edr Version rule

path Parameters
edrVersionRuleId
required
integer <int64>
Request Body schema: application/json
criteriaEL
string

Defines if this rule is valid to for this EDR.

object (Resource)
keyEL
string

This expression will return string that will be stored as the EDR eventKey

isNewVersionEL
string

This expression will tell us if EDR is a new version of the EDR.

priority
integer <int32>

Defines versioning rules evaluation order

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "criteriaEL": "string",
  • "mediationSetting": {
    },
  • "keyEL": "string",
  • "isNewVersionEL": "string",
  • "priority": 0,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Remove new Edr Version rule

remove an existing Edr Version rule

path Parameters
edrVersionRuleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "cause": {
    },
  • "stackTrace": [
    ],
  • "response": {
    },
  • "message": "string",
  • "suppressed": [
    ],
  • "localizedMessage": "string"
}

Update new Edr Version rule

upate an existing Edr Version rule

Request Body schema: application/json
required
object (Resource)
required
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "rule1": {
    },
  • "rule2": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Update new Mediation Setting

update an existing mediation setting to enabling or disabling edr versioning

path Parameters
mediationRuleId
required
integer <int64>
Request Body schema: application/json
Array of objects (EdrVersioningRule) unique

list of rules for edr versioning

enableEdrVersioning
boolean

enable edr versioning

code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "enableEdrVersioning": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Open Orders Quote

update open order quote status

path Parameters
code
required
string

code of the open order template

status
required
string
Enum: "DRAFT" "WAITING_VALIDATION" "REJECTED" "VALIDATED" "SENT" "ACCEPTED" "CANCELED"

open order template object to be updated

Responses

Open Orders Templates

change status open order template

change status the specified open order template

path Parameters
code
required
string

code of the open order template

status
required
string

status of the open order template

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

create open order template

create open order template

Request Body schema: application/json
required

open order template object to be created

description
string
status
string
Enum: "DRAFT" "ARCHIVED" "ACTIVE"
tags
Array of strings
openOrderType
string
Enum: "ARTICLES" "PRODUCTS"
Array of objects (ThresholdInput)
articles
Array of strings
templateName
string

The Template Name

products
Array of strings
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "DRAFT",
  • "tags": [
    ],
  • "openOrderType": "ARTICLES",
  • "thresholds": [
    ],
  • "articles": [
    ],
  • "templateName": "string",
  • "products": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

disable open order template

disable the specified open order template

path Parameters
code
required
string

code of the open order template

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

update open order template

Returns the updated open order template

path Parameters
code
required
string

code of the open order template

Request Body schema: application/json
required

open order template object to be updated

description
string
status
string
Enum: "DRAFT" "ARCHIVED" "ACTIVE"
tags
Array of strings
openOrderType
string
Enum: "ARTICLES" "PRODUCTS"
Array of objects (ThresholdInput)
articles
Array of strings
templateName
string

The Template Name

products
Array of strings
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "status": "DRAFT",
  • "tags": [
    ],
  • "openOrderType": "ARTICLES",
  • "thresholds": [
    ],
  • "articles": [
    ],
  • "templateName": "string",
  • "products": [
    ],
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Open Orders

cancel open order

cancel the specified open order

path Parameters
code
required
string

code of the open order

Request Body schema: application/json
required

open order object to be canceled

description
string
tags
Array of strings
externalReference
string
Array of objects (ThresholdInput)
endOfValidityDate
string <date-time>
cancelReason
string
templateName
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "tags": [
    ],
  • "externalReference": "string",
  • "thresholds": [
    ],
  • "endOfValidityDate": "2019-08-24T14:15:22Z",
  • "cancelReason": "string",
  • "templateName": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

update open order

Returns the updated open order

path Parameters
code
required
string

code of the open order

Request Body schema: application/json
required

open order object to be updated

description
string
tags
Array of strings
externalReference
string
Array of objects (ThresholdInput)
endOfValidityDate
string <date-time>
cancelReason
string
templateName
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "tags": [
    ],
  • "externalReference": "string",
  • "thresholds": [
    ],
  • "endOfValidityDate": "2019-08-24T14:15:22Z",
  • "cancelReason": "string",
  • "templateName": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Orders

Return a list of orders

Returns a list of orders with pagination feature or non integers will simulate API error conditions

query Parameters
offset
integer <int64>
Default: 0
limit
integer <int64>
Default: 50
sort
string
orderBy
string
filter
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Returns the created order

Returns the created order

Request Body schema: application/json
required

order object to be created

description
string
code
string
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

category
string
Array of objects (OrderItem)
object (PaymentMethod)
statusMessage
string
deliveryInstructions
string
expectedCompletionDate
string
requestedCompletionDate
string
object (Resource)
orderDate
string
requestedProcessingStartDate
string
priority
integer <int64>
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "IN_CREATION",
  • "category": "string",
  • "orderItems": [
    ],
  • "paymentMethod": {
    },
  • "statusMessage": "string",
  • "deliveryInstructions": "string",
  • "expectedCompletionDate": "string",
  • "requestedCompletionDate": "string",
  • "billingCycle": {
    },
  • "orderDate": "string",
  • "requestedProcessingStartDate": "string",
  • "priority": 0,
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "IN_CREATION",
  • "category": "string",
  • "orderItems": [
    ],
  • "paymentMethod": {
    },
  • "statusMessage": "string",
  • "deliveryInstructions": "string",
  • "expectedCompletionDate": "string",
  • "requestedCompletionDate": "string",
  • "billingCycle": {
    },
  • "orderDate": "string",
  • "requestedProcessingStartDate": "string",
  • "priority": 0,
  • "links": [
    ],
  • "id": 0
}

delete more than one order

delete more than one order

query Parameters
id
required
Array of integers <int64> [ items <int64 > ]

ids of orders to delete

Responses

Response samples

Content type
application/json
"string"

Return an order

Returns a single order

path Parameters
id
required
integer <int64>

id of the order

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

update an existing order

update an existing order, and returns the updated order

path Parameters
id
required
integer <int64>

id of the order to update

Request Body schema: application/json
required

order object to be update

description
string
code
string
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

category
string
Array of objects (OrderItem)
object (PaymentMethod)
statusMessage
string
deliveryInstructions
string
expectedCompletionDate
string
requestedCompletionDate
string
object (Resource)
orderDate
string
requestedProcessingStartDate
string
priority
integer <int64>
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "IN_CREATION",
  • "category": "string",
  • "orderItems": [
    ],
  • "paymentMethod": {
    },
  • "statusMessage": "string",
  • "deliveryInstructions": "string",
  • "expectedCompletionDate": "string",
  • "requestedCompletionDate": "string",
  • "billingCycle": {
    },
  • "orderDate": "string",
  • "requestedProcessingStartDate": "string",
  • "priority": 0,
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

delete an existing order

delete an existing order, and returns the deleted order

path Parameters
id
required
integer <int64>

id of the order to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

partially update an existing order

update an existing order with a set of changes to apply to the order, and returns the updated order

path Parameters
id
required
integer <int64>

id of the order to update

Request Body schema: application/json
required

order object to be update

description
string
code
string
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

category
string
Array of objects (OrderItem)
object (PaymentMethod)
statusMessage
string
deliveryInstructions
string
expectedCompletionDate
string
requestedCompletionDate
string
object (Resource)
orderDate
string
requestedProcessingStartDate
string
priority
integer <int64>
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "IN_CREATION",
  • "category": "string",
  • "orderItems": [
    ],
  • "paymentMethod": {
    },
  • "statusMessage": "string",
  • "deliveryInstructions": "string",
  • "expectedCompletionDate": "string",
  • "requestedCompletionDate": "string",
  • "billingCycle": {
    },
  • "orderDate": "string",
  • "requestedProcessingStartDate": "string",
  • "priority": 0,
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an order

Returns a single order

path Parameters
code
required
string

code of the order

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Order-items

Return a list of order-items

Returns a list of order-items with pagination feature or non integers will simulate API error conditions

query Parameters
offset
integer <int64>
Default: 0
limit
integer <int64>
Default: 50
sort
string
orderBy
string
filter
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Returns the created order-item

Returns the created order-item

Request Body schema: application/json
required

order-item object to be created

object (Resource)
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

Array of objects (ProductInstance)
action
string
Enum: "ADD" "MODIFY" "DELETE"

Action requested on a product or product offer

object (Subscription)
object (Resource)
itemId
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "status": "IN_CREATION",
  • "productInstance": [
    ],
  • "action": "ADD",
  • "subscription": {
    },
  • "userAccount": {
    },
  • "itemId": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "order": {
    },
  • "status": "IN_CREATION",
  • "productInstance": [
    ],
  • "action": "ADD",
  • "subscription": {
    },
  • "userAccount": {
    },
  • "itemId": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

delete more than one order-item

delete more than one order-item

query Parameters
id
required
Array of integers <int64> [ items <int64 > ]

ids of order-items to delete

Responses

Response samples

Content type
application/json
"string"

Return an order-Item

Returns a single order-Item

path Parameters
id
required
integer <int64>

id of the order-Item

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

update an existing order-item

update an existing order-item, and returns the updated order-item

path Parameters
id
required
integer <int64>

id of the order-item to update

Request Body schema: application/json
required

order-item object to be update

object (Resource)
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

Array of objects (ProductInstance)
action
string
Enum: "ADD" "MODIFY" "DELETE"

Action requested on a product or product offer

object (Subscription)
object (Resource)
itemId
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "status": "IN_CREATION",
  • "productInstance": [
    ],
  • "action": "ADD",
  • "subscription": {
    },
  • "userAccount": {
    },
  • "itemId": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

delete an existing order-item

delete an existing order-item, and returns the deleted order-item

path Parameters
id
required
integer <int64>

id of the order-item to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

partially update an existing order-item

update an existing order-item with a set of changes to apply to the order-item, and returns the updated order-item

path Parameters
id
required
integer <int64>

id of the order-item to update

Request Body schema: application/json
required

order-item object to be update

object (Resource)
status
string
Enum: "IN_CREATION" "ACKNOWLEDGED" "IN_PROGRESS" "CANCELLED" "COMPLETED" "REJECTED" "PENDING" "HELD" "FAILED" "WAITING" "DEFERRED" "PARTIAL"

Order status lifecycle

Array of objects (ProductInstance)
action
string
Enum: "ADD" "MODIFY" "DELETE"

Action requested on a product or product offer

object (Subscription)
object (Resource)
itemId
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "status": "IN_CREATION",
  • "productInstance": [
    ],
  • "action": "ADD",
  • "subscription": {
    },
  • "userAccount": {
    },
  • "itemId": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return an order-Item

Returns a single order-Item

path Parameters
code
required
string

code of the order-Item

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Products

Return a list of products

Returns a list of products with pagination feature or non integers will simulate API error conditions

query Parameters
offset
integer <int64>
Default: 0
limit
integer <int64>
Default: 50
sort
string
orderBy
string
filter
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Returns the created product

Returns the created product

Request Body schema: application/json
required

product object to be created

description
string
code
string
lifeCycleStatus
string
Array of objects (Resource)
Array of objects (Resource)
longDescription
string
Array of objects (Resource)
price
number
Array of objects (Resource)
object (Resource)
Array of objects (Resource)
validFrom
string
validTo
string
object (Resource)
image64
string
imageUrl
string
name
string
Array of objects
id
integer <int64>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "lifeCycleStatus": "string",
  • "offerTemplateCategories": [
    ],
  • "channels": [
    ],
  • "longDescription": "string",
  • "sellers": [
    ],
  • "price": 0,
  • "productChargeTemplates": [
    ],
  • "invoicingCalendar": {
    },
  • "walletTemplates": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "businessProductModel": {
    },
  • "image64": "string",
  • "imageUrl": "string",
  • "name": "string",
  • "links": [
    ],
  • "id": 0,
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "lifeCycleStatus": "string",
  • "offerTemplateCategories": [
    ],
  • "channels": [
    ],
  • "longDescription": "string",
  • "sellers": [
    ],
  • "price": 0,
  • "productChargeTemplates": [
    ],
  • "invoicingCalendar": {
    },
  • "walletTemplates": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "businessProductModel": {
    },
  • "image64": "string",
  • "imageUrl": "string",
  • "name": "string",
  • "links": [
    ],
  • "id": 0,
  • "disabled": true
}

delete more than one product

delete more than one product, and returns the deleted products

query Parameters
id
required
Array of integers <int64> [ items <int64 > ]

ids of products to delete

Responses

Response samples

Content type
application/json
"string"

Return a product

Returns a single product

path Parameters
id
required
integer <int64>

id of the product

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

update an existing product

update an existing product, and returns the updated product

path Parameters
id
required
integer <int64>

id of the product to update

Request Body schema: application/json
required

product object to be update

description
string
code
string
lifeCycleStatus
string
Array of objects (Resource)
Array of objects (Resource)
longDescription
string
Array of objects (Resource)
price
number
Array of objects (Resource)
object (Resource)
Array of objects (Resource)
validFrom
string
validTo
string
object (Resource)
image64
string
imageUrl
string
name
string
Array of objects
id
integer <int64>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "lifeCycleStatus": "string",
  • "offerTemplateCategories": [
    ],
  • "channels": [
    ],
  • "longDescription": "string",
  • "sellers": [
    ],
  • "price": 0,
  • "productChargeTemplates": [
    ],
  • "invoicingCalendar": {
    },
  • "walletTemplates": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "businessProductModel": {
    },
  • "image64": "string",
  • "imageUrl": "string",
  • "name": "string",
  • "links": [
    ],
  • "id": 0,
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

delete an existing product

delete an existing product, and returns the deleted product

path Parameters
id
required
integer <int64>

id of the product to delete

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

partially update an existing product

update an existing product with a set of changes to apply to the product, and returns the updated product

path Parameters
id
required
integer <int64>

id of the product to update

Request Body schema: application/json
required

product object to be update

description
string
code
string
lifeCycleStatus
string
Array of objects (Resource)
Array of objects (Resource)
longDescription
string
Array of objects (Resource)
price
number
Array of objects (Resource)
object (Resource)
Array of objects (Resource)
validFrom
string
validTo
string
object (Resource)
image64
string
imageUrl
string
name
string
Array of objects
id
integer <int64>
disabled
boolean

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "lifeCycleStatus": "string",
  • "offerTemplateCategories": [
    ],
  • "channels": [
    ],
  • "longDescription": "string",
  • "sellers": [
    ],
  • "price": 0,
  • "productChargeTemplates": [
    ],
  • "invoicingCalendar": {
    },
  • "walletTemplates": [
    ],
  • "validFrom": "string",
  • "validTo": "string",
  • "businessProductModel": {
    },
  • "image64": "string",
  • "imageUrl": "string",
  • "name": "string",
  • "links": [
    ],
  • "id": 0,
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Return a product

Returns a single product

path Parameters
code
required
string

code of the product

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

PaymentPlan

Activate Payment plan by Id

Activate Payment plan by Id

path Parameters
id
required
integer <int64>

Payment plan id

Responses

Response samples

Content type
application/json
{
  • "status": "possible value are : SUCCESS, FAIL",
  • "errorCode": { },
  • "message": "string",
  • "entityId": 0,
  • "entityCode": "string",
  • "nrAffected": 0,
  • "paymentId": 0
}

Create Payment plan

Create Payment plan

Request Body schema: application/json
description
string
code
required
string
status
string
Enum: "DRAFT" "ACTIVE" "COMPLETED"
recurringUnit
required
string
Enum: "MONTH" "DAY"
numberOfInstallments
required
integer <int32>
amountPerInstallment
required
number
amountToRecover
required
number
required
Array of objects (InstallmentAccountOperation) unique

List of Installment AccountOperation

startDate
required
string <date-time>
endDate
string <date-time>
customerAccount
required
integer <int64>
actionOnRemainingAmount
required
string
Enum: "FIRST" "LAST" "ADDITIONAL"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "DRAFT",
  • "recurringUnit": "MONTH",
  • "numberOfInstallments": 0,
  • "amountPerInstallment": 0,
  • "amountToRecover": 0,
  • "targetedAos": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "customerAccount": 0,
  • "actionOnRemainingAmount": "FIRST"
}

Update Payment plan

Update Payment plan

path Parameters
id
required
integer <int64>

Payment plan id

Request Body schema: application/json
description
string
code
required
string
status
string
Enum: "DRAFT" "ACTIVE" "COMPLETED"
recurringUnit
required
string
Enum: "MONTH" "DAY"
numberOfInstallments
required
integer <int32>
amountPerInstallment
required
number
amountToRecover
required
number
required
Array of objects (InstallmentAccountOperation) unique

List of Installment AccountOperation

startDate
required
string <date-time>
endDate
string <date-time>
customerAccount
required
integer <int64>
actionOnRemainingAmount
required
string
Enum: "FIRST" "LAST" "ADDITIONAL"

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "code": "string",
  • "status": "DRAFT",
  • "recurringUnit": "MONTH",
  • "numberOfInstallments": 0,
  • "amountPerInstallment": 0,
  • "amountToRecover": 0,
  • "targetedAos": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "customerAccount": 0,
  • "actionOnRemainingAmount": "FIRST"
}

Delete Payment plan by id

Delete Payment plan by id

path Parameters
id
required
integer <int64>

Payment plan id

Responses

PricePlanMatrixLine

search price plan using attributes information

search price plan using attributes information

Request Body schema: application/json
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Quote management

This endpoint allows duplicate an existing quote item

API to duplicate an existing quote item

path Parameters
quoteCode
required
string

The quote code

quoteVersion
required
integer <int32>

quote version id

quoteItemId
required
integer <int64>

quote item id

Responses

This endpoint allows duplicate an existing quote item

API to duplicate an existing quote item

path Parameters
quoteCode
required
string

The quote code

quoteVersion
required
integer <int32>

quote version id

quoteItemId
required
integer <int64>

quote item id

Responses

Refund

Refund By Card

create and validate a refund by Card order

Request Body schema: application/json
required
comment
string
ctsAmount
integer <int64>
cardNumber
string
expiryDate
string
ownerName
string
cardType
string
aoToPay
Array of integers <int64> [ items <int64 > ]
cvv
string
customerAccountCode
string
dueDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "ctsAmount": 0,
  • "cardNumber": "string",
  • "expiryDate": "string",
  • "ownerName": "string",
  • "cardType": "string",
  • "aoToPay": [
    ],
  • "cvv": "string",
  • "customerAccountCode": "string",
  • "dueDate": "2019-08-24T14:15:22Z"
}

Refund By SCT

create and validate a refund by SCT order

Request Body schema: application/json
required
comment
string
ctsAmount
number <double>
customerAccountCode
string
iban
string
aoToRefund
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "ctsAmount": 0.1,
  • "customerAccountCode": "string",
  • "iban": "string",
  • "aoToRefund": [
    ]
}

QueryScheduler

Create a new query scheduler

Create a new query scheduler

path Parameters
reportQueryId
required
integer <int64>

report query id

Request Body schema: application/json
required

Query scheduler object

year
string

Query scheduler year

dayOfMonth
string

Query scheduler day of month

hour
string

Query scheduler hour

minute
string

Query scheduler minute

second
string

Query scheduler second

dayOfWeek
string

Query scheduler day of week

month
string

Query scheduler month

fileFormat
string

Query scheduler file format

Array of objects (User)

Users to notify

emailsToNotify
Array of strings

Emails to notify

isQueryScheduler
boolean

Query scheduler is activated

everyDayOfMonth
boolean

Query scheduler every day of month

everyDayOfWeek
boolean

Query scheduler every day of week

everyHour
boolean

Query scheduler every hour

everyMinute
boolean

Query scheduler every minute

everyMonth
boolean

Query scheduler every month

everySecond
boolean

Query scheduler every second

Responses

Request samples

Content type
application/json
{
  • "year": "string",
  • "dayOfMonth": "string",
  • "hour": "string",
  • "minute": "string",
  • "second": "string",
  • "dayOfWeek": "string",
  • "month": "string",
  • "fileFormat": "string",
  • "usersToNotify": [
    ],
  • "emailsToNotify": [
    ],
  • "isQueryScheduler": true,
  • "everyDayOfMonth": true,
  • "everyDayOfWeek": true,
  • "everyHour": true,
  • "everyMinute": true,
  • "everyMonth": true,
  • "everySecond": true
}

ReportQuery

Return a list of report queries

Returns a list of report queries

query Parameters
offset
integer <int64>
Default: 0
limit
integer <int64>
Default: 50
sortOrder
string
sortBy
string
filter
string
query
string
fields
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}

Create a new report query

Create a new report query

Request Body schema: application/json
required

Report query object

object

Report query description

targetEntity
string

Report query description

emails
Array of strings

Report query emails

visibility
string
Enum: "PUBLIC" "PRIVATE" "PROTECTED"

Report query description

sortBy
string

Sort by

sortOrder
string
Enum: "DESCENDING" "ASCENDING"

Sort order

queryName
string

Report query code

queryDescription
string

Report query description

fields
Array of strings

Report query description

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "targetEntity": "string",
  • "emails": [
    ],
  • "visibility": "PUBLIC",
  • "sortBy": "string",
  • "sortOrder": "Possible value are : DESCENDING, ASCENDING",
  • "queryName": "string",
  • "queryDescription": "string",
  • "fields": [
    ]
}

This endpoint allows to load a report query resource

Return a report query

path Parameters
queryId
required
integer <int64>

Report query id

Responses

This endpoint allows to delete a report query resource

delete report query

path Parameters
queryId
required
integer <int64>

report query id

Responses

This API will download result query as csv or excel format.

download result query execution as scv or excel format

path Parameters
queryId
required
integer <int64>
query Parameters
format
string
Default: "CSV"
Enum: "CSV" "EXCEL"

format of the file to be downloaded, by default it CSV format

Responses

execute report query

Execute report query

path Parameters
queryId
required
integer <int64>

Query id

query Parameters
async
boolean

Execution type Synchronously or asynchronously

sendNotification
boolean
Default: true
Request Body schema: application/json
required

Report query object

object

Report query description

targetEntity
string

Report query description

emails
Array of strings

Report query emails

visibility
string
Enum: "PUBLIC" "PRIVATE" "PROTECTED"

Report query description

sortBy
string

Sort by

sortOrder
string
Enum: "DESCENDING" "ASCENDING"

Sort order

queryName
string

Report query code

queryDescription
string

Report query description

fields
Array of strings

Report query description

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "targetEntity": "string",
  • "emails": [
    ],
  • "visibility": "PUBLIC",
  • "sortBy": "string",
  • "sortOrder": "Possible value are : DESCENDING, ASCENDING",
  • "queryName": "string",
  • "queryDescription": "string",
  • "fields": [
    ]
}

This API will convert the generate report file to json.

look for the query result by its id get its path location, and transform csv file to json

path Parameters
queryexecutionResultId
required
integer <int64>

Responses

This endpoint allows to update an report query

update an existing report query

path Parameters
id
required
integer <int64>

Report query id

Request Body schema: application/json
required

Report query object

object

Report query description

targetEntity
string

Report query description

emails
Array of strings

Report query emails

visibility
string
Enum: "PUBLIC" "PRIVATE" "PROTECTED"

Report query description

sortBy
string

Sort by

sortOrder
string
Enum: "DESCENDING" "ASCENDING"

Sort order

queryName
string

Report query code

queryDescription
string

Report query description

fields
Array of strings

Report query description

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "targetEntity": "string",
  • "emails": [
    ],
  • "visibility": "PUBLIC",
  • "sortBy": "string",
  • "sortOrder": "Possible value are : DESCENDING, ASCENDING",
  • "queryName": "string",
  • "queryDescription": "string",
  • "fields": [
    ]
}

Verify report query

Verify the existing of the report query according to its visibility and creator

Request Body schema: application/json
required

Verify report query request

visibility
string
Enum: "PUBLIC" "PRIVATE" "PROTECTED"

Report query description

queryName
string

Report query code

Responses

Request samples

Content type
application/json
{
  • "visibility": "PUBLIC",
  • "queryName": "string"
}

SecurityDeposit

Create a Security Deposit

Create a Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Credit Security Deposit

Credit Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be credited by its id

Request Body schema: application/json
required

Security Deposit input

reference
required
string
amountToCredit
required
number
isToMatching
required
boolean
paymentInfo
required
string
paymentInfo1
required
string
paymentInfo2
required
string
paymentInfo3
required
string
paymentInfo4
required
string
paymentInfo5
required
string
paymentMethod
required
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"
customerAccountCode
required
string
occTemplateCode
required
string
bankLot
required
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "amountToCredit": 0,
  • "isToMatching": true,
  • "paymentInfo": "string",
  • "paymentInfo1": "string",
  • "paymentInfo2": "string",
  • "paymentInfo3": "string",
  • "paymentInfo4": "string",
  • "paymentInfo5": "string",
  • "paymentMethod": "CHECK",
  • "customerAccountCode": "string",
  • "occTemplateCode": "string",
  • "bankLot": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Instantiate Security Deposit

Instantiate Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Pay invoice manually with Security Deposit

Pay invoice manually with Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be the invoice with it

Request Body schema: application/json
required

Security Deposit input

amount
required
number
required
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "accountOperation": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Create

Create a Security Deposit

Create a Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Credit

Credit Security Deposit

Credit Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be credited by its id

Request Body schema: application/json
required

Security Deposit input

reference
required
string
amountToCredit
required
number
isToMatching
required
boolean
paymentInfo
required
string
paymentInfo1
required
string
paymentInfo2
required
string
paymentInfo3
required
string
paymentInfo4
required
string
paymentInfo5
required
string
paymentMethod
required
string
Enum: "CHECK" "DIRECTDEBIT" "WIRETRANSFER" "CARD" "PAYPAL" "STRIPE" "CASH"
customerAccountCode
required
string
occTemplateCode
required
string
bankLot
required
string
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "reference": "string",
  • "amountToCredit": 0,
  • "isToMatching": true,
  • "paymentInfo": "string",
  • "paymentInfo1": "string",
  • "paymentInfo2": "string",
  • "paymentInfo3": "string",
  • "paymentInfo4": "string",
  • "paymentInfo5": "string",
  • "paymentMethod": "CHECK",
  • "customerAccountCode": "string",
  • "occTemplateCode": "string",
  • "bankLot": "string",
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Pay invoice manually with Security Deposit

Pay invoice manually with Security Deposit

path Parameters
id
required
integer <int64>

contain the code of Security deposit te be the invoice with it

Request Body schema: application/json
required

Security Deposit input

amount
required
number
required
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "accountOperation": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Instantiate

Instantiate Security Deposit

Instantiate Security Deposit

Request Body schema: application/json
required

Security Deposit input

description
string
object (Resource)
status
string
Enum: "DRAFT" "LOCKED" "UNLOCKED" "AUTO_REFUND" "REFUNDED" "CANCELED" "HOLD" "VALIDATED"
validityPeriod
integer <int32>
validityPeriodUnit
string
Enum: "DAYS" "MONTHS" "WEEKS" "YEARS"
refundReason
string
required
object (Resource)
object (Resource)
externalReference
string
object (Resource)
required
object (Resource)
amount
number
cancelReason
string
currentBalance
number
object (Resource)
validityDate
string <date-time>
object (Resource)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "currency": {
    },
  • "status": "DRAFT",
  • "validityPeriod": 0,
  • "validityPeriodUnit": "DAYS",
  • "refundReason": "string",
  • "template": {
    },
  • "subscription": {
    },
  • "externalReference": "string",
  • "customerAccount": {
    },
  • "billingAccount": {
    },
  • "amount": 0,
  • "cancelReason": "string",
  • "currentBalance": 0,
  • "serviceInstance": {
    },
  • "validityDate": "2019-08-24T14:15:22Z",
  • "linkedInvoice": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Global settings

Global settings

Create Global settings

Request Body schema: application/json
required

Global settings

object (QuoteSettings)
object (Dunning)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "quoteSettings": {
    },
  • "dunning": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Global settings

Update Global settings

path Parameters
id
required
integer <int64>

Global settings id

Request Body schema: application/json
required

Global settings

object (QuoteSettings)
object (Dunning)
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "quoteSettings": {
    },
  • "dunning": {
    },
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

Put

Update Open Order settings

Update Open Order settings

path Parameters
id
required
integer <int64>

contain the code of Open Order settings te be updated by its id

Request Body schema: application/json
required

Open Order settings

useOpenOrders
boolean
applyMaximumValidity
boolean
applyMaximumValidityValue
integer <int32>
defineMaximumValidity
boolean
defineMaximumValidityValue
integer <int32>
applyMaximumValidityUnit
string
Enum: "Days" "Weeks" "Months" "Years"
useManagmentValidationForOOQuotation
boolean
code
string
Array of objects
id
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "useOpenOrders": true,
  • "applyMaximumValidity": true,
  • "applyMaximumValidityValue": 0,
  • "defineMaximumValidity": true,
  • "defineMaximumValidityValue": 0,
  • "applyMaximumValidityUnit": "Days",
  • "useManagmentValidationForOOQuotation": true,
  • "code": "string",
  • "links": [
    ],
  • "id": 0
}

AgedReceivables

Return aged balance

Returns aged balance

query Parameters
offset
integer <int64>
Default: 0
limit
integer <int64>
Default: 50
sortOrder
string
sortBy
string
customerAccountCode
string
startDate
string <date-time>
startDueDate
string <date-time>
endDueDate
string <date-time>
customerAccountDescription
string
sellerDescription
string
sellerCode
string
invoiceNumber
string
stepInDays
integer <int32>
numberOfPeriods
integer <int32>
tradingCurrency
string
funcCurrency
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "status": "OK",
  • "details": "string",
  • "causes": [
    ],
  • "id": 0,
  • "links": [
    ]
}