paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

The "Create and Release" operation for the Claim resource in this node allows users to create a new claim (case) in the Paywise Case Management API and immediately release it for processing. This is useful in scenarios where you want to automate the submission of claims related to debt collection, such as invoices or service contracts that require follow-up actions like reminders or legal proceedings.

Typical use cases include:

  • Automating the creation of claims for overdue invoices.
  • Submitting detailed claim data including items, additional charges, payments, and related events.
  • Acting on behalf of a client company by specifying a user ID.
  • Starting the claim process with different approaches (extrajudicial, judicial, mail).

This operation streamlines the workflow of managing claims by integrating directly with the Paywise API, reducing manual entry and enabling automated case management.

Properties

Name Meaning
Input Type Choose whether to input claim data via individual fields or as a complete JSON object. Options: JSON, Fields.
Act on Behalf of Client Boolean flag indicating if the request should be made on behalf of a client company.
User ID The ID of the user to act on behalf of when Act on Behalf of Client is true.
JSON Data The full claim data as a JSON object, including all required and optional fields according to the API specification. Required if Input Type is JSON.
Debtor ID ID of the debtor involved in the claim. Required if Input Type is Fields.
Your Reference Your internal reference identifier for the claim. Required if Input Type is Fields.
Main Claim Amount Value Numeric value of the main claim amount. Required if Input Type is Fields.
Main Claim Amount Currency Currency code (EUR or USD) for the main claim amount. Required if Input Type is Fields.
Total Claim Amount Value Total numeric value of the claim including additional charges. Required if Input Type is Fields.
Total Claim Amount Currency Currency code (EUR or USD) for the total claim amount. Required if Input Type is Fields.
Due Date Due date of the claim in YYYY-MM-DD format. Required if Input Type is Fields.
Subject Matter Detailed description of the delivered goods or provided service. Required if Input Type is Fields.
Occurrence Date Date of emergence of the principal claim (Vertragsdatum) in YYYY-MM-DD format. Optional if Input Type is Fields.
Document Reference Unique reference of your invoice, contract, or other document. Optional if Input Type is Fields.
Document Date Date of your invoice, contract, or other document in YYYY-MM-DD format. Optional if Input Type is Fields.
Reminder Date Date of your first reminder (Mahnung) to your customer in YYYY-MM-DD format. Optional if Input Type is Fields.
Delay Date Date from which your debtor is in delay (Verzugsdatum) in YYYY-MM-DD format. Optional if Input Type is Fields.
Starting Approach The starting approach to collect the claim. Options: extrajudicial (default), judicial, mail.
Claim Disputed Boolean indicating whether the claim was disputed by your customer. Optional if Input Type is Fields.
Obligation Fulfilled Boolean indicating whether you fully fulfilled your contractual obligation towards the debtor. Optional if Input Type is Fields.
Items Collection of itemized entries related to the claim, each with description, quantity, unit, amount value, and currency. Optional if Input Type is Fields.
Additional Charges Sum Amount Sum of all additional charges' amount values. Optional if Input Type is Fields.
Additional Charges Sum Currency Currency code (EUR or USD) for the sum of additional charges. Optional if Input Type is Fields.
Additional Charges Collection of additional charge entries, each with references, subject matter, dates, amounts, and related events. Optional if Input Type is Fields.
Payments Collection of payment entries, each with references, amount, value date, and metadata. Optional if Input Type is Fields.
Metadata Collection of metadata key-value pairs related to the claim. Optional if Input Type is Fields.
Events Collection of event entries related to the claim, each with title, occurrence date, type, references, description, and location. Optional if Input Type is Fields.
Documents Collection of documents to attach to the claim, each specified by a binary property name containing file data and a file name. Only available for createAndRelease operation with Fields input type.

Output

The node outputs an array of JSON objects representing the response from the Paywise API after creating and releasing the claim. Each output item corresponds to one input item processed.

  • The json field contains the created claim's details as returned by the API, including identifiers, status, and any additional information provided by the server.
  • If documents are attached, the node handles binary data upload but does not output binary data itself.
  • No explicit binary output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Paywise API.
  • The node depends on the Paywise Case Management API being accessible and properly configured for the authenticated user.
  • Proper permissions are needed to create and release claims, especially when acting on behalf of another client.

Troubleshooting

  • Missing Required Fields: Errors may occur if mandatory fields like debtor ID, your reference, or claim amounts are missing. Ensure all required properties are set based on the chosen input type.
  • Invalid Dates: Date fields must be in YYYY-MM-DD format or ISO format for events. Incorrect formats will cause validation errors.
  • Authentication Failures: Verify that the API key credential is valid and has sufficient permissions.
  • Acting on Behalf of Client: When enabled, ensure the user ID is correct and authorized to perform actions on behalf of the client.
  • API Errors: The node throws errors received from the Paywise API. Review error messages for details such as invalid data or permission issues.
  • Binary Document Uploads: If attaching documents, confirm that the binary property names match existing binary data in the workflow and that files are correctly formatted.

Links and References

Discussion