Invoice details / Create or update

post

https://{tenantUrl}/public-api/resources/users/v1.0/{user}/invoice-details

Create or update user invoice details.

Important: When the operator has "Always collect Invoice Details" enabled in their invoice integration settings, the requireInvoice field will always be set to true regardless of the request payload value. This override ensures regulatory compliance and business policy enforcement. No error is returned when overrides occur as this is intentional behavior.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user

integer

required

Body Params

Built-in invoice processor

requireInvoice

boolean

required

Defaults to false

Whether invoice is required for this user. Note: If the operator has 'Always collect Invoice Details' enabled in their invoice integration settings, this field will always be true regardless of the request payload value.

invoiceType

string | null

enum

required

Allowed:

individualName

string | null

individualPersonalId

string | null

individualTaxId

string | null

companyName

string | null

companyRegNo

string | null

companyTaxId

string | null

companyTaxAdministrationOfficeName

string | null

country

string | null

enum

region

string | null

When country is not in US, AU, CA, UM or RO, you can provide the region

state

enum

When the selected country is one of US, AU, CA, UM or RO

When the country is US.

city

string | null

postCode

string | null

address

string | null

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Invoice details created or updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*