Access for hirers and agencies
Hirers can grant write:purchase-orders to company-scoped API keys. These keys can create and manage purchase orders for companies attached to the key. Agency-scoped keys cannot use purchase order endpoints, even when a purchase order relates to that agency.
Creating and linking purchase orders
Select projects belonging to one accessible company and an agency connected to that company. Creation supports all trades, specific trades or a company trade tag. A site can be selected when the PO covers one project. Creation and update responses omit currency. Creation responses also omit revocation or reinstatement details.
Set massLink to true to link matching existing assignments that have no PO or invoice, excluding cancelled assignments. The default is false. Matching also respects the selected agency, projects, site and trades. Existing POs are not replaced.
Amending and revoking purchase orders
Partial updates preserve omitted fields. You can amend the reference, value, dates, projects and trade applicability. Currency is always set to the company default and cannot be supplied in creation or update requests. The agency and site cannot be changed. Projects and trades used by linked assignments cannot be removed, and changing trade applicability cannot exclude trades used by linked assignments. Reference changes update linked assignments and timesheets.
Set status to inactive to revoke a PO or active to reinstate it. Revocation removes the PO from pending assignments. Reinstatement does not automatically relink these assignments. Updating dates on a revoked PO does not reinstate it unless active is explicitly requested.