Get customer's contracts by

Deprecated

Required Scopes(any of): `CUSTOMER_CONTRACT_READ`, `CUSTOMER_READ` Returns customer's contracts by one of the given parameters

Endpoint

GET /v1/customers/contracts/by

Query Parameters

cardNumber string

Card number to identify the customer

cardNumberFormat string
Allowed values:
DECIMAL
HEX_MSB
HEX_LSB

Default:  DECIMAL

debtorId string

Unique ID of the debtor

qrCodeUuid deprecated string (uuid)

QR code UUID to identify the customer

barcode string

Barcode to identify the customer

pin string

PIN to identify the customer

customerNumber string

Customer number to identify the customer

status string
Allowed values:
ACTIVE Identifies active contracts
INACTIVE Identifies inactive contracts

Responses

OK

Response Body application/json

array[object]
id integer(int64) required

Unique ID of the contract

Example:  1000
createdDate string(date) required

Creation date of the contract

Example:  "2022-01-01"
startDate string(date) required

Start date of the contract

Example:  "2022-01-01"
endDate string(date) required

End date of the contract

Example:  "2022-10-01"
rateName required

Rate name for the contract

Example:  "Premium"
rateCodes array[object]

Rate codes of this contract

name

The name of the rate code

Example:  "Standard Rate"
identifier

Unique identifier for the rate code.

Example:  "RC12345"
contractStatus required

The contracts desired or current status

Allowed values:
ACTIVE Identifies active contracts
INACTIVE Identifies inactive contracts
Example:  "ACTIVE"
cancellationPeriod

Represents a time period

periodValue integer(int32) required

Defines how many units a given period lasts

Example:  10
periodUnit required

Unit of the period

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "DAY"
cancelled required

Defines whether or not the current active contract has been cancelled

cancellationDate string(date)

Contract cancellation date

Example:  "2022-10-10"
cancellationReceiptDate string(date)

Contract cancellation receipt date

Example:  "2022-10-10"
cancellationReason

Reason of the contract cancellation

Example:  "Officially ordered studio closure"
price required deprecated

Base price of the contract

Example:  19.9
priceDetails required

Price details of the contract

basePrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
currentPrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
paymentFrequency required

Represents the payment frequency of a contract

id integer(int64)

Unique ID of the payment frequency of a contract

Example:  203
type required

Payment frequency type of a contract

Allowed values:
FREE Represents that the contract payment frequency is free of charge.
NON_RECURRING Represents that the contract payment frequency is non recurring, meaning only one payment is necessary here.
RECURRING Represents that the contract payment frequency is recurring, meaning that the payment will take place every term.
MONTH_DAY Represents that the contract payment frequency is based on month days, with a possibly individual price per month day.
TERM_BASED Represents that the contract payment frequency is based on terms, with a possibly individual price per term.
Example:  "FREE"
term

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
monthDaysToPrices array[object]

Month day to prices list, used for contract payment frequency type `MONTH_DAY`

monthDay required

The month day of the month day to price mapping

month
Allowed values:
JANUARY FEBRUARY MARCH APRIL MAY JUNE JULY AUGUST SEPTEMBER OCTOBER NOVEMBER DECEMBER
monthValue integer(int32)
dayOfMonth integer(int32)
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
termsToPrices array[object]

Terms to prices list, used for contract payment frequency type `TERM_BASED`. Note that the price will become active AFTER the respective term has passed

term required

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
lastPossibleCancellationDate string(date) required

Latest date when the contract can be cancelled

term required

Represents a time period

periodValue integer(int32) required

Defines how many units a given period lasts

Example:  10
periodUnit required

Unit of the period

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "DAY"
extensionTerm required

Represents a time period

periodValue integer(int32) required

Defines how many units a given period lasts

Example:  10
periodUnit required

Unit of the period

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "DAY"
flatFeeContracts array[object]

List of flat fee contracts

id integer(int64) required

Unique ID of the contract

rateName required

Rate name for the contract

Example:  "Regular"
startDate string(date) required

Start date of the contract

endDate string(date)

End date of contract

paymentFrequency required

Type of payment frequency

Allowed values:
NON_RECURRING RECURRING MONTH_DAY TERM_BASED FREE
price required deprecated

Base price of the contract

Example:  19.9
priceDetails required

Price details of the contract

basePrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
currentPrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
paymentFrequency required

Represents the payment frequency of a contract

id integer(int64)

Unique ID of the payment frequency of a contract

Example:  203
type required

Payment frequency type of a contract

Allowed values:
FREE Represents that the contract payment frequency is free of charge.
NON_RECURRING Represents that the contract payment frequency is non recurring, meaning only one payment is necessary here.
RECURRING Represents that the contract payment frequency is recurring, meaning that the payment will take place every term.
MONTH_DAY Represents that the contract payment frequency is based on month days, with a possibly individual price per month day.
TERM_BASED Represents that the contract payment frequency is based on terms, with a possibly individual price per term.
Example:  "FREE"
term

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
monthDaysToPrices array[object]

Month day to prices list, used for contract payment frequency type `MONTH_DAY`

monthDay required

The month day of the month day to price mapping

month
Allowed values:
JANUARY FEBRUARY MARCH APRIL MAY JUNE JULY AUGUST SEPTEMBER OCTOBER NOVEMBER DECEMBER
monthValue integer(int32)
dayOfMonth integer(int32)
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
termsToPrices array[object]

Terms to prices list, used for contract payment frequency type `TERM_BASED`. Note that the price will become active AFTER the respective term has passed

term required

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
cancelled required

Defines whether or not the current active contract has been cancelled

cancellationDate string(date)

Contract cancellation date

Example:  "2022-10-10"
cancellationReceiptDate string(date)

Contract cancellation receipt date

Example:  "2022-10-10"
contractStatus required

The contracts desired or current status

Allowed values:
ACTIVE Identifies active contracts
INACTIVE Identifies inactive contracts
Example:  "ACTIVE"
rateCodes array[object]

Rate codes of this contract

name

The name of the rate code

Example:  "Standard Rate"
identifier

Unique identifier for the rate code.

Example:  "RC12345"
moduleContracts array[object]

List of module contracts

id integer(int64) required

Unique ID of the contract

rateName required

Rate name for the contract

Example:  "Regular"
startDate string(date) required

Start date of the contract

endDate string(date)

End date of contract

paymentFrequency required

Type of payment frequency

Allowed values:
NON_RECURRING RECURRING MONTH_DAY TERM_BASED FREE
price required deprecated

Base price of the contract

Example:  19.9
priceDetails required

Price details of the contract

basePrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
currentPrice required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
paymentFrequency required

Represents the payment frequency of a contract

id integer(int64)

Unique ID of the payment frequency of a contract

Example:  203
type required

Payment frequency type of a contract

Allowed values:
FREE Represents that the contract payment frequency is free of charge.
NON_RECURRING Represents that the contract payment frequency is non recurring, meaning only one payment is necessary here.
RECURRING Represents that the contract payment frequency is recurring, meaning that the payment will take place every term.
MONTH_DAY Represents that the contract payment frequency is based on month days, with a possibly individual price per month day.
TERM_BASED Represents that the contract payment frequency is based on terms, with a possibly individual price per term.
Example:  "FREE"
term

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
monthDaysToPrices array[object]

Month day to prices list, used for contract payment frequency type `MONTH_DAY`

monthDay required

The month day of the month day to price mapping

month
Allowed values:
JANUARY FEBRUARY MARCH APRIL MAY JUNE JULY AUGUST SEPTEMBER OCTOBER NOVEMBER DECEMBER
monthValue integer(int32)
dayOfMonth integer(int32)
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
termsToPrices array[object]

Terms to prices list, used for contract payment frequency type `TERM_BASED`. Note that the price will become active AFTER the respective term has passed

term required

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
cancelled required

Defines whether or not the current active contract has been cancelled

cancellationDate string(date)

Contract cancellation date

Example:  "2022-10-10"
cancellationReceiptDate string(date)

Contract cancellation receipt date

Example:  "2022-10-10"
contractStatus required

The contracts desired or current status

Allowed values:
ACTIVE Identifies active contracts
INACTIVE Identifies inactive contracts
Example:  "ACTIVE"
rateCodes array[object]

Rate codes of this contract

name

The name of the rate code

Example:  "Standard Rate"
identifier

Unique identifier for the rate code.

Example:  "RC12345"
signedDocumentUrl

Url to download the contract related document. It will expire after 15 minutes

thirdPartyId

Unique ID of the third party contract in the third party system

Example:  "1000a"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"