getCustomerBalance

Retrieve current balance (store credit) for requested customers.

Input parameters

Parameter name Description Possible value Required
customerIDs String Comma separated ids
getBalanceWithoutPrepayments Integer (0 or 1)

Response

Field name Type Description
customerID Integer Customer ID.
actualBalance Decimal Amount that the customer has prepaid (NEGATIVE VALUE) or is currently due (POSITIVE VALUE). NB! The sign of the value is opposite to the usual expectation, since that's how balances are usually kept in accounting.
creditLimit Integer The credit limit that has been set to the customer.
availableCredit Decimal This value shows how much of the credit is actually available at the moment. availableCredit = creditLimit - actualBalance.
creditAllowed 0 or 1 If set to 0, customer cannot use the "pay later" option, and must pay up-front in full for each purchase.