Tax Associations

Create Tax Association

Use when linking a tax rate to an entity (e.g. customer, product, or region) so that rate applies on invoices.

post/taxes/associations

Request body

auto_applyboolean
currencystring
end_datestring date-time

EndDate sets when this association expires. Must be after StartDate when both are provided.

entity_idstring
entity_type'customer' | 'subscription' | 'invoice' | 'tenant'
external_customer_idstring
metadataobject
priorityinteger
start_datestring date-time

StartDate sets when this association becomes active. Defaults to now if omitted.

tax_behavior'inclusive' | 'exclusive'
tax_rate_codestring required

Response

OK

auto_applyboolean

Whether this tax should be automatically applied

created_atstring date-time
created_bystring
currencystring

Currency

end_datestring date-time

EndDate is the optional date until which this association is active

entity_idstring

ID of the entity this tax rate applies to

entity_type'customer' | 'subscription' | 'invoice' | 'tenant'
environment_idstring

EnvironmentID is the ID of the environment this tax rate config belongs to

idstring

ID of the ent.

metadataobject

Metadata holds the value of the "metadata" field.

priorityinteger

Priority for tax resolution (lower number = higher priority)

start_datestring date-time

StartDate is the date from which this association is active

status'published' | 'deleted' | 'archived'
tax_behavior'inclusive' | 'exclusive'
tax_rate_idstring

Reference to the TaxRate entity

tenant_idstring
updated_atstring date-time
updated_bystring

Changes

Changed in 10 of the 110 revisions of this API.272841

    • removed the optional property tax_rate/fixed_value from the response with the 200 status

      response-optional-property-removed

    • added the new optional request property tax_behavior

      new-optional-request-property

    • added the optional property tax_behavior to the response with the 200 status

      response-optional-property-added

    • removed the fixed enum value from the tax_rate/tax_rate_type response property for the response status 200

      response-property-enum-value-removed

    • added the new not_implemented enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new not_implemented enum value to the code response property for the response status 500

      response-property-enum-value-added

    • the end_date request property type/format changed from string/ to string/date-time

      request-property-type-changed

    • the start_date request property type/format changed from string/ to string/date-time

      request-property-type-changed

  • 7d57386313c78174See the full diff
    • request property entity_type was restricted to a list of enum values

      request-property-became-enum

    • the entity_type request property type/format changed from / to string/

      request-property-type-changed

    • the entity_type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the tax_rate/scope response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the tax_rate/status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the tax_rate/tax_rate_status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • the tax_rate/tax_rate_type response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • added the new ACTIVE enum value to the tax_rate/tax_rate_status response property for the response status 200

      response-property-enum-value-added

    • added the new EXTERNAL enum value to the tax_rate/scope response property for the response status 200

      response-property-enum-value-added

    • added the new INACTIVE enum value to the tax_rate/tax_rate_status response property for the response status 200

      response-property-enum-value-added

    • added the new INTERNAL enum value to the tax_rate/scope response property for the response status 200

      response-property-enum-value-added

    • added the new ONETIME enum value to the tax_rate/scope response property for the response status 200

      response-property-enum-value-added

    • added the new archived enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new archived enum value to the tax_rate/status response property for the response status 200

      response-property-enum-value-added

    • added the new customer enum value to the entity_type response property for the response status 200

      response-property-enum-value-added

    • added the new deleted enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new deleted enum value to the tax_rate/status response property for the response status 200

      response-property-enum-value-added

    • added the new fixed enum value to the tax_rate/tax_rate_type response property for the response status 200

      response-property-enum-value-added

    • added the new invoice enum value to the entity_type response property for the response status 200

      response-property-enum-value-added

    • added the new percentage enum value to the tax_rate/tax_rate_type response property for the response status 200

      response-property-enum-value-added

    • added the new published enum value to the status response property for the response status 200

      response-property-enum-value-added

    • added the new published enum value to the tax_rate/status response property for the response status 200

      response-property-enum-value-added

    • added the new subscription enum value to the entity_type response property for the response status 200

      response-property-enum-value-added

    • added the new tenant enum value to the entity_type response property for the response status 200

      response-property-enum-value-added

    • added the new customer enum value to the request property entity_type

      request-property-enum-value-added

    • added the new invoice enum value to the request property entity_type

      request-property-enum-value-added

    • added the new subscription enum value to the request property entity_type

      request-property-enum-value-added

    • added the new tenant enum value to the request property entity_type

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b1a811c41791719See the full diff
    • removed the enum value customer of the request property entity_type

      request-property-enum-value-removed

    • removed the enum value invoice of the request property entity_type

      request-property-enum-value-removed

    • removed the enum value subscription of the request property entity_type

      request-property-enum-value-removed

    • removed the enum value tenant of the request property entity_type

      request-property-enum-value-removed

    • the entity_type request property type/format changed from string/ to /

      request-property-type-changed

    • the created_at response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the end_date response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the entity_type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the start_date response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tax_rate/created_at response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the tax_rate/scope response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tax_rate/status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tax_rate/tax_rate_status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tax_rate/tax_rate_type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the tax_rate/updated_at response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the updated_at response's property type/format changed from string/date-time to string/ for status 200

      response-property-type-changed

    • the end_date request property type/format was generalized from string/date-time to string/

      request-property-type-generalized

    • the start_date request property type/format was generalized from string/date-time to string/

      request-property-type-generalized

    • removed the ACTIVE enum value from the tax_rate/tax_rate_status response property for the response status 200

      response-property-enum-value-removed

    • removed the EXTERNAL enum value from the tax_rate/scope response property for the response status 200

      response-property-enum-value-removed

    • removed the INACTIVE enum value from the tax_rate/tax_rate_status response property for the response status 200

      response-property-enum-value-removed

    • removed the INTERNAL enum value from the tax_rate/scope response property for the response status 200

      response-property-enum-value-removed

    • removed the ONETIME enum value from the tax_rate/scope response property for the response status 200

      response-property-enum-value-removed

    • removed the archived enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the archived enum value from the tax_rate/status response property for the response status 200

      response-property-enum-value-removed

    • removed the customer enum value from the entity_type response property for the response status 200

      response-property-enum-value-removed

    • removed the deleted enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the deleted enum value from the tax_rate/status response property for the response status 200

      response-property-enum-value-removed

    • removed the fixed enum value from the tax_rate/tax_rate_type response property for the response status 200

      response-property-enum-value-removed

    • removed the invoice enum value from the entity_type response property for the response status 200

      response-property-enum-value-removed

    • removed the percentage enum value from the tax_rate/tax_rate_type response property for the response status 200

      response-property-enum-value-removed

    • removed the published enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the published enum value from the tax_rate/status response property for the response status 200

      response-property-enum-value-removed

    • removed the subscription enum value from the entity_type response property for the response status 200

      response-property-enum-value-removed

    • removed the tenant enum value from the entity_type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property end_date

      new-optional-request-property

    • added the new optional request property start_date

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property end_date to the response with the 200 status

      response-optional-property-added

    • added the optional property start_date to the response with the 200 status

      response-optional-property-added

    • removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • added the new too_many_requests enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new too_many_requests enum value to the code response property for the response status 500

      response-property-enum-value-added

    • removed the optional property error from the response with the 400 status

      response-optional-property-removed

    • removed the optional property error from the response with the 500 status

      response-optional-property-removed

    • removed the optional property success from the response with the 400 status

      response-optional-property-removed

    • removed the optional property success from the response with the 500 status

      response-optional-property-removed

    • added the optional property code to the response with the 400 status

      response-optional-property-added

    • added the optional property code to the response with the 500 status

      response-optional-property-added

    • added the optional property details to the response with the 400 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    • added the optional property http_status_code to the response with the 400 status

      response-optional-property-added

    • added the optional property http_status_code to the response with the 500 status

      response-optional-property-added

    • added the optional property message to the response with the 400 status

      response-optional-property-added

    • added the optional property message to the response with the 500 status

      response-optional-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property external_customer_id

      new-optional-request-property

    • the request property entity_id became optional

      request-property-became-optional

    • the request property entity_type became optional

      request-property-became-optional