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

# remittance/account/profiles

`GET /remittance/account/profiles`

## Request

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

Lists the calling account's saved tax remittance payee profiles. Only active (non-deleted) profiles are returned. Results can be narrowed by client account, remittance type, or a free-text search across Nickname/PayerName/TaxAccountNumber, and are paginated.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string
- `TaxRemittanceType` string
- `SearchText` string
- `Limit` integer
- `Offset` integer

## 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
  - `RemittanceProfiles` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no profiles match.
    - `0` object
      - `RemittanceProfileToken` string, required: Opaque 64-character token identifying this profile. Supply on /remittance/create, /remittance/account/profiles/edit, or /remittance/account/profiles/delete.
      - `TaxRemittanceType` string, required: The category code this profile was saved for, as passed to /remittance/create.
      - `TaxCategoryName` string, nullable, required: Display name of the TaxRemittanceType category, matching Name in GET /remittance/tax-categories. Null if the category has no matching entry there (config drift).
      - `Nickname` string, required: The display label saved on this profile. Empty string when none was saved, never absent or null.
      - `TaxAccountNumber` string, required: The tax account number saved on this profile.
      - `PayerName` string, required: The legal name of the payer saved on this profile.
      - `DefaultDetails` object, nullable, required: The Details defaults saved on this profile, decoded to an object. Null when none are saved.
      - `ClientAccountID` string, nullable, required: The partner-supplied ClientAccountID of the client account this profile is scoped to. Null for an account-level profile usable with any client account.
      - `LastModified` string, required: Date/time the profile was last created or edited.
  - `PaginationMetaData` object, required: Pagination metadata for the results.
    - `TotalRecords` integer, required: Total number of profiles matching the supplied filters, across all pages.
    - `Offset` integer, required: The Offset that was applied (after server-side clamping).
    - `Limit` integer, required: The Limit that was applied (after server-side clamping).

---

[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)