This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Account Financial Details

Type: object

This is object used to describe the account financial details

Type: string

OpCo's organizatinal customer number that uniquely identifies its account. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA


Examples:

"1234567"
"1234567_OVIA"

Price

Type: object

The maximum amount of credit authorized for this account

Type: integer

the actual unscaled amount


Example:

205987

Type: integer

the scale to be applied on the unscaled amount

Value must be greater or equal to 0


Example:

2

Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed


Example:

"EUR"

Price

Type: object

The amount of credit covered by insurance

Type: integer

the actual unscaled amount


Example:

205987

Type: integer

the scale to be applied on the unscaled amount

Value must be greater or equal to 0


Example:

2

Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed


Example:

"EUR"

Price

Type: object

A credit balance is the total amount of money that an account currently owe on his credit account, and that will carry over if not paid before the next billing cycle. The balance changes based on the account activity. When the account make a purchase, the balance increases. When the account make a payment, it decreases.

Type: integer

the actual unscaled amount


Example:

205987

Type: integer

the scale to be applied on the unscaled amount

Value must be greater or equal to 0


Example:

2

Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed


Example:

"EUR"

Type: stringFormat: date-time

The last date and time of this credit information


Examples:

"2021-10-12T08:30:22.804Z"
"2021-10-12T08:30:22.804+01:00"

Type: enum (of string)

The status of the credit of the account

Must be one of:

  • "ACTIVE"
  • "ON_HOLD"
  • "BLOCKED"
  • "DELETED"

Example:

"ACTIVE"

Price

Type: object

Total amount of invoiced orders to be paid in future

Type: integer

the actual unscaled amount


Example:

205987

Type: integer

the scale to be applied on the unscaled amount

Value must be greater or equal to 0


Example:

2

Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed


Example:

"EUR"

Type: object

Represents a cash discount object with properties for the discount percentage and the discount qualifier terms

Type: number

The discount percentage applied when the order is paid before the normal payment terms (e.g. immediate payment instead of 60days).

Value must be greater or equal to 0 and lesser or equal to 100


Examples:

25.5
50
75.75

Type: string

Specifies the number of days within which payment must be made to qualify for the discount.

Must be at least 1 characters long


Examples:

"30 days"
"Invoice date + 5d"
"End of month + 15d"

Type: enum (of string) Default: "OPCO"

Defines the entity holding the credit line. If not set it is assumed to be OPCO.

Must be one of:

  • "OPCO"
  • "ALLIANZ"

Type: string

Price List 1 classification assigned to the account

Must be at least 1 characters long


Example:

"Diamond price list"

Type: string

Price List 2 classification assigned to the account

Must be at least 1 characters long


Example:

"Loyal customer price list"

Price

Type: object

The total complete invoice balance for the account

Type: integer

the actual unscaled amount


Example:

205987

Type: integer

the scale to be applied on the unscaled amount

Value must be greater or equal to 0


Example:

2

Type: string

the currency code following the ISO 4217 standard 3 letter in which the prices are being displayed


Example:

"EUR"