vsmsconnect — API — myob-tax-mappings

← all endpoints

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

List all MYOB tax-mappings for the business (`Provider='myob'`). Mirrors `/accounting/sage/tax-mappings`.

handlers: MyobTaxMappingsController.list

Inputs

No parameters.

Outputs

200
APIResponseDataList<TaxRateMappingDTO>
MYOB mappings (active and inactive, active first).
POST/api/v1/accounting/myob/tax-mappings/auto-map auth: jwt (administrator)

Pull MYOB tax codes + V-SDC `/status` and return match suggestions. Does NOT persist. Rate-limited (10/min open bucket).

handlers: MyobTaxMappingsController.autoMap

Inputs

No parameters.

Outputs

200
APIResponseDataObject<MyobTaxMappingAutoMapResponse>
Suggestions array.
401
APIError
MYOB_REAUTH_REQUIRED — MYOB refresh token rejected.
PUT/api/v1/accounting/myob/tax-mappings auth: jwt (administrator)

Create or update one MYOB tax-mapping. Fires `MYOB_TAX_MAPPING_UPDATED` audit.

handlers: MyobTaxMappingsController.upsert

Inputs

namerequireddefaultdescription
providerTaxType body
string
yes—MYOB tax-code (e.g. `GST`, `FRE`).
providerTaxName body
string | null
no—Human-readable MYOB tax name.
providerRate body
number | null
no—MYOB 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
MYOB_TAX_MAPPING_INVALID_LABEL — invalid `vsdcTaxLabel`.
DELETE/api/v1/accounting/myob/tax-mappings/:providerTaxType auth: jwt (administrator)

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

handlers: MyobTaxMappingsController.remove

Inputs

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

Outputs

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

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

handlers: MyobTaxMappingsController.restore

Inputs

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

Outputs

204
empty
No content.