vsmsconnect — API — accounting-push-tax-mappings

← all endpoints

GET/api/v1/accounting/sage100/tax-mappings auth: jwt (administrator)

List Sage 100 tax-mappings for the business (`Provider='sage100'`).

handlers: AccountingAgentTaxMappingsController.listFor('sage100')

Inputs

No parameters.

Outputs

200
APIResponseDataList<TaxRateMappingDTO>
Sage 100 mappings.
PUT/api/v1/accounting/sage100/tax-mappings auth: jwt (administrator)

Upsert one Sage 100 tax-mapping. Same body shape as the other tax-mapping CRUD surfaces.

handlers: AccountingAgentTaxMappingsController.upsertFor('sage100')

Inputs

namerequireddefaultdescription
providerTaxType body
string
yes—Sage 100 tax-code.
providerTaxName body
string | null
no—Human-readable tax name.
providerRate body
number | null
no—Provider tax rate.
vsdcTaxLabel body
string
yes—V-SDC label.
vsdcRate body
number | null
no—V-SDC rate percent.

Outputs

200
APIResponseDataObject<TaxRateMappingDTO>
Upserted mapping.
422
APIError
Invalid V-SDC label.
DELETE/api/v1/accounting/sage100/tax-mappings/:providerTaxType auth: jwt (administrator)

Soft-delete a Sage 100 tax-mapping (`IsActive=0`). Idempotent.

handlers: AccountingAgentTaxMappingsController.removeFor('sage100')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—Sage 100 tax-code to deactivate.

Outputs

204
empty
No content.
PATCH/api/v1/accounting/sage100/tax-mappings/:providerTaxType/restore auth: jwt (administrator)

Re-activate a deactivated Sage 100 mapping (`IsActive=1`). Idempotent.

handlers: AccountingAgentTaxMappingsController.restoreFor('sage100')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—Sage 100 tax-code to re-activate.

Outputs

204
empty
No content.
GET/api/v1/accounting/sage300/tax-mappings auth: jwt (administrator)

List Sage 300 tax-mappings for the business (`Provider='sage300'`).

handlers: AccountingAgentTaxMappingsController.listFor('sage300')

Inputs

No parameters.

Outputs

200
APIResponseDataList<TaxRateMappingDTO>
Sage 300 mappings.
PUT/api/v1/accounting/sage300/tax-mappings auth: jwt (administrator)

Upsert one Sage 300 tax-mapping.

handlers: AccountingAgentTaxMappingsController.upsertFor('sage300')

Inputs

namerequireddefaultdescription
providerTaxType body
string
yes—Sage 300 tax-code.
providerTaxName body
string | null
no—Human-readable tax name.
providerRate body
number | null
no—Provider tax rate.
vsdcTaxLabel body
string
yes—V-SDC label.
vsdcRate body
number | null
no—V-SDC rate percent.

Outputs

200
APIResponseDataObject<TaxRateMappingDTO>
Upserted mapping.
422
APIError
Invalid V-SDC label.
DELETE/api/v1/accounting/sage300/tax-mappings/:providerTaxType auth: jwt (administrator)

Soft-delete a Sage 300 tax-mapping (`IsActive=0`). Idempotent.

handlers: AccountingAgentTaxMappingsController.removeFor('sage300')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—Sage 300 tax-code to deactivate.

Outputs

204
empty
No content.
PATCH/api/v1/accounting/sage300/tax-mappings/:providerTaxType/restore auth: jwt (administrator)

Re-activate a deactivated Sage 300 mapping (`IsActive=1`). Idempotent.

handlers: AccountingAgentTaxMappingsController.restoreFor('sage300')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—Sage 300 tax-code to re-activate.

Outputs

204
empty
No content.
GET/api/v1/accounting/amicus/tax-mappings auth: jwt (administrator)

List AMICUS tax-mappings for the business (`Provider='amicus'`).

handlers: AccountingAgentTaxMappingsController.listFor('amicus')

Inputs

No parameters.

Outputs

200
APIResponseDataList<TaxRateMappingDTO>
AMICUS mappings.
PUT/api/v1/accounting/amicus/tax-mappings auth: jwt (administrator)

Upsert one AMICUS tax-mapping.

handlers: AccountingAgentTaxMappingsController.upsertFor('amicus')

Inputs

namerequireddefaultdescription
providerTaxType body
string
yes—AMICUS tax-code (typically `VAT` or `EXEMPT`).
providerTaxName body
string | null
no—Human-readable tax name.
providerRate body
number | null
no—Provider tax rate.
vsdcTaxLabel body
string
yes—V-SDC label.
vsdcRate body
number | null
no—V-SDC rate percent.

Outputs

200
APIResponseDataObject<TaxRateMappingDTO>
Upserted mapping.
422
APIError
Invalid V-SDC label.
DELETE/api/v1/accounting/amicus/tax-mappings/:providerTaxType auth: jwt (administrator)

Soft-delete an AMICUS tax-mapping (`IsActive=0`). Idempotent.

handlers: AccountingAgentTaxMappingsController.removeFor('amicus')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—AMICUS tax-code to deactivate.

Outputs

204
empty
No content.
PATCH/api/v1/accounting/amicus/tax-mappings/:providerTaxType/restore auth: jwt (administrator)

Re-activate a deactivated AMICUS mapping (`IsActive=1`). Idempotent.

handlers: AccountingAgentTaxMappingsController.restoreFor('amicus')

Inputs

namerequireddefaultdescription
providerTaxType path
string
yes—AMICUS tax-code to re-activate.

Outputs

204
empty
No content.