Payees

Every agent has a payee record containing their pay status, W9 (tax information) and direct deposit details. Pay status and W9 are effective-dated.

Operations

Operation	Scope	Description
PATCH /agents/{agentCode}/payee	write:agents	Change the current pay status, W9 and/or direct deposit.
GET /payees/assigned-statuses	read:agents	Pay status history across agents.
POST /payees/assigned-statuses	write:agents	Apply a pay status period to an agent's history.
GET /payees/w9s	read:agents	W9 history across agents.
POST /payees/w9s	write:agents	Apply a W9 period to an agent's history.

Pay status

The pay status controls whether an agent is active and can be paid. The available values are set up per agency. See Pay statuses.

Changing the current status through PATCH /agents/{agentCode}/payee takes effect today. Sending the status the agent already has does nothing.

To record a status for specific dates:

POST /agency-management/acme/payees/assigned-statuses

{
  "agentCode": "A1051",
  "status": "Terminated",
  "effectiveFrom": "2026-10-01",
  "initiator": "jsmith@acme-agency.com"
}

GET /payees/assigned-statuses filters: agentCode, payStatus, from, through, plus paging and sorting.

W9

The W9 holds the agent's US tax details: name, business name, tax classification, exempt payee code, address, account number, taxpayer identifier (SSN/EIN) and signature.

• Sending a W9 in PATCH /agents/{agentCode}/payee records a new W9 effective today, but only if it differs from the current one.
• POST /payees/w9s applies a W9 for specific dates.
• GET /payees/w9s filters: agentCode, from, through, plus paging and sorting.

caution

Sensitive data

W9 records include taxpayer identifiers. Limit who can use read:agents in your integration, and don't log these values.

Direct deposit

Direct deposit details (US or Canadian bank account) are not effective-dated. An update replaces the current details.