Archives a pay item. Cannot delete pay items linked to a payroll adjustment, salary pay items, pay items automatically created from an external source, pay items whose payroll run is no longer in preparation, or pay items with more than one live version.
Any id this API returned for a pay item edited through PATCH, including every entry of replaced_ids, is accepted and archives its current version, except for payments generated from a recurring pay item, which return 422. A pay item that was already deleted returns 404 with the message "Pay item not found because it was deleted", or 422 when it was a payment generated from a recurring pay item, so a retried delete never removes anything else.
Deleting a pay item frees its partner_external_id, so a later pay item can take the value.
See Your own IDs on Remote records.
Recurring pay items and the payments generated from them cannot be updated or deleted through this API and return 422.
When more than one refusal applies, the first in this order is returned: an employment that isn't on Global Payroll (404 "Pay item not found"), a recurring pay item or a payment generated from one (422), then a pay item with more than one live version (422).
Authentication
This endpoint accepts any one of the following token types:
- Company-scoped access token (
OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners. - Company-scoped access token (assertion) (
OAuth2CompanyManagerAssertion) — obtained through theurn:ietf:params:oauth:grant-type:jwt-bearergrant for a company manager. See OAuth Assertion. - Customer API token (
CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
Scopes
Any one of the scopes in a token type's row is enough. all:write works too.
| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage payroll runs (payroll) | - | Manage pay items (pay_item:write) |
| Company-scoped access token (assertion) | Manage payroll runs (payroll) | - | Manage pay items (pay_item:write) |
| Customer API token | Manage payroll runs (payroll) | - | Manage pay items (pay_item:write) |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||