Skip to content

Customer Account Log

Defines a transaction on a customer account.

Warning

Please note that for credit operations, it is the responsibility of the integrator to create tax documents.

Customer account log schema

_cloudId integer
Cloud ID
📶 EQUALS,ENUM

_customerAccountId long?
Customer account ID
📶 EQUALS,ENUM

_employeeId long?
Employee ID
📶 EQUALS,ENUM

_moneyLogId long?
Money log ID
📶 EQUALS,ENUM

_orderId long?
Order ID
📶 EQUALS,ENUM

_previousCustomerAccountLogId long?
Previous customer account log ID
📶 EQUALS,ENUM

amount BigDecimal
The amout of the transaction
📶 NUMBER

balance BigDecimal
The account balance after the transaction
📶 NUMBER

created timestamp
Timestamp of created record
📶 EQUALS,ENUM,NUMBER

currency string
Three-letter currency according to ISO 4217
📶 STRING 🔽 BOTH

id long
Customer account log ID
📶 EQUALS,ENUM

note string
Custom note for the transaction

source string
Identification of the source where the transaction took place

type enum
Account log type, supported values: "top-up", "payment", "refund"
📶 STRING 🔽 BOTH

JSON response

{
    "_customerAccountId": <long>,
    "_employeeId": <long>,
    "_moneyLogId": <long>,
    "_orderId": <long>,
    "_previousCustomerAccountLogId": <long>,
    "amount": <BigDecimal>,
    "balance": <BigDecimal>,
    "created": <timestamp>,
    "currency": <string>,
    "id": <long>,
    "note": <string>,
    "source": <string>,
    "type": <enum>
}

Create customer account log

POST https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs

This EP requires an existing customer account as specified by _customerAccountId.

Path Parameters

Name Type Description
cloudId* integer

Headers

Name Type Description
Authorization* string Bearer accessToken

Create customer account (if needed) and log

POST https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs

If the customer does not have the default account, create it first. Then create the account log.

Path Parameters

Name Type Description
cloudId* integer
customerId long
accountType string valid value: default

Headers

Name Type Description
Authorization* string Bearer accessToken

Get customer account logs for customer

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs

Path Parameters

Name Type Description
cloudId* integer
customerId long
accountType string valid value: default

Headers

Name Type Description
Authorization* string Bearer accessToken

Query Parameters

Name Type Description
sort string
page integer
filter string
limit integer

Get customer account log by ID for customer

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId/accounts/:accountType/logs/:customerAccountLogId

Path Parameters

Name Type Description
cloudId* integer
customerId long
accountType string valid value: default
customerAccountLogId long

Headers

Name Type Description
Authorization* string Bearer accessToken

Get customer account log by ID

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs/:customerAccountLogId

Path Parameters

Name Type Description
cloudId* integer
customerAccountLogId long

Headers

Name Type Description
Authorization* string Bearer accessToken

Search customer account logs

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customer-account-logs

Path Parameters

Name Type Description
cloudId* integer

Headers

Name Type Description
Authorization* string Bearer accessToken

Query Parameters

Name Type Description
sort string
page integer
filter string
limit integer