VOvopay
Remittance Endpoints

remittance/account/profiles/edit

Edits a saved tax remittance payee profile. This is a full replacement of Nickname, TaxAccountNumber, PayerName, and DefaultDetails - omitting Nickname or DefaultDetails clears the existing saved value rather than leaving it unchanged. TaxRemittanceType cannot be changed on an existing profile; create a new profile via /remittance/account/profiles/add instead. Editing a profile never modifies any transaction already created from it - transactions keep their own independent snapshot of the payee details at the time they were created.

post/remittance/account/profiles/edit

Request

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

RemittanceProfileTokenstring required

Token of the profile to edit, as returned by POST /remittance/account/profiles/add. An unrecognized, inactive, already-deleted, or client-account-scope-mismatched token is rejected as not found.

TaxAccountNumberstring required

The tax account number to save on this profile. Always required, same as on POST /remittance/account/profiles/add - an edit is a full replacement of the profile's fields, so this value must always be supplied even when it is not changing. Must match the tax account number format required for the profile's TaxRemittanceType; federal and Quebec categories include a check digit, which is verified. An off-shape or bad-check-digit value is rejected with INVALID_PARAMETER.

PayerNamestring required

The legal name of the payer to save on this profile. Always required, same as on POST /remittance/account/profiles/add - an edit is a full replacement of the profile's fields, so this value must always be supplied even when it is not changing.

ClientAccountIDstring

Client Account ID the profile is scoped to. Omit only for accounts with client accounts disabled - accounts with client accounts enabled must supply one. Must match the profile's saved client account scope; a client-scoped profile is not found if this does not match, and an account-level profile is found regardless of what is supplied here.

TaxRemittanceTypestring

Not a valid parameter on this endpoint - a profile's remittance type cannot be changed. Supplying any non-empty value here is rejected; create a new profile via /remittance/account/profiles/add instead.

Nicknamestring

An optional display label for this profile. Full-replacement: omitting this parameter clears any previously saved Nickname rather than leaving it unchanged.

DefaultDetailsstring

A JSON formatted string of Details defaults to save on this profile. Full-replacement: omitting this parameter clears any previously saved DefaultDetails rather than leaving it unchanged. Every key must be a field flagged IsProfileField: true for this profile's TaxRemittanceType in GET /remittance/tax-categories - no field is currently flagged, so any key supplied here is rejected.

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

RemittanceProfileTokenstring required

The same token supplied in the request. Editing a profile never issues a new token.

Example response

{
  "Success": true,
  "RemittanceProfileToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
}

Changes

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