Docs API Reference Contact Credit/bff/contact-credit/credit-by-payer-branch

/bff/contact-credit/credit-by-payer-branch

Returns credit transactions whose payer_branch_id resolves to the requested branch — i.e. credits the operator attributed to this branch as the internal payer. Ordered by inserted date desc. totalAmount is the signed sum of credit counts; totalAmountMoney is the signed sum in the organisation default currency.

Contact CreditgetBffContact-creditCredit-by-payer-branch

Parameters

1 query

1 total

Query · 1

branchSlugstringRequired

Branch slug.

Request

GET /bff/contact-credit/credit-by-payer-branch

get

curl -X GET "https://api.bizkithub.com/bff/contact-credit/credit-by-payer-branch?branchSlug=gymroom-plzen" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "branchId": "example_branchId",
  "branchSlug": "example_branchSlug",
  "branchName": "example_branchName",
  "currency": "example_currency",
  "totalAmount": 0,
  "totalAmountMoney": 0,
  "items": [
    {
      "id": "example_id",
      "amount": 0,
      "amountMoney": 0,
      "customer": {
        "contactId": "example_contactId",
        "firstName": "example_firstName",
        "lastName": "example_lastName",
        "companyName": "example_companyName"
      },
      "order": {
        "orderNumber": "example_orderNumber",
        "hash": "example_hash"
      },
      "reason": {
        "externalId": "example_externalId",
        "code": "example_code",
        "name": "example_name"
      },
      "description": "example_description"
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key