paywiseInstall

Summary

Create a new order for a specified debtor with detailed claims and optional additional parameters, optionally submitting it immediately to initiate collection or enforcement procedures.

Inputs

• Debtor ID (required) — The unique identifier of an existing debtor who will be the primary debtor of the order.
• Order Type (required) — Type of the order; options include 'Invoice' for receivables from invoices, 'Rental' for rent arrears with a rental agreement, and 'Titled' for claims with an enforceable title.
• Claims (JSON) (required) — A JSON array of up to 50 claims associated with the order, detailing receivables or other claim data as specified in the Paywise API documentation.
• Submit Order — Boolean flag indicating whether to submit the order immediately after creation; leaving false keeps the order as a draft (e.g., to upload documents before submission).
• Additional Fields — Optional fields including Starting Approach (extrajudicial or judicial), Creditor Obligation Fulfilled (required before submitting invoice and rental orders), Success Fee Confirmed (required for titled orders before submission), Confirmation Email to receive submission confirmation, Additional Debtor IDs (comma-separated), and Rental Agreement data (for rental orders).
• Options — Optional parameters including an idempotency key to safely retry requests without creating duplicates within 24 hours, useful for deduplication across executions.

Output shape

a single record

Returns the data of the newly created order, reflecting the submitted or draft status depending on the 'Submit Order' input; includes official order identifiers and related metadata from Paywise.

Links

• n8n community nodes installation guide