Skip to main content
POST
/
api
/
v1
/
registrations
/
{registration_id}
/
archive
curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/7c9e6679-7425-40de-944b-e07fc1f90ae7/archive' \
  --header 'Authorization: Bearer <your_token>'

{
  "message": "Successfully archived registration."
}

Documentation Index

Fetch the complete documentation index at: https://docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Archive a registration to completely exclude it from tax calculations and hide it from default list views. Archived registrations are preserved for historical records but no longer participate in tax processing.

​
Path Parameters

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

​
What Happens When You Archive

  • Tax calculations stop — The registration is no longer considered when calculating taxes for transactions
  • Hidden from views — Excluded from list results unless you set include_archived: true
  • Data preserved — All historical data remains intact for reference and auditing

​
Cascade Behavior

Registration TypeEffect
State registrationArchives the state and all local registrations (cities, counties, districts) under it
Local registrationArchives only the local registration (no cascade)
Archiving a state registration will automatically archive all local registrations under that state. This is a bulk operation that cannot be partially undone.

​
When to Archive

Use archive when you want to:
  • Completely disable a registration — Stop all tax calculations without deleting historical data
  • Remove duplicates — Archive an erroneously created duplicate
  • Clean up test data — Hide test registrations while preserving them for reference

​
Archive vs. Close vs. Delete

ActionUse CaseTax CalculationsReversible
ArchiveCompletely disableStopped entirelyYes (contact support)
CloseStop selling on a specific dateActive within date range (start → end date)No
DeleteRemove entirelyN/A - data removedNo
If you need to stop collecting tax starting from a specific date but preserve calculations for the historical period, use Close instead. Close keeps the registration active for transactions within the effective date range.

​
Viewing Archived Registrations

To include archived registrations in list results, set include_archived: true: 
POST /registrations/list
{
  "corporation_id": "your-corp-id",
  "include_archived": true
}
Archived registrations will have a non-null archived_at timestamp. 
curl --request POST \
  --url 'https://transaction-tax.api.in.commenda.io/api/v1/registrations/7c9e6679-7425-40de-944b-e07fc1f90ae7/archive' \
  --header 'Authorization: Bearer <your_token>'

{
  "message": "Successfully archived registration."
}