POST /v1/credit-notes

Create Credit Note Draft

Create a v0.1 additive credit-note draft. Numbering and snapshots are assigned only when issued.

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.

fiscal_year_idstringrequiredbody

Documented field.

currencyenum<CHF | EUR>requiredbody

Documented field.

customerobjectrequiredbody

Documented field.

linesarrayrequiredbody

Documented field.

original_document_idstringoptionalbody

Documented field.

rewrites_originalbooleanoptionalbody

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.

curl -X POST https://api.helvcore.ch/v1/credit-notes \ -H "Authorization: Bearer $HELVCORE_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "currency": "CHF", "customer": { "name": "string", "structured_address": {}, "uid_mwst_number": "string" }, "end_customer_id": "00000000-0000-4000-8000-000000000000", "fiscal_year_id": "string", "lines": [ { "description": "string", "gross_amount": { "amount_minor": 123, "currency": "CHF" }, "net_amount": { "amount_minor": 123, "currency": "CHF" }, "quantity_milli": 123, "tax_amount": { "amount_minor": 123, "currency": "CHF" }, "tax_code_id": "string", "unit_amount": { "amount_minor": 123, "currency": "CHF" }, "account_mapping_id": "string" } ], "original_document_id": "string", "rewrites_original": true }'

{ "currency": "CHF", "customer": { "name": "string", "structured_address": {}, "uid_mwst_number": "string" }, "end_customer_id": "00000000-0000-4000-8000-000000000000", "fiscal_year_id": "string", "lines": [ { "description": "string", "gross_amount": { "amount_minor": 123, "currency": "CHF" }, "net_amount": { "amount_minor": 123, "currency": "CHF" }, "quantity_milli": 123, "tax_amount": { "amount_minor": 123, "currency": "CHF" }, "tax_code_id": "string", "unit_amount": { "amount_minor": 123, "currency": "CHF" }, "account_mapping_id": "string" } ], "original_document_id": "string", "rewrites_original": true }