Preview using an earlier dividend overpayment

Shows the set-off the commit will post, writing nothing: on a payment line that pays a declared dividend short (dividend_id), amount of what an earlier dividend of the same shareholders was paid too much (from_dividend_id) is used on it, so the line and the overpayment together settle it. The journal moves the amount within Dividends payable, Dr on this one / Cr on the dividend paid too much, dated the line's date, with no VAT and no bank movement. The answer has unpaid_here and paid_too_much before, outstanding_amount_after and paid_too_much_after, the journal and a confirmation_token valid 5 minutes. Refusals name the reason in error.code: amount, above_unpaid, above_overpayment, same_dividend, other_shareholders, other_currency, void, not_in_parts, line_booked, line_before_declaration, line_not_for_dividend, period_closed, filed_vat, dividend_not_found. Requires Idempotency-Key (reuse it on the commit), the dividends:action OAuth scope with update_bank_accounts, dividends.pay and dividends.view. Answers 403 reconcile_view_not_available where the new Reconcile is not on for the company.

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

Proposed values used to preview using an earlier dividend overpayment without persisting changes.

dividend.setOff.preview: what an earlier dividend was paid too much,
used on a later one of the same shareholders from a bank line (reconcile
round 5 A39b-2, A44).

uuid
required

The dividend it is used on: declared and paid in parts.

uuid
required

The earlier dividend of the same shareholders that was paid too much.

number
required
≤ 999999999999

At most what it was paid too much and what is still unpaid here after the line.

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*