kintsugi-tax / tax-platform-sdk
Requires
- php: >=8.2
- brick/date-time: >=0.7.0
- brick/math: >=0.12.1
- galbar/jsonpath: >=3.0
- guzzlehttp/guzzle: ^7.0
- phpdocumentor/type-resolver: >=1.8
- speakeasy/serializer: ^4.0.3
Requires (Dev)
- laravel/pint: >=1.21.2
- phpstan/phpstan: >=2.1.0
- phpunit/phpunit: >=10
- roave/security-advisories: dev-latest
- dev-main
- v0.4.7
- v0.4.6
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.3.0
- v0.2.0
- v0.1.10
- v0.1.9
- v0.1.8
- v0.1.7
- v0.1.6
- v0.1.5
- v0.1.4
- v0.1.1
- dev-speakeasy-sdk-regen-1758067610
- dev-speakeasy-sdk-regen-1756512405
- dev-speakeasy-sdk-regen-1756253234
- dev-speakeasy-sdk-regen-1756166827
- dev-speakeasy-sdk-regen-1754611668
- dev-speakeasy-sdk-regen-1754093269
- dev-speakeasy-sdk-regen-1753997350
- dev-speakeasy-sdk-regen-1753995450
- dev-speakeasy-sdk-regen-1753995026
- dev-speakeasy-sdk-regen-1753920460
- dev-speakeasy-sdk-regen-1753747700
- dev-speakeasy-sdk-regen-1753315672
- dev-speakeasy-sdk-regen-1753201937
- dev-speakeasy-sdk-regen-1752883664
- dev-speakeasy-sdk-regen-1752859328
- dev-speakeasy-sdk-regen-1752538074
- dev-speakeasy-sdk-regen-1752274373
- dev-speakeasy-sdk-regen-1752272918
- dev-speakeasy-sdk-regen-1752272156
This package is auto-updated.
Last update: 2025-09-24 16:27:05 UTC
README
Developer-friendly & type-safe Php SDK specifically catered to leverage kintsugi-tax/tax-platform-sdk API.
Important
This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
Summary
Table of Contents
SDK Installation
The SDK relies on Composer 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
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: '<YOUR_API_KEY_HERE>', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response }
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
Name | Type | Scheme |
---|---|---|
apiKeyHeader |
apiKey | API key |
customHeader |
apiKey | API key |
You 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: '<YOUR_API_KEY_HERE>', customHeader: '<YOUR_API_KEY_HERE>', ) ) ->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
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: '<YOUR_API_KEY_HERE>', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response }
Available Resources and Operations
Available methods
addressValidation
- search - Search
- suggestions - Suggestions
customers
- list - Get Customers
- create - Create Customer
- getById - Get Customer By Id
- update - Update Customer
- getByExternalId - Get Customer By External Id
- getTransactions - Get Transactions By Customer Id
- createTransaction - Create Transaction By Customer Id
exemptions
- list - Get Exemptions
- create - Create Exemption
- getById - Get Exemption By Id
- uploadCertificate - Upload Exemption Certificate
exemptions->attachments
- get - Get Attachments For Exemption
filings
- get - Get Filings
- getById - Get Filing By Id
- getByRegistrationId - Get Filings By Registration Id
nexus
- listPhysical - Get Physical Nexus
- createPhysical - Create Physical Nexus
- updatePhysical - Update Physical Nexus
- delete - Delete Physical Nexus
- list - Get Nexus For Org
products
- listItems - Get Products
- create - Create Product
- get - Get Product By Id
- update - Update Product
- getCategories - Get Product Categories
registrations
- list - Get Registrations
- create - Create Registration
- getById - Get Registration By Id
- update - Update Registration
- deregister - Deregister Registration
taxEstimation
- estimate - Estimate Tax
transactions
- list - Get Transactions
- create - Create Transaction
- getByExternalId - Get Transaction By External Id
- update - Update Transaction
- get - Get Transaction By Id
- getByFilingId - Get Transactions By Filing Id
- createCreditNote - Create Credit Note By Transaction Id
- updateCreditNote - Update Credit Note By Transaction Id
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:
Property | Type | Description |
---|---|---|
$message |
string | The error message |
$statusCode |
int | The HTTP status code |
$rawResponse |
?\Psr\Http\Message\ResponseInterface | The raw HTTP response |
$body |
string | The response content |
When 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 Type | Status Code | Content Type |
---|---|---|
Errors\ErrorResponse | 401 | application/json |
Errors\BackendSrcAddressValidationResponsesValidationErrorResponse | 422 | application/json |
Errors\ErrorResponse | 500 | application/json |
Errors\APIException | 4XX, 5XX | */* |
Example
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: '<YOUR_API_KEY_HERE>', ); $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
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: '<YOUR_API_KEY_HERE>', ); $response = $sdk->addressValidation->search( request: $request, security: $requestSecurity ); if ($response->response200SearchV1AddressValidationSearchPost !== null) { // handle response }
Development
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
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.