Create an invoice profile

Create an invoice profile. Pass scope=user (default) to create a personal profile visible in the GET ?scope=user list. Pass scope=account to create an account-level profile visible in GET ?scope=account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to user

user — personal profile (default); account — company-level profile.

Allowed:
Body Params

Request body for creating an invoice profile.

string
required

Billing entity's legal name (an organisation or sole trader) — not a person. See billingContactName for the invoice contact person.

Accepted for backward compatibility but not persisted on the invoice profile — the resource has no vat_number attribute upstream. The attribute is real, but on the linked billing address instead (BillingAddressOut.vatNumber); set it via PATCH /v1/billing-addresses/{id} and reference the address with billingAddressId.

Stable Mercury UUID of the billing address (BillingAddressOut.id).

boolean
Defaults to false

Accepted for backward compatibility but not persisted — no default-marking attribute is confirmed on the invoice-profile resource upstream (unconfirmed either way), so the value is discarded and cannot change which profile is the default. The default is derived on read, not stored: see InvoiceProfileOut.isDefault (GET /v1/invoice-profiles/booking).

Free-text nickname for the profile record itself (e.g. "Head office") — not a person or the billing entity name. See billingContactName for the invoice contact person. Accepted for backward compatibility but not persisted on the invoice profile — the resource has no label attribute upstream. The attribute is real on the linked billing address instead (BillingAddressOut.label); set it via PATCH /v1/billing-addresses/{id} and reference the address with billingAddressId. See InvoiceProfileOut.label, which is always null for this same reason.

Accepted for backward compatibility but not persisted on the invoice profile — the resource has no sdiCode attribute upstream. The attribute is real on the linked billing address instead (BillingAddressOut.sdiCode); set it via PATCH /v1/billing-addresses/{id} and reference the address with billingAddressId. See InvoiceProfileOut.sdiCode, which is always null for this same reason.

Accepted for backward compatibility but not persisted on the invoice profile — the resource has no pec attribute upstream. The attribute is real on the linked billing address instead (BillingAddressOut.pec); set it via PATCH /v1/billing-addresses/{id} and reference the address with billingAddressId. See InvoiceProfileOut.pec, which is always null for this same reason.

emailRecipients
array of strings
Emailrecipients

Name of the person invoices for this profile are addressed to. Distinct from name (the billing entity's legal name) and from label (a nickname for the profile record itself). Accepted but not currently persisted — see InvoiceProfileOut.billing_contact_name for the open question this is pending on. Do not build a UI that assumes a submitted value survives a subsequent read.

Responses

401

Missing, invalid, or expired authentication token

403

Provider refused the request (resolved deny)

502

Provider rejected the request

503

Invoice profile service is temporarily unavailable

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json