Registrations

Overview

Available Operations

get_all - Get Registrations
create - Create Registration
get - Get Registration By Id
update - Update Registration
deregister - Deregister Registration

get_all

The Get Registrations API retrieves a paginated list of registrations. This API helps in tracking and managing registrations efficiently across multiple jurisdictions.

Example Usage

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.get_all(status_in="REGISTERED,PROCESSING,UNREGISTERED,DEREGISTERING,DEREGISTERED,VALIDATING,AWAITING_CLARIFICATION", page=1, size=50)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`status_in`	Optional[str]	➖	Filter registrations by status. Multiple statuses can be passed, separated by commas.
`state_code`	Optional[str]	➖	Filter registrations by state code.
`filing_frequency_in`	Optional[str]	➖	Filter registrations by filing frequency. Multiple filing frequencies can be passed, separated by commas.
`country_code_in`	List[models.CountryCodeEnum]	➖	Filter registrations by country code in ISO 3166-1 alpha-2 format (e.g., US, CA).
`order_by`	Optional[str]	➖	Order results by specified fields (comma-separated)
`page`	Optional[int]	➖	Page number
`size`	Optional[int]	➖	Page size
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.PageRegistrationReadWithPassword

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	401, 404	application/json
errors.BackendSrcRegistrationsResponsesValidationErrorResponse	422	application/json
errors.ErrorResponse	500	application/json
errors.APIError	4XX, 5XX	/

create

The Create Registration API allows users to create a new registration for tracking and managing tax filings efficiently across multiple jurisdictions.

Example Usage: oss

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.create(request={
        "registration_import_type": "OSS",
        "password_plain_text": "oss_pass_fr",
        "password_metadata_plain_text": "{\"q\":\"a\"}",
        "member_state_of_identification_code": models.CountryCodeEnum.FR,
        "imported": True,
    })

    # Handle response
    print(res)

Example Usage: regular_legacy

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.create(request={
        "registration_import_type": "OSS",
        "imported": False,
    })

    # Handle response
    print(res)

Example Usage: regular_new

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.create(request={
        "registration_import_type": "REGULAR",
        "registration_date": "2025-02-01",
        "registration_email": "example@domain.com",
        "auto_registered": True,
        "do_not_file": False,
        "country_code": models.CountryCodeEnum.US,
        "state_code": "TX",
        "state_name": "Texas",
        "filing_frequency": models.FilingFrequencyEnum.MONTHLY,
        "comment": "Registering for monthly sales tax filings",
        "initial_sync": False,
        "amount_fees": 100,
        "vda": False,
        "sst_import": False,
    })

    # Handle response
    print(res)

Example Usage: sst

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.create(request={
        "registration_import_type": "SST",
        "password_plain_text": "sst_pass",
        "password_metadata_plain_text": "{\"q\":\"a\"}",
        "username": "sst_user",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`request`	models.CreateRegistration	✔️	The request object to use for the request.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RegistrationRead

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	401, 409	application/json
errors.BackendSrcRegistrationsResponsesValidationErrorResponse	422	application/json
errors.ErrorResponse	500	application/json
errors.APIError	4XX, 5XX	/

get

The Get Registration By ID API retrieves a single registration record based on its unique identifier.

Example Usage

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.get(registration_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`registration_id`	str	✔️	The unique identifier of the registration to retrieve.
`reveal`	Optional[str]	➖	Name of field to reveal
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RegistrationRead

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	401	application/json
errors.BackendSrcRegistrationsResponsesValidationErrorResponse	422	application/json
errors.ErrorResponse	500	application/json
errors.APIError	4XX, 5XX	/

update

The Update Registration API allows you to modify an existing registration using its unique registration_id.

Example Usage

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.update(registration_id="<id>", registration_date="2025-03-01", registration_email="example@domain.com", registration_key="REG-123456", registration_requested="2025-02-18T19:43:32.684802", auto_registered=True, registrations_regime=models.RegistrationsRegimeEnum.STANDARD, change_regime_status=models.ChangeRegimeStatusEnum.REQUESTED, third_party_enabled=False, do_not_file=False, username="User Name", filing_frequency=models.FilingFrequencyEnum.MONTHLY, create_filings_from="2025-03-01", is_approaching=False, comment="Updated registration for compliance", vda=False)

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`registration_id`	str	✔️	The unique identifier of the registration to be updated.
`registration_date`	Optional[str]	➖	The date when the registration was created. Format: YYYY-MM-DD.
`registration_email`	Optional[str]	➖	Email address associated with the registration.
`registration_key`	Optional[str]	➖	A unique key assigned to the registration.
`deregistration_key`	Optional[str]	➖	A unique key assigned for deregistration.
`registration_requested`	Optional[str]	➖	Timestamp when the registration was requested.
`registration_completed`	Optional[str]	➖	Timestamp when the registration was completed.
`deregistration_requested`	Optional[str]	➖	Timestamp when deregistration was requested.
`deregistration_completed`	Optional[str]	➖	Timestamp when the deregistration was completed.
`auto_registered`	Optional[bool]	➖	Indicates whether the registration was completed automatically.
`registrations_regime`	Optional[models.RegistrationsRegimeEnum]	➖	N/A
`change_regime_status`	Optional[models.ChangeRegimeStatusEnum]	➖	N/A
`third_party_enabled`	Optional[bool]	➖	Indicates whether third-party access is enabled for this registration.
`do_not_file`	Optional[bool]	➖	If true, do not file for this registration (treated as False by default).
`two_factor_enabled`	Optional[bool]	➖	Indicates whether two-factor authentication (2FA) is enabled for this registration.
`marked_collecting`	Optional[bool]	➖	Indicates whether the registration is marked as collecting in shopify
`encrypted_username`	Optional[str]	➖	The encrypted username for the registration.
`username`	Optional[str]	➖	The username associated with the registration.
`filing_frequency`	Optional[models.FilingFrequencyEnum]	➖	N/A
`create_filings_from`	Optional[str]	➖	The updated date from which filings should start (YYYY-MM-DD).
`is_approaching`	Optional[bool]	➖	Indicates whether the registration is approaching an action (e.g., renewal).
`comment`	Optional[str]	➖	Additional notes or comments related to the registration.
`vda`	Optional[bool]	➖	Indicates if the Voluntary Disclosure Agreement (VDA) applies.
`tax_id`	Optional[str]	➖	Organization-level tax ID (e.g., VAT number, Canada Business Number).
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RegistrationRead

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	401	application/json
errors.BackendSrcRegistrationsResponsesValidationErrorResponse	422	application/json
errors.ErrorResponse	500	application/json
errors.APIError	4XX, 5XX	/

deregister

Deregister an existing registration.

Example Usage

from kintsugi_tax_platform_sdk import SDK, models


with SDK(
    security=models.Security(
        api_key_header="<YOUR_API_KEY_HERE>",
        custom_header="<YOUR_API_KEY_HERE>",
    ),
) as sdk:

    res = sdk.registrations.deregister(registration_id="regs_123456")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
`registration_id`	str	✔️	The unique identifier of the registration to deregister.	regs_123456
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.RegistrationRead

Errors

Error Type	Status Code	Content Type
errors.ErrorResponse	401	application/json
errors.BackendSrcRegistrationsResponsesValidationErrorResponse	422	application/json
errors.ErrorResponse	500	application/json
errors.APIError	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Registrations

Overview

Available Operations

get_all

Example Usage

Parameters

Response

Errors

create

Example Usage: oss

Example Usage: regular_legacy

Example Usage: regular_new

Example Usage: sst

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

deregister

Example Usage

Parameters

Response

Errors

Uh oh!

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Registrations

Overview

Available Operations

get_all

Example Usage

Parameters

Response

Errors

create

Example Usage: oss

Example Usage: regular_legacy

Example Usage: regular_new

Example Usage: sst

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

deregister

Example Usage

Parameters

Response

Errors