HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Reimbursement record / Correct amount

⚠️ Experimental endpoint — not yet a stable contract. This resource 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.

Reverses the original record in full with a credit record and creates a corrective record with the corrected amount in the current reimbursement period. Returns the corrective record. A record that is already reversed, or is itself a reversing record, cannot be corrected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
number
required
> 0

Corrected reimbursement amount including tax, in the record's currency. The amount without tax is derived from the record's tax basis and tax percentage. Rounded to the record currency's precision before the tax split; the rounded amount must be greater than zero. It must differ from the record's current amount after rounding; to re-document a record without changing its amount, use the credit action.

string
required
length between 1 and 500

Reason for the correction. Stored as the reason of the credit record that reverses the original record.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json