remittance/account/profiles

get

https://earthnode-dev.vopay.com/api/v2/remittance/account/profiles

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Return only profiles scoped to this client account, plus account-level profiles (usable with any client account). Omit to return profiles across all client accounts (and account-level profiles).

TaxRemittanceType

string

Return only profiles saved for this remittance category. See GET /remittance/tax-categories for valid options.

SearchText

string

Free-text search matched against Nickname, PayerName, and TaxAccountNumber (OR across all three, substring match).

Limit

integer

The maximum number of profiles to return. Default is 50. Clamped server-side to between 1 and 100 - a value below 1 is raised to 1, a value above 100 is lowered to 100.

Offset

integer

The number of profiles to skip. Default is 0. Clamped server-side to a minimum of 0 - a negative value is raised to 0.

Response

200