Docs API Reference Contact Credit/bff/contact-credit/reason/list-selectbox

/bff/contact-credit/reason/list-selectbox

Returns active, non-deleted credit reasons with default amounts so the admin UI can pre-fill the credit form when a reason is selected.

Contact CreditgetBffContact-creditReasonList-selectbox

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

externalIdstringRequired

Reason external ID (16 chars).

codestringRequired

Reason code.

namestringRequired

Display name.

descriptionstringOptional

Internal note shown in admin to clarify when this reason should be used.

defaultAmountnumberRequired

Preset credit amount.

defaultAmountMoneynumberOptional

Preset monetary value in the organisation default currency. Omitted when not configured — clients should fall back to defaultAmount (1:1).

Response example

application/json

{
  "items": [
    {
      "externalId": "example_externalId",
      "code": "example_code",
      "name": "example_name",
      "description": "example_description",
      "defaultAmount": 0,
      "defaultAmountMoney": 0
    }
  ]
}

Request example

GET /bff/contact-credit/reason/list-selectbox

get

curl -X GET "https://api.bizkithub.com/bff/contact-credit/reason/list-selectbox" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key