PHPackages kintsugi-tax/tax-platform-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. kintsugi-tax/tax-platform-sdk ActiveLibrary kintsugi-tax/tax-platform-sdk ============================= v0.6.1(2mo ago)0214[1 PRs](https://github.com/kintsugi-tax/kintsugi-tax-php-sdk/pulls)MITPHPPHP >=8.2CI passing Since Jul 11Pushed 1mo agoCompare [ Source](https://github.com/kintsugi-tax/kintsugi-tax-php-sdk)[ Packagist](https://packagist.org/packages/kintsugi-tax/tax-platform-sdk)[ RSS](/packages/kintsugi-tax-tax-platform-sdk/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (10)Versions (46)Used By (0) kintsugi-tax/tax-platform-sdk ============================= [](#kintsugi-taxtax-platform-sdk) Developer-friendly & type-safe Php SDK specifically catered to leverage *kintsugi-tax/tax-platform-sdk* API. [![](https://camo.githubusercontent.com/096b86187dea2c62026c9750456a53a3e7c20fdd95fa1b55f5cc9a67ebc2078d/68747470733a2f2f637573746f6d2d69636f6e2d6261646765732e64656d6f6c61622e636f6d2f62616467652f2d4275696c742532304279253230537065616b656173792d3231323031353f7374796c653d666f722d7468652d6261646765266c6f676f436f6c6f723d464245333331266c6f676f3d737065616b65617379266c6162656c436f6c6f723d353435343534)](https://www.speakeasy.com/?utm_source=kintsugi-tax/tax-platform-sdk&utm_campaign=php) [ ![](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667) ](https://opensource.org/licenses/MIT) Summary ------- [](#summary) Table of Contents ----------------- [](#table-of-contents) - [kintsugi-tax/tax-platform-sdk](#kintsugi-taxtax-platform-sdk) - [SDK Installation](#sdk-installation) - [SDK Example Usage](#sdk-example-usage) - [Authentication](#authentication) - [Available Resources and Operations](#available-resources-and-operations) - [Error Handling](#error-handling) - [Server Selection](#server-selection) - [Development](#development) - [Maturity](#maturity) - [Contributions](#contributions) SDK Installation ---------------- [](#sdk-installation) The SDK relies on [Composer](https://getcomposer.org/) to manage its dependencies. To install the SDK and add it as a dependency to an existing `composer.json` file: ``` composer require "kintsugi-tax/tax-platform-sdk" ``` SDK Example Usage ----------------- [](#sdk-example-usage) ### Example [](#example) ``` declare(strict_types=1); require 'vendor/autoload.php'; use KintsugiTax\SDK; use KintsugiTax\SDK\Models\Components; use KintsugiTax\SDK\Models\Operations; $sdk = SDK\SDK::builder()->build(); $request = new Components\AddressBase( phone: '555-123-4567', street1: '1600 Amphitheatre Parkway', street2: 'Building 40', city: 'Mountain View', county: 'Santa Clara', state: 'CA', postalCode: '94043', country: Components\CountryCodeEnum::Us, fullAddress: '1600 Amphitheatre Parkway, Mountain View, CA 94043', ); $requestSecurity = new Operations\SearchV1AddressValidationSearchPostSecurity( apiKeyHeader: '', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response } ``` Authentication -------------- [](#authentication) ### Per-Client Security Schemes [](#per-client-security-schemes) This SDK supports the following security schemes globally: NameTypeScheme`apiKeyHeader`apiKeyAPI key`customHeader`apiKeyAPI keyYou can set the security parameters through the `setSecurity` function on the `SDKBuilder` when initializing the SDK. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example: ``` declare(strict_types=1); require 'vendor/autoload.php'; use KintsugiTax\SDK; use KintsugiTax\SDK\Models\Components; $sdk = SDK\SDK::builder() ->setSecurity( new Components\Security( apiKeyHeader: '', customHeader: '', ) ) ->build(); $request = new Components\ValidationAddress( line1: '1600 Amphitheatre Parkway', line2: '', line3: '', city: 'Mountain View', state: 'CA', postalCode: '94043', id: 215, county: '', fullAddress: '1600 Amphitheatre Parkway, Mountain View, CA 94043', ); $response = $sdk->addressValidation->suggestions( request: $request ); if ($response->any !== null) { // handle response } ``` ### Per-Operation Security Schemes [](#per-operation-security-schemes) Some operations in this SDK require the security scheme to be specified at the request level. For example: ``` declare(strict_types=1); require 'vendor/autoload.php'; use KintsugiTax\SDK; use KintsugiTax\SDK\Models\Components; use KintsugiTax\SDK\Models\Operations; $sdk = SDK\SDK::builder()->build(); $request = new Components\AddressBase( phone: '555-123-4567', street1: '1600 Amphitheatre Parkway', street2: 'Building 40', city: 'Mountain View', county: 'Santa Clara', state: 'CA', postalCode: '94043', country: Components\CountryCodeEnum::Us, fullAddress: '1600 Amphitheatre Parkway, Mountain View, CA 94043', ); $requestSecurity = new Operations\SearchV1AddressValidationSearchPostSecurity( apiKeyHeader: '', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response } ``` Available Resources and Operations ---------------------------------- [](#available-resources-and-operations) Available methods### [AddressValidation](docs/sdks/addressvalidation/README.md) [](#addressvalidation) - [search](docs/sdks/addressvalidation/README.md#search) - Search - [suggestions](docs/sdks/addressvalidation/README.md#suggestions) - Suggestions ### [Customers](docs/sdks/customers/README.md) [](#customers) - [list](docs/sdks/customers/README.md#list) - Get Customers - [create](docs/sdks/customers/README.md#create) - Create Customer - [getById](docs/sdks/customers/README.md#getbyid) - Get Customer By Id - [update](docs/sdks/customers/README.md#update) - Update Customer - [getByExternalId](docs/sdks/customers/README.md#getbyexternalid) - Get Customer By External Id - [getTransactions](docs/sdks/customers/README.md#gettransactions) - Get Transactions By Customer Id - [createTransaction](docs/sdks/customers/README.md#createtransaction) - Create Transaction By Customer Id ### [Exemptions](docs/sdks/exemptions/README.md) [](#exemptions) - [list](docs/sdks/exemptions/README.md#list) - Get Exemptions - [create](docs/sdks/exemptions/README.md#create) - Create Exemption - [getById](docs/sdks/exemptions/README.md#getbyid) - Get Exemption By Id - [uploadCertificate](docs/sdks/exemptions/README.md#uploadcertificate) - Upload Exemption Certificate ### [Exemptions.Attachments](docs/sdks/attachments/README.md) [](#exemptionsattachments) - [get](docs/sdks/attachments/README.md#get) - Get Attachments For Exemption ### [Filings](docs/sdks/filings/README.md) [](#filings) - [get](docs/sdks/filings/README.md#get) - Get Filings - [getById](docs/sdks/filings/README.md#getbyid) - Get Filing By Id - [getByRegistrationId](docs/sdks/filings/README.md#getbyregistrationid) - Get Filings By Registration Id ### [Nexus](docs/sdks/nexus/README.md) [](#nexus) - [listPhysical](docs/sdks/nexus/README.md#listphysical) - Get Physical Nexus - [createPhysical](docs/sdks/nexus/README.md#createphysical) - Create Physical Nexus - [updatePhysical](docs/sdks/nexus/README.md#updatephysical) - Update Physical Nexus - [delete](docs/sdks/nexus/README.md#delete) - Delete Physical Nexus - [list](docs/sdks/nexus/README.md#list) - Get Nexus For Org ### [Products](docs/sdks/products/README.md) [](#products) - [getProductsV1ProductsGet](docs/sdks/products/README.md#getproductsv1productsget) - Get Products - [createProductV1ProductsPost](docs/sdks/products/README.md#createproductv1productspost) - Create Product - [getProductCategoriesV1ProductsCategoriesGet](docs/sdks/products/README.md#getproductcategoriesv1productscategoriesget) - Get Product Categories - [get](docs/sdks/products/README.md#get) - Get Product By Id - [update](docs/sdks/products/README.md#update) - Update Product ### [Registrations](docs/sdks/registrations/README.md) [](#registrations) - [list](docs/sdks/registrations/README.md#list) - Get Registrations - [create](docs/sdks/registrations/README.md#create) - Create Registration - [getById](docs/sdks/registrations/README.md#getbyid) - Get Registration By Id - [update](docs/sdks/registrations/README.md#update) - Update Registration - [deregister](docs/sdks/registrations/README.md#deregister) - Deregister Registration ### [TaxEstimation](docs/sdks/taxestimation/README.md) [](#taxestimation) - [estimate](docs/sdks/taxestimation/README.md#estimate) - Estimate Tax ### [Transactions](docs/sdks/transactions/README.md) [](#transactions) - [list](docs/sdks/transactions/README.md#list) - Get Transactions - [create](docs/sdks/transactions/README.md#create) - Create Transaction - [getByExternalId](docs/sdks/transactions/README.md#getbyexternalid) - Get Transaction By External Id - [update](docs/sdks/transactions/README.md#update) - Update Transaction - [get](docs/sdks/transactions/README.md#get) - Get Transaction By Id - [getByFilingId](docs/sdks/transactions/README.md#getbyfilingid) - Get Transactions By Filing Id - [createCreditNote](docs/sdks/transactions/README.md#createcreditnote) - Create Credit Note By Transaction Id - [updateCreditNote](docs/sdks/transactions/README.md#updatecreditnote) - Update Credit Note By Transaction Id Error Handling -------------- [](#error-handling) Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception. By default an API error will raise a `Errors\APIException` exception, which has the following properties: PropertyTypeDescription`$message`*string*The error message`$statusCode`*int*The HTTP status code`$rawResponse`*?\\Psr\\Http\\Message\\ResponseInterface*The raw HTTP response`$body`*string*The response contentWhen custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `search` method throws the following exceptions: Error TypeStatus CodeContent TypeErrors\\ErrorResponse401application/jsonErrors\\BackendSrcAddressValidationResponsesValidationErrorResponse422application/jsonErrors\\ErrorResponse500application/jsonErrors\\APIException4XX, 5XX\*/\*### Example [](#example-1) ``` declare(strict_types=1); require 'vendor/autoload.php'; use KintsugiTax\SDK; use KintsugiTax\SDK\Models\Components; use KintsugiTax\SDK\Models\Errors; use KintsugiTax\SDK\Models\Operations; $sdk = SDK\SDK::builder()->build(); try { $request = new Components\AddressBase( phone: '555-123-4567', street1: '1600 Amphitheatre Parkway', street2: 'Building 40', city: 'Mountain View', county: 'Santa Clara', state: 'CA', postalCode: '94043', country: Components\CountryCodeEnum::Us, fullAddress: '1600 Amphitheatre Parkway, Mountain View, CA 94043', ); $requestSecurity = new Operations\SearchV1AddressValidationSearchPostSecurity( apiKeyHeader: '', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response } } catch (Errors\ErrorResponseThrowable $e) { // handle $e->$container data throw $e; } catch (Errors\BackendSrcAddressValidationResponsesValidationErrorResponseThrowable $e) { // handle $e->$container data throw $e; } catch (Errors\ErrorResponseThrowable $e) { // handle $e->$container data throw $e; } catch (Errors\APIException $e) { // handle default exception throw $e; } ``` Server Selection ---------------- [](#server-selection) ### Override Server URL Per-Client [](#override-server-url-per-client) The default server can be overridden globally using the `setServerUrl(string $serverUrl)` builder method when initializing the SDK client instance. For example: ``` declare(strict_types=1); require 'vendor/autoload.php'; use KintsugiTax\SDK; use KintsugiTax\SDK\Models\Components; use KintsugiTax\SDK\Models\Operations; $sdk = SDK\SDK::builder() ->setServerURL('https://api.trykintsugi.com') ->build(); $request = new Components\AddressBase( phone: '555-123-4567', street1: '1600 Amphitheatre Parkway', street2: 'Building 40', city: 'Mountain View', county: 'Santa Clara', state: 'CA', postalCode: '94043', country: Components\CountryCodeEnum::Us, fullAddress: '1600 Amphitheatre Parkway, Mountain View, CA 94043', ); $requestSecurity = new Operations\SearchV1AddressValidationSearchPostSecurity( apiKeyHeader: '', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response } ``` Development =========== [](#development) Maturity -------- [](#maturity) This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. Contributions ------------- [](#contributions) While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=kintsugi-tax/tax-platform-sdk&utm_campaign=php) [](#sdk-created-by-speakeasy) ### Health Score 44 — FairBetter than 92% of packages Maintenance90 Actively maintained with recent releases Popularity16 Limited adoption so far Community8 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 64.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~12 days Recently: every ~42 days Total 20 Last Release 69d ago PHP version history (2 changes)v0.1.1PHP ^8.2 v0.1.9PHP >=8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/640710159a9f8941f65eba43238113b120c2e314246bbeb88b5d4247601d74e7?d=identicon)[kintsugi-tax](/maintainers/kintsugi-tax) --- Top Contributors [![ryanpl-kintsugi](https://avatars.githubusercontent.com/u/216966322?v=4)](https://github.com/ryanpl-kintsugi "ryanpl-kintsugi (31 commits)")[![speakeasybot](https://avatars.githubusercontent.com/u/108416695?v=4)](https://github.com/speakeasybot "speakeasybot (17 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/kintsugi-tax-tax-platform-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/kintsugi-tax-tax-platform-sdk/health.svg)](https://phpackages.com/packages/kintsugi-tax-tax-platform-sdk) ``` ### Alternatives [clerkinc/backend-php 2755.0k](/packages/clerkinc-backend-php)[polar-sh/sdk 4014.5k4](/packages/polar-sh-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)