---
title: "remittance/transaction"
method: GET
path: "/remittance/transaction"
tags: ["Remittance Endpoints"]
---

# remittance/transaction

`GET /remittance/transaction`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/remittance/transaction`
- Auth: none declared

This endpoint is used to fetch a single tax remittance transaction. To list tax remittance transactions, use the /account/transactions endpoint with TransactionType=Tax Remittance.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `TransactionID` string
- `ClientReferenceNumber` string

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `TransactionID` string, required: The unique ID of the tax remittance transaction.
  - `TransactionStatus` string, required: The status of the tax remittance. One of: pending, in progress, successful, cancelled, failed, waiting, pending approval.
  - `TransactionDateTime` string, required: The date and time the transaction was created.
  - `LastModified` string, required: The date and time the tax remittance was last updated.
  - `Amount` number, required: The amount remitted to the tax authority.
  - `Currency` string, required: The currency of the remittance. Always CAD.
  - `TaxRemittanceType` string, required: The type of tax remittance that was filed.
  - `TaxAccountNumber` string, required: The tax account number the remittance was filed against.
  - `TaxPeriodEndDate` string, nullable, required: The end date of the tax period being remitted for.
  - `PayerName` string, nullable, required: The name of the payer the remittance was filed for.
  - `Details` object, nullable, required: The remittance-type-specific fields that were filed. The keys returned depend on TaxRemittanceType.
  - `ClientReferenceNumber` string, required: Your reference number for the transaction.
  - `Notes` string, required: Notes recorded against the transaction.
  - `GLCode` string, required: The general ledger code recorded against the transaction.
  - `ClientAccountID` string, nullable, required: The client account the transaction belongs to. Null if the transaction was not made against a client account.
  - `FailureReason` string, nullable, required: The reason the remittance failed, if applicable.
  - `TaxAuthorityErrorCode` string, nullable, required: The error code returned by the tax authority, if applicable.

---

[API](https://skmtc.dev/vopay/apis/remittance-api.md) - [All operations](https://skmtc.dev/vopay/apis/remittance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/remittance-api/revisions/d8a4c4720960?raw)