{ "openapi" : "3.0.0", "info" : { "title" : "", "description" : "", "version" : "" }, "servers" : [ { "url" : "https://dev.seqhq.io", "description" : "E2E" }, { "url" : "https://dev.seqhq.io", "description" : "DEV" }, { "url" : "https://sandbox.sequencehq.com", "description" : "SANDBOX" }, { "url" : "https://eu.sequencehq.com", "description" : "PRODUCTION" } ], "tags" : [ { "name" : "Tax Rates" }, { "name" : "Tax Registrations" } ], "paths" : { "/tax-rates/{id}" : { "get" : { "tags" : [ "Tax Rates" ], "summary" : "Get a Tax Rate by ID", "description" : "Get a Tax Rate by ID", "operationId" : "getTaxRatesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Tax Rate ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxRateResponse", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } }, "examples" : { "TaxRateResponse" : { "summary" : "", "value" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Tax Rates" ], "summary" : "Update a TaxRate", "description" : "Update a TaxRate", "operationId" : "putTaxRatesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "TaxRate ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateTaxRateRequest", "example" : { "id" : "0373904e-0f24-4c19-bb0d-9b855f1ec3ca", "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } }, "examples" : { "UpdateTaxRateRequest" : { "summary" : "", "value" : { "id" : "0373904e-0f24-4c19-bb0d-9b855f1ec3ca", "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxRateResponse", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } }, "examples" : { "TaxRateResponse" : { "summary" : "", "value" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } } } } } } } }, "delete" : { "tags" : [ "Tax Rates" ], "summary" : "Delete a Tax Rate", "description" : "Delete a Tax Rate", "operationId" : "deleteTaxRatesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Tax Rate ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxRateResponse", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } }, "examples" : { "TaxRateResponse" : { "summary" : "", "value" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-rates" : { "get" : { "tags" : [ "Tax Rates" ], "summary" : "List all Tax Rates", "description" : "List all Tax Rates", "operationId" : "getTaxRates", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListResponse", "example" : { "items" : [ { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } }, "examples" : { "ListResponse" : { "summary" : "", "value" : { "items" : [ { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "post" : { "tags" : [ "Tax Rates" ], "summary" : "Create a new TaxRate", "description" : "Create a new TaxRate", "operationId" : "postTaxRates", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTaxRateRequest", "example" : { "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } }, "examples" : { "CreateTaxRateRequest" : { "summary" : "", "value" : { "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxRateResponse", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } }, "examples" : { "TaxRateResponse" : { "summary" : "", "value" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-registrations" : { "get" : { "tags" : [ "Tax Registrations" ], "summary" : "List all Tax Registrations", "description" : "List all Tax Registrations", "operationId" : "getTaxRegistrations", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductListTaxRegistrationPaginatedResponseModel", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } }, "examples" : { "ProductListTaxRegistrationPaginatedResponseModel" : { "summary" : "", "value" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "post" : { "tags" : [ "Tax Registrations" ], "summary" : "Create a new Tax Registration", "description" : "Create a new Tax Registration", "operationId" : "postTaxRegistrations", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateTaxRegistrationRequestModel", "example" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "CreateTaxRegistrationRequestModel" : { "summary" : "", "value" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductCreateTaxRegistrationResponseModel", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "ProductCreateTaxRegistrationResponseModel" : { "summary" : "", "value" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-registrations/{id}" : { "get" : { "tags" : [ "Tax Registrations" ], "summary" : "Get a Tax Registration by ID", "description" : "Get a Tax Registration by ID", "operationId" : "getTaxRegistrationsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Tax registration ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductGetTaxRegistrationResponseModel", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "ProductGetTaxRegistrationResponseModel" : { "summary" : "", "value" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Tax Registrations" ], "summary" : "Update a Tax Registration", "description" : "Update a Tax Registration", "operationId" : "putTaxRegistrationsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Tax registration ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateTaxRegistrationRequestModel", "example" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "UpdateTaxRegistrationRequestModel" : { "summary" : "", "value" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductUpdateTaxRegistrationResponseModel", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "ProductUpdateTaxRegistrationResponseModel" : { "summary" : "", "value" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } } } } }, "delete" : { "tags" : [ "Tax Registrations" ], "summary" : "Delete a Tax Registration", "description" : "Delete a Tax Registration", "operationId" : "deleteTaxRegistrationsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Tax registration ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductDeleteTaxRegistrationResponseModel", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } }, "examples" : { "ProductDeleteTaxRegistrationResponseModel" : { "summary" : "", "value" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-rates/{id}/archive" : { "post" : { "tags" : [ "Tax Rates" ], "summary" : "Archive a tax rate", "description" : "Archive a tax rate", "operationId" : "postTaxRatesByIdArchive", "parameters" : [ { "name" : "id", "in" : "path", "description" : "TaxRate ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProductArchiveTaxRateResponseModel", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "sequenceAccountId" : "dce9ae85-d8d0-42b4-bcad-f221a64363c6", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "subRates" : [ ], "isArchived" : true } }, "examples" : { "ProductArchiveTaxRateResponseModel" : { "summary" : "", "value" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "sequenceAccountId" : "dce9ae85-d8d0-42b4-bcad-f221a64363c6", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "subRates" : [ ], "isArchived" : true } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-registrations/for-merchant/{id}" : { "get" : { "tags" : [ "Tax Registrations" ], "summary" : "Get all tax registrations for a merchant by merchant ID", "description" : "Get all tax registrations for a merchant by merchant ID", "operationId" : "getTaxRegistrationsForMerchantById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Merchant ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MerchantTaxRegistrationsResponse", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } } }, "examples" : { "MerchantTaxRegistrationsResponse" : { "summary" : "", "value" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/tax-registrations/for-customer/{id}" : { "get" : { "tags" : [ "Tax Registrations" ], "summary" : "Get all tax registrations for a customer by customer ID", "description" : "Get all tax registrations for a customer by customer ID", "operationId" : "getTaxRegistrationsForCustomerById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Customer ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerTaxRegistrationsResponse", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } } }, "examples" : { "CustomerTaxRegistrationsResponse" : { "summary" : "", "value" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } } } } } } } } }, "servers" : [ ], "parameters" : [ ] } }, "components" : { "schemas" : { "UpdateTaxRateRequest" : { "required" : [ "amount", "country", "id", "invoiceName", "invoiceShortName", "isPublished", "name" ], "type" : "object", "example" : { "id" : "0373904e-0f24-4c19-bb0d-9b855f1ec3ca", "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" }, "properties" : { "id" : { "type" : "string", "description" : "Tax Rate ID", "example" : "0373904e-0f24-4c19-bb0d-9b855f1ec3ca" }, "isPublished" : { "type" : "boolean", "description" : "Tax Rate status", "example" : false }, "name" : { "type" : "string", "description" : "The full name of the tax rate, e.g. \"Sales tax\"", "example" : "UK Sales Tax" }, "invoiceName" : { "type" : "string", "description" : "The long name used on the invoice, e.g. \"Value Added Tax\"", "example" : "Value Added Tax" }, "invoiceShortName" : { "type" : "string", "description" : "The short name used on the invoice, e.g. \"VAT\"", "example" : "VAT" }, "description" : { "type" : "string", "description" : "The description of the tax rate", "nullable" : true, "example" : "Value Added Tax applied to sales in the UK" }, "amount" : { "type" : "string", "description" : "The tax rate. Must be between 0 and 100.", "example" : "0.2" }, "country" : { "description" : "The country that this tax rate applies to", "$ref" : "#/components/schemas/CountryCode" }, "region" : { "type" : "string", "description" : "The region that this tax rate applies to", "nullable" : true, "example" : "London" }, "taxCategoryId" : { "type" : "string", "description" : "The Tax Category Version ID that this Tax Rate is part of", "nullable" : true, "example" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } } }, "CountryCode" : { "type" : "string", "example" : "GB", "enum" : [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ] }, "TaxRateResponse" : { "required" : [ "amount", "country", "id", "invoiceName", "invoiceShortName", "isArchived", "isPublished", "name", "version", "versionId" ], "type" : "object", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" }, "properties" : { "id" : { "type" : "string", "description" : "Tax Rate ID", "example" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d" }, "versionId" : { "type" : "string", "description" : "Tax Rate Version ID", "example" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f" }, "version" : { "type" : "integer", "description" : "Tax Rate version", "format" : "int64", "example" : 0 }, "isPublished" : { "type" : "boolean", "description" : "Tax Rate status", "example" : false }, "name" : { "type" : "string", "description" : "The full name of the tax rate, e.g. \"Sales tax\"", "example" : "UK Sales Tax" }, "invoiceName" : { "type" : "string", "description" : "The long name used on the invoice, e.g. \"Value Added Tax\"", "example" : "Value Added Tax" }, "invoiceShortName" : { "type" : "string", "description" : "The short name used on the invoice, e.g. \"VAT\"", "example" : "VAT" }, "description" : { "type" : "string", "description" : "The description of the tax rate", "nullable" : true, "example" : "Value Added Tax applied to sales in the UK" }, "amount" : { "type" : "string", "description" : "The tax rate. Must be between 0 and 100.", "example" : "0.2" }, "country" : { "description" : "The country that this tax rate applies to", "$ref" : "#/components/schemas/CountryCode" }, "region" : { "type" : "string", "description" : "The region that this tax rate applies to", "nullable" : true, "example" : "London" }, "taxCategoryId" : { "type" : "string", "description" : "The Tax Category ID that this Tax Rate is part of", "nullable" : true, "example" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" }, "isArchived" : { "type" : "boolean", "description" : "Whether this tax rate is archived", "example" : false }, "updatedAt" : { "type" : "string", "description" : "The last time this tax rate was updated", "nullable" : true, "example" : "2024-05-09T00:00:00Z" } } }, "ListResponse" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "TaxRates", "example" : [ { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "isArchived" : false, "updatedAt" : "2024-05-09T00:00:00Z" } ], "items" : { "$ref" : "#/components/schemas/TaxRateResponse" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "PaginationMeta" : { "type" : "object", "description" : "Results pagination", "example" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 }, "properties" : { "after" : { "type" : "string", "description" : "Cursor for the page after this (if it exists)", "nullable" : true, "example" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3" }, "before" : { "type" : "string", "description" : "Cursor for the page before this (if it exists)", "nullable" : true, "example" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz" }, "totalResultSize" : { "type" : "integer", "description" : "Total number of entries across all pages", "format" : "int64", "nullable" : true, "example" : 10 } } }, "ProductListTaxRegistrationPaginatedResponseModel" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "TaxRegistrations", "example" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "items" : { "$ref" : "#/components/schemas/ProductListTaxRegistrationResponseModel" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "ProductListTaxRegistrationResponseModel" : { "required" : [ "country", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "State" : { "type" : "string", "example" : "CA", "enum" : [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AB", "BC", "MB", "NB", "NL", "NS", "NT", "NU", "ON", "PE", "QC", "SK", "YT" ] }, "ProductGetTaxRegistrationResponseModel" : { "required" : [ "country", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "ProductDeleteTaxRegistrationResponseModel" : { "required" : [ "country", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "CreateTaxRateRequest" : { "required" : [ "amount", "country", "invoiceName", "invoiceShortName", "isPublished", "name" ], "type" : "object", "example" : { "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" }, "properties" : { "isPublished" : { "type" : "boolean", "description" : "Tax Rate status", "example" : false }, "name" : { "type" : "string", "description" : "The full name of the tax rate, e.g. \"Sales tax\"", "example" : "UK Sales Tax" }, "invoiceName" : { "type" : "string", "description" : "The long name used on the invoice, e.g. \"Value Added Tax\"", "example" : "Value Added Tax" }, "invoiceShortName" : { "type" : "string", "description" : "The short name used on the invoice, e.g. \"VAT\"", "example" : "VAT" }, "description" : { "type" : "string", "description" : "The description of the tax rate", "nullable" : true, "example" : "Value Added Tax applied to sales in the UK" }, "amount" : { "type" : "string", "description" : "The tax rate. Must be between 0 and 100.", "example" : "0.2" }, "country" : { "description" : "The country that this tax rate applies to", "$ref" : "#/components/schemas/CountryCode" }, "region" : { "type" : "string", "description" : "The region that this tax rate applies to", "nullable" : true, "example" : "London" }, "taxCategoryId" : { "type" : "string", "description" : "The Tax Category Version ID that this Tax Rate is part of", "nullable" : true, "example" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" } } }, "CreateTaxRegistrationRequestModel" : { "required" : [ "country", "taxIdentifier" ], "type" : "object", "example" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "ProductCreateTaxRegistrationResponseModel" : { "required" : [ "country", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "ProductArchiveTaxRateResponseModel" : { "required" : [ "amount", "country", "id", "invoiceName", "invoiceShortName", "isArchived", "isPublished", "name", "sequenceAccountId", "version", "versionId" ], "type" : "object", "example" : { "id" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d", "versionId" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f", "sequenceAccountId" : "dce9ae85-d8d0-42b4-bcad-f221a64363c6", "version" : 0, "isPublished" : false, "name" : "UK Sales Tax", "invoiceName" : "Value Added Tax", "invoiceShortName" : "VAT", "description" : "Value Added Tax applied to sales in the UK", "amount" : "0.2", "country" : "GB", "region" : "London", "taxCategoryId" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6", "subRates" : [ ], "isArchived" : true }, "properties" : { "id" : { "type" : "string", "description" : "Tax Rate ID", "example" : "d58bf2e3-7a5d-4900-8457-2521c6880f7d" }, "versionId" : { "type" : "string", "description" : "Tax Rate Version ID", "example" : "82ef6f1a-afc2-4a8d-b868-6d9c72bf395f" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence Account ID", "example" : "dce9ae85-d8d0-42b4-bcad-f221a64363c6" }, "version" : { "type" : "integer", "description" : "Tax Rate version", "format" : "int64", "example" : 0 }, "isPublished" : { "type" : "boolean", "description" : "Tax Rate status", "example" : false }, "name" : { "type" : "string", "description" : "The full name of the tax rate, e.g. \"Sales tax\"", "example" : "UK Sales Tax" }, "invoiceName" : { "type" : "string", "description" : "The long name used on the invoice, e.g. \"Value Added Tax\"", "example" : "Value Added Tax" }, "invoiceShortName" : { "type" : "string", "description" : "The short name used on the invoice, e.g. \"VAT\"", "example" : "VAT" }, "description" : { "type" : "string", "description" : "The description of the tax rate", "nullable" : true, "example" : "Value Added Tax applied to sales in the UK" }, "amount" : { "type" : "string", "description" : "The tax rate. Must be between 0 and 100. If this tax rate has any sub-rates, then all sub-rates must add up to this amount.", "example" : "0.2" }, "country" : { "description" : "The country that this tax rate applies to", "$ref" : "#/components/schemas/CountryCode" }, "region" : { "type" : "string", "description" : "The region that this tax rate applies to", "nullable" : true, "example" : "London" }, "taxCategoryId" : { "type" : "string", "description" : "The Tax Category Version ID that this Tax Rate is part of", "nullable" : true, "example" : "ce109c64-dcc0-487a-ac8c-e3237c60cdb6" }, "subRates" : { "type" : "array", "description" : "The sub rates of this tax rate", "nullable" : true, "example" : [ ], "items" : { } }, "isArchived" : { "type" : "boolean", "description" : "Archived", "example" : true } } }, "UpdateTaxRegistrationRequestModel" : { "required" : [ "country", "taxIdentifier" ], "type" : "object", "example" : { "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "ProductUpdateTaxRegistrationResponseModel" : { "required" : [ "country", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1", "taxIdentifier" : "GB123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "a2e7ec72-e3b1-4349-8d8b-c1ad3cea03a1" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "GB123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "nullable" : true, "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "MerchantTaxRegistrationsResponse" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } }, "properties" : { "items" : { "type" : "array", "description" : "List of tax registrations for merchant", "example" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "items" : { "$ref" : "#/components/schemas/MerchantTaxRegistration" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationResponse" } } }, "MerchantTaxRegistration" : { "required" : [ "country", "id", "merchantId", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "merchantId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "42020696-da25-44d0-ab79-9ecbf8fc5307" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "CA123456789" }, "merchantId" : { "type" : "string", "description" : "The merchant that this tax registration belongs to", "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } }, "PaginationResponse" : { "type" : "object", "description" : "Results pagination", "example" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 }, "properties" : { "after" : { "type" : "string", "description" : "Copy this value to the `after` parameter of your next request to retrieve the next page of results", "nullable" : true, "example" : "nextOffset" }, "before" : { "type" : "string", "description" : "Copy this value to the `before` parameter of your next request to retrieve the next page of results", "nullable" : true, "example" : "previousOffset" }, "totalResultSize" : { "type" : "integer", "description" : "Total number of entries across all pages", "format" : "int64", "nullable" : true, "example" : 100 } } }, "CustomerTaxRegistrationsResponse" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "pagination" : { "after" : "nextOffset", "before" : "previousOffset", "totalResultSize" : 100 } }, "properties" : { "items" : { "type" : "array", "description" : "List of tax registrations for customer", "example" : [ { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" } ], "items" : { "$ref" : "#/components/schemas/CustomerTaxRegistration" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationResponse" } } }, "CustomerTaxRegistration" : { "required" : [ "country", "customerId", "id", "sequenceAccountId", "taxIdentifier" ], "type" : "object", "example" : { "id" : "3271ca41-d538-404f-a15f-25856a37fb88", "sequenceAccountId" : "42020696-da25-44d0-ab79-9ecbf8fc5307", "taxIdentifier" : "CA123456789", "customerId" : "06457f78-85cd-4140-9972-67c6cd8f6071", "country" : "GB", "state" : "CA" }, "properties" : { "id" : { "type" : "string", "description" : "Tax registration ID", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "sequenceAccountId" : { "type" : "string", "description" : "Sequence account ID", "example" : "42020696-da25-44d0-ab79-9ecbf8fc5307" }, "taxIdentifier" : { "type" : "string", "description" : "The unique identifier for this tax registration", "example" : "CA123456789" }, "customerId" : { "type" : "string", "description" : "The customer that this tax registration belongs to", "example" : "06457f78-85cd-4140-9972-67c6cd8f6071" }, "country" : { "description" : "Country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes))", "$ref" : "#/components/schemas/CountryCode" }, "state" : { "description" : "The registration state", "nullable" : true, "$ref" : "#/components/schemas/State" } } } }, "requestBodies" : { }, "securitySchemes" : { } } }