Download the PHP package kintsugi-tax/tax-platform-sdk without Composer
On this page you can find all versions of the php package kintsugi-tax/tax-platform-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package tax-platform-sdk
kintsugi-tax/tax-platform-sdk
Developer-friendly & type-safe Php SDK specifically catered to leverage kintsugi-tax/tax-platform-sdk API.
Summary
Kintsugi Customer API: Publicly documented Kintsugi Customer API endpoints. The source (openapi/_source/openapi-master.json) is the platform spec filtered to the documented customer surface (openapi/customer-endpoints.json); scripts/build-specs.mjs re-applies that filter here. Do not edit by hand.
Table of Contents
- kintsugi-tax/tax-platform-sdk
- SDK Installation
- SDK Example Usage
- Authentication
- Available Resources and Operations
- Error Handling
- Server Selection
- Development
- Maturity
- Contributions
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:
SDK Example Usage
Example
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
apiKeyHeader |
apiKey | API key |
To authenticate with the API the apiKeyHeader parameter must be set when initializing the SDK. For example:
Available Resources and Operations
Available methods
### [AddressValidation](docs/sdks/addressvalidation/README.md) * [search](docs/sdks/addressvalidation/README.md#search) - Search * [suggestions](docs/sdks/addressvalidation/README.md#suggestions) - Suggestions ### [CustomerTaxRegistration](docs/sdks/customertaxregistration/README.md) * [upsertCustomerTaxRegistrationV1CustomersCustomerIdTaxRegistrationsPost](docs/sdks/customertaxregistration/README.md#upsertcustomertaxregistrationv1customerscustomeridtaxregistrationspost) - Upsert customer tax registration ### [Customers](docs/sdks/customers/README.md) * [list](docs/sdks/customers/README.md#list) - Get customers * [create](docs/sdks/customers/README.md#create) - Create customer * [getByExternalId](docs/sdks/customers/README.md#getbyexternalid) - Get customer by external id * [getById](docs/sdks/customers/README.md#getbyid) - Get customer by id * [update](docs/sdks/customers/README.md#update) - Update customer * [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) * [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) * [get](docs/sdks/attachments/README.md#get) - Get attachments for exemption ### [Filings](docs/sdks/filings/README.md) * [get](docs/sdks/filings/README.md#get) - Get filings * [getByRegistrationId](docs/sdks/filings/README.md#getbyregistrationid) - Get filings by registration id * [getById](docs/sdks/filings/README.md#getbyid) - Get filing by id * [approveFilingV1FilingsFilingIdApprovePut](docs/sdks/filings/README.md#approvefilingv1filingsfilingidapproveput) - Approve filing ### [Nexus](docs/sdks/nexus/README.md) * [list](docs/sdks/nexus/README.md#list) - Get nexus for org * [listPhysical](docs/sdks/nexus/README.md#listphysical) - Get physical nexus * [createPhysical](docs/sdks/nexus/README.md#createphysical) - Create physical nexus * [getPhysicalNexusCategoriesV1NexusPhysicalNexusCategoriesGet](docs/sdks/nexus/README.md#getphysicalnexuscategoriesv1nexusphysicalnexuscategoriesget) - Get physical nexus categories * [delete](docs/sdks/nexus/README.md#delete) - Delete physical nexus * [updatePhysical](docs/sdks/nexus/README.md#updatephysical) - Update physical nexus * [getNexusDetailsForIdV1NexusNexusIdGet](docs/sdks/nexus/README.md#getnexusdetailsforidv1nexusnexusidget) - Get nexus details for id ### [Products](docs/sdks/products/README.md) * [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) * [list](docs/sdks/registrations/README.md#list) - Get registrations * [create](docs/sdks/registrations/README.md#create) - Create registration * [getJurisdictionSpecificFieldsV1RegistrationsJurisdictionSpecificFieldsGet](docs/sdks/registrations/README.md#getjurisdictionspecificfieldsv1registrationsjurisdictionspecificfieldsget) - Get jurisdiction specific fields * [listRegistrationJurisdictionsV1RegistrationsJurisdictionsGet](docs/sdks/registrations/README.md#listregistrationjurisdictionsv1registrationsjurisdictionsget) - List registration jurisdictions * [getById](docs/sdks/registrations/README.md#getbyid) - Get registration by id * [update](docs/sdks/registrations/README.md#update) - Update registration * [uploadRegistrationAttachmentV1RegistrationsRegistrationIdAttachmentsPost](docs/sdks/registrations/README.md#uploadregistrationattachmentv1registrationsregistrationidattachmentspost) - Upload registration attachment * [deregister](docs/sdks/registrations/README.md#deregister) - Deregister registration * [getOssCountriesForRegistrationV1RegistrationsRegistrationIdOssCountriesGet](docs/sdks/registrations/README.md#getosscountriesforregistrationv1registrationsregistrationidosscountriesget) - Get oss countries for registration ### [TaxEstimation](docs/sdks/taxestimation/README.md) * [estimate](docs/sdks/taxestimation/README.md#estimate) - Estimate tax ### [Transactions](docs/sdks/transactions/README.md) * [list](docs/sdks/transactions/README.md#list) - Get transactions * [create](docs/sdks/transactions/README.md#create) - Create transaction * [archiveTransactionByIdV1TransactionsArchivePost](docs/sdks/transactions/README.md#archivetransactionbyidv1transactionsarchivepost) - Archive transaction by id * [getByExternalId](docs/sdks/transactions/README.md#getbyexternalid) - Get transaction by external 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 * [get](docs/sdks/transactions/README.md#get) - Get transaction by id * [update](docs/sdks/transactions/README.md#update) - Update transaction * [setTransactionTaxOnlyV1TransactionsTransactionIdTaxOnlyPost](docs/sdks/transactions/README.md#settransactiontaxonlyv1transactionstransactionidtaxonlypost) - Set transaction tax onlyError 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
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:
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.
SDK Created by Speakeasy
All versions of tax-platform-sdk with dependencies
galbar/jsonpath Version >=3.0
guzzlehttp/guzzle Version ^7.15.2
speakeasy/serializer Version ^4.0.3
brick/date-time Version >=0.7.0
phpdocumentor/type-resolver Version >=1.8
brick/math Version >=0.12.1