billingEntities

Update or create a billing entity (upsert)

Requires the BILLING_ENTITY.CREATE or BILLING_ENTITY.UPDATE permission.

put/v{version}/billing-entities

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/billing-entities
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

identifier_fieldstring

Which field to use to identify whether the resource exists or not

custom_field_referencestring

Which custom field to use to identify whether the resource exists or not

field_actionsobject

The list of actions for specific fields.

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
created_atstring nullable
referencestring required
statusstring nullable
timezonestring nullable
legal_namestring nullable

The legal name of the billing entity.

tax_idstring nullable

The ID used for tax purposes of the billing entity.

registration_numberstring nullable

The registration number of the billing entity.

emailstring nullable

The email address of the billing entity.

default_customer_country_selectorBillingEntityCreateRequestDefaultCustomerCountrySelectorItems[] nullable
default_billing_currency_selectorBillingEntityCreateRequestDefaultBillingCurrencySelectorItems[] nullable

Response

Created

object_typestring nullable
idstring nullable
created_atstring nullable
referencestring
statusstring nullable
timezonestring nullable
legal_namestring nullable

The legal name of the billing entity.

tax_idstring nullable

The ID used for tax purposes of the billing entity.

registration_numberstring nullable

The registration number of the billing entity.

emailstring nullable

The email address of the billing entity.

default_customer_country_selectorBillingEntityDefaultCustomerCountrySelectorItems[] nullable
default_billing_currency_selectorBillingEntityDefaultBillingCurrencySelectorItems[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.