GET
View a customer payment
Company space For: Cashier and seller, Manager, Accountant · Permission: customer_credit_payments.retrieve Part of Collect customer credit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerCreditPayment
string
required

Identifier of the customer payment.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, customer_id, source, cash_register_id, amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, conversion_snapshot, actual_fee_amount, register_payment_method_id, payment_method, money_account_id, cash_account_id, payment_date, reference, description, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the payment.

customer_id

Customer who paid.

source

Where the payment was taken: cash_register.

cash_register_id

Register where the payment was taken.

amount
integer

Amount received, converted into the company currency, in minor units of currency_code.

currency_code

Company currency, in which amount is expressed.

currency_exponent
integer

Number of decimal places of the company currency.

original_amount
integer

Amount as the customer paid it, in minor units of original_currency_code.

original_currency_code

Currency the customer paid in.

original_currency_exponent
integer

Number of decimal places of that currency.

conversion_snapshot
object | null

Exchange rate details used to convert the payment into the company currency, as recorded in the accounts.

actual_fee_amount
integer | null

Fee the operator actually took, in minor units, when one was given.

register_payment_method_id

Register payment method that received the money.

payment_method

Kind of payment: cash, credit_card, bank_transfer, mobile_money or cheque.

money_account_id

Money account linked to the register payment method that received the money, when that method has one.

cash_account_id

Cash account that received the money, for cash payments.

payment_date

Moment the payment was recorded.

reference

Your reference for the payment.

description

Note kept on the payment.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).