Get credit transaction history

get

https://{project_url}/webservice/rest-api/{api_interface}/{version}/credit-history

Get a list of credit transactions of the customer.

Credit history is a chronological audit log of all credit operations on a customer account. Each record captures the operation type (deposit, reduction, or transfer), the amount, timestamp, store, partner, and an optional note.

The customer_id parameter is required. Filter by operation type using credit_operation_type, or search within notes using credit_operation_note. Use time_from and time_to to scope results to a date range.

Related: GET /credits, POST /credits/actions/deposit (Enterprise API only), POST /credits/actions/reduce (Enterprise API only)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

enum

Direction of sorting the response list.

Allowed:

customer_id

string

required

The unique ID of the customer. GET /customers

store_id

string

The unique ID of the store in CareCloud. GET /stores

partner_id

string

Unique ID of the partner from the resource GET /partners.

time_from

string

Start of the time interval for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

time_to

string

End of the time interval for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

credit_operation_type

string

Search record by the operation type name or a part of the operation type name.

credit_operation_note

string

Search record by the operation note or a part of the operation note.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.