Skip to main content
POST
/
api
/
v1
/
registrations
/
{registration_id}
curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "tax_registration_id": "123-456789-00",
    "portal_id": "PORTAL_CA_CDTFA",
    "credential_id": "cred_abc123def456"
  }'
{
  "message": "Successfully updated registration."
}
Update a registration to add or modify tax types, frequency, credentials, and other configuration. Use this endpoint to complete a registration before requesting validation.
To find valid portal IDs for your registration, use the Portal Fields endpoint.
Cascade behavior: When updating tax_types or frequency on a state registration, the changes automatically cascade to all local registrations (cities, counties, districts) under that state.

Path Parameters

registration_id
string
required
The unique identifier (UUID) of the registration to update.

Request Body

All fields are optional. Only the fields you provide will be updated; other fields remain unchanged.
tax_types
array
Array of tax types to register for. Must be valid for the registration’s jurisdiction.Values: RST, RUT, DTT, SST, etc.
For local jurisdictions (cities, counties), tax types must match the parent state registration.
frequency
string
Filing frequency for this registration.Values: MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUAL_CALENDAR_YEAR, FISCAL_YEAR, QUARTERLY_PREPAY_MONTHLY, MONTHLY_ACCELERATED_PREPAY_EARLY
effective_start_date
string
ISO date (YYYY-MM-DD) when the registration became or becomes effective.
tax_registration_id
string
Your state-issued tax registration ID, permit number, or account number.
credential_id
string
Reference to stored portal credentials for automated filing.
portal_id
string
The portal ID for the state’s tax filing portal. Must be a valid portal for the registration’s content.

Common Workflows

Adding Credentials Before Validation

After creating a registration, add the credentials needed for automated filing:
{
  "tax_registration_id": "123-456789-00",
  "portal_id": "PORTAL_CA_CDTFA",
  "credential_id": "cred_abc123def456"
}

Changing Filing Frequency

Update the frequency before the next filing period:
{
  "frequency": "MONTHLY"
}

Updating Tax Types

Switch between valid tax type combinations:
{
  "tax_types": ["RUT", "DTT"]
}

Validation Rules

  • Tax types: Must be valid for the jurisdiction. You can switch between valid combinations (e.g., RST+DTT to RUT+DTT).
  • Frequency: Must be one of the frequencies allowed for the jurisdiction.
  • Portal ID: Must be a valid portal for the registration’s content.
  • Date format: effective_start_date must be in YYYY-MM-DD format.

State vs. Local Update Behavior

Registration Typetax_types / frequency UpdateEffect
StateAllowedCascades to all local registrations under this state
LocalAllowed only if matches parent stateUpdates only the local registration
If you need to change tax types or frequency for local registrations, update the parent state registration instead—the change will automatically cascade to all locals.
curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
  --header 'Authorization: Bearer <your_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "tax_registration_id": "123-456789-00",
    "portal_id": "PORTAL_CA_CDTFA",
    "credential_id": "cred_abc123def456"
  }'
{
  "message": "Successfully updated registration."
}