API Reference

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 interface only), POST /credits/actions/reduce (enterprise interface only)

Query Params
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.

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.

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.

string
enum

Direction of sorting the response list.

Allowed:
string
required

The unique ID of the customer.

string

The unique ID of the store in CareCloud.

string

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

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.

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.

string

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

string

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

Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

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.

Updated 5 days ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 days ago