Prophit.ai API reference

Every ITMS API /api/v1 endpoint: method, path, auth scope, persistence behavior, request, and response.

92 documented operations. Each links to a dedicated page with auth scope, request and response contracts, persistence behavior, and a runnable request skeleton.

MethodPathPurpose
GET/api/v1/configDiscover effective API limits, environments, default scopes, active tax codes, and webhook event names.
POST/api/v1/addresses/resolveValidate, normalize, and geolocate a US address before calculation.
GET/api/v1/coverage/statesDiscover the calculation mode currently serving every state and DC.
GET/api/v1/provider/clientsList taxpayer engagements owned by the authenticated service provider.
POST/api/v1/provider/clientsIdempotently onboard a taxpayer using the canonical Organization and Location tenancy model.
GET/api/v1/provider/clients/{client_id}Read one provider-authorized taxpayer and its canonical locations.
PATCH/api/v1/provider/clients/{client_id}Update taxpayer identity or pause/offboard the provider engagement.
GET/api/v1/provider/clients/{client_id}/locationsList canonical locations for one authorized taxpayer.
POST/api/v1/provider/clients/{client_id}/locationsCreate an ordinary application location for an active taxpayer engagement.
PATCH/api/v1/provider/clients/{client_id}/locations/{location_id}Update or deactivate a location owned by the selected taxpayer.
GET/api/v1/provider/clients/{client_id}/readinessExplain whether client setup supports calculations and return preparation.
POST/api/v1/provider/return-jobsQueue return-preparation worksheets across up to 5,000 independent taxpayer/state periods.
GET/api/v1/provider/return-jobs/{job_id}Poll portfolio return output and per-item results.
PUT/api/v1/provider/clients/{client_id}/filing-obligations/{state}Record an already-issued customer registration and activate filing for one client state.
GET/api/v1/provider/clients/{client_id}/workflow/assignmentsList the provider's per-client (and per-client-per-state) reviewer/approver role defaults for one client.
PUT/api/v1/provider/clients/{client_id}/workflow/assignmentsUpsert a provider client-wide or client-and-state reviewer/approver default.
GET/api/v1/provider/data-deadlinesList the provider default and any per-client internal data-deadline policies.
PUT/api/v1/provider/data-deadlinesSet the provider default or a per-client override for internal data-deadline reminders.
POST/api/v1/provider/clients/{client_id}/data-receiptsRecord evidence that a client's period data was received, behind the provider timeliness disclaimer.
GET/api/v1/provider/returns/{package_id}/workflowRead a client return package's review/approval workflow state.
POST/api/v1/provider/returns/{package_id}/submit-for-reviewSubmit a client return package into the review workflow.
POST/api/v1/provider/returns/{package_id}/complete-reviewComplete reviewer tick-and-tie on a client return package (gated).
POST/api/v1/provider/returns/{package_id}/request-changesSend a client return package back to the preparer.
POST/api/v1/provider/returns/{package_id}/invalidate-approvalReopen an approved client return package for material correction.
POST/api/v1/provider/approval-packagesCreate a client-facing approval package linking one or more reviewed return packages.
GET/api/v1/provider/approval-packages/{approval_package_id}Read one client approval package and its current status.
POST/api/v1/provider/approval-packages/{approval_package_id}/revokeRevoke a client approval package before it is decided.
PUT/api/v1/items/{item_code}Create or replace a durable item-code mapping before product tax treatment.
GET/api/v1/items/{item_code}Fetch one product item mapping visible to the current API key.
GET/api/v1/itemsList product mappings visible to the current API key.
PUT/api/v1/customers/{customer_code}Create or replace the customer identity used by calculations and certificate selection.
GET/api/v1/customers/{customer_code}Fetch one customer identity mapping visible to the current API key.
GET/api/v1/customersList customer mappings visible to the current API key.
POST/api/v1/certificatesCreate a customer exemption certificate in the shared Sales Exemption Certificate Manager.
GET/api/v1/certificatesList exemption certificates visible in the current taxpayer scope.
GET/api/v1/certificates/{certificate_code}Get one scoped exemption certificate.
POST/api/v1/certificates/{certificate_code}/activateRecord an authorized human review of durable exemption evidence and activate the certificate.
PUT/api/v1/customers/{customer_code}/exemption-certificateAssign an active, currently effective certificate to its customer.
DELETE/api/v1/customers/{customer_code}/exemption-certificateRemove a customer certificate assignment.
POST/api/v1/tax/calculateCalculate US sales tax for one or more lines.
POST/api/v1/tax/quotesAlias of /tax/calculate for quote-style integrations.
POST/api/v1/tax/use/calculateCalculate consumer-use or direct-pay reverse-charge liability against vendor tax paid.
POST/api/v1/batches/calculationsQueue up to 500 independently isolated deterministic calculations.
GET/api/v1/batches/calculations/{batch_id}Poll a durable calculation batch and recover abandoned queued work.
POST/api/v1/transactionsRecord a committed transaction with ITMS-calculated or explicitly preserved caller tax.
POST/api/v1/transactions/create-or-adjustCreate a committed invoice or atomically revision-adjust the active document behind the same logical code.
GET/api/v1/transactions/savedList saved sales orders and purchase orders.
GET/api/v1/transactionsList API-created transactions for the key’s scope.
GET/api/v1/transactions/{code}Fetch a single transaction by the code you supplied at creation.
POST/api/v1/transactions/{code}/commitCommit a saved sales or purchase order as an invoice.
POST/api/v1/transactions/{code}/cancelCancel an uncommitted saved order.
POST/api/v1/transactions/{code}/voidCancel a committed transaction before it feeds compliance workflows.
POST/api/v1/transactions/{code}/refundCreate a refund linked to the original transaction (full or partial).
POST/api/v1/transactions/{code}/adjustAtomically reverse a committed sale and create its replacement revision.
POST/api/v1/transactions/{code}/tax-only-creditReverse selected committed tax without reversing gross or taxable sales.
POST/api/v1/transactions/{code}/replayAudit-replay a committed transaction from its persisted inputs and responsibility.
GET/api/v1/returns/statesList states that currently expose a return-package profile.
GET/api/v1/returns/filing-groupsList effective-dated multi-location filing units owned by the taxpayer organization.
POST/api/v1/returns/filing-groupsCreate one effective-dated return filing unit from several authorized locations.
POST/api/v1/returns/filing-groups/{group_id}/supersedeChange future multi-location membership without rewriting a filed period.
POST/api/v1/returns/filing-groups/{group_id}/dissolveEnd a filing group after its final applicable period.
DELETE/api/v1/returns/filing-groups/{group_id}/dissolveCancel a scheduled filing-group dissolution before its effective boundary.
PATCH/api/v1/returns/filing-groups/{group_id}Update a filing group that has not yet become effective.
DELETE/api/v1/returns/filing-groups/{group_id}Archive a filing group that has not yet become effective.
GET/api/v1/tax-code-mappingsList deterministic mappings from caller taxability-code namespaces, including Avalara codes, to active ITMS tax codes.
PUT/api/v1/tax-code-mappings/{source_system}/{source_code}Create or replace a line-level caller tax-code mapping.
DELETE/api/v1/tax-code-mappings/{source_system}/{source_code}Remove a caller tax-code mapping so later use of that source code fails closed.
PUT/api/v1/returns/california/registered-locationsSynchronize the complete verified CDTFA registered-location set used for Schedule C.
GET/api/v1/returns/california/registered-locationsRead the synchronized CDTFA sites that will populate Schedule C.
GET/api/v1/returns/state-profiles/{state}Inspect the supported fields, mappings, rules, and artifacts for a state return package.
GET/api/v1/returns/jurisdiction-accountsList state account profiles authorized for the API key scope.
POST/api/v1/returns/jurisdiction-accountsCreate a state account profile used to scope return-package preparation.
POST/api/v1/returns/packagesCreate or retrieve the active return package for a state, period, frequency, and account scope.
GET/api/v1/returns/packagesList return packages visible to the current API key.
GET/api/v1/returns/packages/{package_id}Fetch return-package detail, including current preparation and external-filing bookkeeping state.
GET/api/v1/returns/packages/{package_id}/artifactsList files generated for a return package.
GET/api/v1/returns/packages/{package_id}/artifacts/{artifact_id}/downloadDownload one generated return-package artifact after package and artifact authorization checks.
POST/api/v1/returns/packages/{package_id}/refreshRe-aggregate an unfiled package over the current eligible transactions.
POST/api/v1/returns/packages/{package_id}/amendCreate an amended successor to a filed return package.
POST/api/v1/returns/packages/{package_id}/mark-filedRecord that the customer filed a prepared return through an external process.
POST/api/v1/returns/packages/{package_id}/confirmRecord jurisdiction confirmation for a filing completed outside ITMS.
GET/api/v1/returns/packages/{package_id}/workflowRead a return package's review/approval workflow state.
POST/api/v1/returns/packages/{package_id}/workflow/submit-for-reviewSubmit a return package into the review workflow.
POST/api/v1/returns/packages/{package_id}/workflow/complete-reviewComplete reviewer tick-and-tie on a return package (gated).
POST/api/v1/returns/packages/{package_id}/workflow/request-changesSend a return package back to the preparer.
POST/api/v1/returns/packages/{package_id}/workflow/approveApprove a reviewed return package, locking the version.
POST/api/v1/returns/packages/{package_id}/workflow/invalidate-approvalReopen an approved return package for material correction.
POST/api/v1/tax-engine/provider-quotes/applyCalculate tax and apply the reviewed result to a supported provider draft before provider confirmation.
GET/api/v1/capabilitiesDiscover governed capabilities available to the service account in its exact tenant, location, and provider context.
POST/api/v1/capabilities/{capability_id}/executeExecute an authorized governed capability with durable idempotency and action evidence.
POST/api/v1/capabilities/actions/{action_id}/undoApply an authorized compensating action to a prior governed capability action.
GET/api/v1/operations/statusInspect tenant-scoped request, batch, and webhook queue health.