BizKitHub Developer Documentation

/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.

Parameters

1 query

Query parameters

· 1

branchSlugstringRequired

Branch slug.

Examplegymroom-plzen

Response schema

1 status code documented

200Success

branchIdstringRequired

Branch internal id as string.

branchSlugstringRequired

branchNamestringRequired

currencystringRequired

ISO 4217 code of the organisation default currency.

totalAmountnumberRequired

Signed sum of credit counts.

totalAmountMoneynumberRequired

Signed sum of monetary values in the org currency.

itemsobject[]Required

Each array item:

idstringRequired

Credit transaction external ID.

amountnumberRequired

amountMoneynumberRequired

customerobjectRequired

contactIdstringRequired

Customer external ID (CuRefNo).

firstNamestringOptional

lastNamestringOptional

companyNamestringOptional

orderobjectOptional

orderNumberstringRequired

hashstringRequired

reasonobjectOptional

externalIdstringRequired

codestringRequired

namestringRequired

descriptionstringOptional

insertedDateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

itemCountnumberRequired

Response example

application/json

{
  "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
}