BizKitHub
DocsAPI ReferenceContact/bff/contact/vat-registration-type
postContactAdmin BFF

/bff/contact/vat-registration-type

Pin the contact to PAYER / IDENTIFIED_PERSON / NON_PAYER. ARES cannot distinguish §6i identified persons from full payers (both are AKTIVNI), so this endpoint is the only way to correct that. Setting a mode always sets source=MANUAL and freezes vat_registration_type_locked_date; the ARES sync then leaves the field alone. To hand control back to ARES, call the endpoint with releaseLock=true.

ContactpostBffContactVat-registration-type

Parameters

JSON body

Request body

application/json
customerIdstringRequired

Contact external ID.

mode"PAYER" | "IDENTIFIED_PERSON" | "NON_PAYER"Optional

Manually pinned VAT registration mode. PAYER = full VAT payer (21 %). IDENTIFIED_PERSON = §6i ZDPH: holds a DIČ for EU intra-community input VAT but does NOT charge output VAT. NON_PAYER = not registered for VAT. Setting this always sets source=MANUAL, which blocks the ARES cron from overwriting it.

releaseLockbooleanOptional

Drop the MANUAL lock and clear the pinned mode so the next ARES sync (within 4 hours) fills it back in.

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true

Response example

application/json
{
  "success": true
}

Request example

POST /bff/contact/vat-registration-type

post
curl -X POST "https://api.bizkithub.com/bff/contact/vat-registration-type" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "customerId": "example_customerId",
  "releaseLock": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key