VOvopay
Remittance Endpoints

remittance/tax-categories

Publishes the tax remittance category matrix: the display name, jurisdiction and exact Details fields required for each TaxRemittanceType accepted by /remittance/create. The response is identical for every caller.

get/remittance/tax-categories

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/remittance/tax-categories
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TaxRemittanceTypestring

Return only this category. An unrecognized value returns an empty TaxCategories list, not an error.

Jurisdictionstring

Return only categories in this jurisdiction: Federal, ON, QC, or NS. An unrecognized value returns an empty TaxCategories list, not an error.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "TaxCategories": {
    "0": {
      "TaxRemittanceType": "FED_GST_HST_RETURN",
      "Name": "GST/HST Return",
      "Jurisdiction": "Federal",
      "TaxPeriodEndDateRequired": true,
      "RequiredFields": {
        "0": {
          "FieldName": "101_SalesAndOtherRevenue",
          "DataType": "amount"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.