CreateDunningRunCommandRequestInput
Starts a dunning run: issues the next dunning notice for every sales invoice that matches the selection and can be dunned now, by the same rules as the proposal list and ‘CreateDunningNotice’. The run selects the invoices itself when it executes, so the result can differ from an earlier proposal list. Selected invoices that cannot be dunned any more when the notices are written are skipped and listed in the result; all other notices are written together, so a failed run issues none. Only one run can be running at a time; a run that stops making progress, for example because the server was restarted, ends with the status Failed. The call answers 202 with the ID of the run, which is polled with ‘GetDunningRun’ until its status is no longer Running. Dates are calendar dates in the time zone of the Wawi installation; ‘today’ is the current date there. Letters are printed or sent as output of the notices, not by the run. - Request
CreateDunningRunCommandRequestInputFields
The date printed on the notices. Only the date counts. Defaults to today and must not be before today. Invoices whose current notice has a later dunning date are skipped with DunningDateBeforeCurrentNotice.
Only invoices whose current payment due date is on or after this date are dunned. Only the date counts. Required; it limits how far back the selection reaches. A missing value is answered with 400 (validation code DUE_DATE_FROM_REQUIRED on 'dueDateFrom').
Only invoices whose current payment due date (without the grace period) is on or before this date are dunned. Only the date counts. Omitted means no upper bound; invoices that are not overdue yet are never dunned anyway.
Only invoices of this company. Omitted means all companies.
Only invoices with exactly this customer group; invoices without a customer group are not included. Omitted means all invoices.
Only invoices with this payment method. Omitted means all invoices whose payment method takes part in dunning, and invoices without a payment method.
Only invoices whose next notice would be at this level number. Omitted means all levels.
Only invoices with at least this open amount, in the currency of the invoice. Omitted means 0.
Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.
Was this page helpful?