⚠️ Experimental endpoint — not yet a stable contract. This action ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.
Set the applicable live custom field values of a partner settlement report without changing the historical report, its generated documents, party and settings snapshots, or derived partner invoices. This action requires permission to view the partner settlement report and the PartnerSettlementReports.update-custom-fields permission.
Send a JSON object containing the required customFields object. Omitted identifiers remain unchanged, while null clears the corresponding value. When custom fields are enabled for partner settlement reports, an empty object succeeds as a no-op. Invalid or unavailable identifiers and invalid values return 422 validation errors. If custom fields are disabled for the tenant or partner settlement reports, the action returns 412 Precondition Failed. Neither rejection changes submitted values. A 404 response means the partner settlement report was not found.
The response is the current default read representation after applying the values; customFields remains live metadata and is not a point-in-time representation of the historical settlement report.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
