API referenceTaxCreate Vat Profile
104 operations ↓ OpenAPI JSON Get API key
POST /v1/vat-profiles

Create Vat Profile

Create a tax profile record.

Requires API key Idempotent OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader
Authorization: Bearer hc_...

Parameters

Idempotency-Keystringrequiredheader

Documented field.

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

end_customer_idstringrequiredbody

Documented field.

is_vat_registeredbooleanrequiredbody

Documented field.

uid_mwst_numberstring | nulloptionalbody

Documented field.

reporting_methodenum<effective | saldo | pauschal | not_registered>requiredbody

Documented field.

reporting_cadenceenum<quarterly | semiannual | annual | none>requiredbody

Documented field.

accounting_basisenum<agreed | collected | none>requiredbody

Documented field.

valid_fromstringrequiredbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

201Successful response.
defaultStructured error response.
401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.
api_key_expiredDocumented HelvCore error code for this operation.
idempotency_key_conflictDocumented HelvCore error code for this operation.
invalid_authDocumented HelvCore error code for this operation.
invalid_requestDocumented HelvCore error code for this operation.
missing_idempotency_keyDocumented HelvCore error code for this operation.
validation_failedDocumented HelvCore error code for this operation.