Retrieve the Customer Credit Balance Report

GET

business

{business_id}

reports

customer-credits

Retrieve the Customer Credit Balance Report

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/reports/customer-credits \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "customer_id": "<string>",
      "total_credits": 123,
      "total_applied_credits": 123,
      "total_available_credits": 123,
      "customer_name": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id

string<biz_string>

required

The ID of the Business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Response

Successful Response

data

CustomerCreditReportLine · object[]

required

Show child attributes

⌘I

Retrieve the Customer Credit Balance Report

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/reports/customer-credits \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "customer_id": "<string>",
      "total_credits": 123,
      "total_applied_credits": 123,
      "total_available_credits": 123,
      "customer_name": "<string>"
    }
  ]
}