paywise icon

paywise

Consume paywise API
Join our community

Actions20

Overview

This node integrates with the Paywise Case Management API to create new claims. It allows users to submit detailed claim data either by filling individual fields or by providing a complete JSON object representing the claim. This is useful in scenarios where businesses need to manage and automate their debt collection processes, such as invoicing disputes, reminders, and tracking payments related to claims.

Practical examples include:

  • Creating a claim for an unpaid invoice with detailed itemization and payment history.
  • Automating the submission of claims on behalf of client companies.
  • Managing complex claims that include additional charges, events, and metadata.

Properties

Name Meaning
Input Type Choose whether to input claim data via individual fields or as a full 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 (required if acting on behalf of a client).
JSON Data Full claim data as a JSON object including all required and optional fields according to the API specification (used when Input Type is JSON).
Debtor ID ID of the debtor (required when Input Type is Fields).
Your Reference Your reference identifier for this claim (required when Input Type is Fields).
Main Claim Amount Value Numeric value of the main claim amount (required when Input Type is Fields).
Main Claim Amount Currency Currency of the main claim amount. Options: EUR, USD (required when Input Type is Fields).
Total Claim Amount Value Total value of the claim including additional charges (required when Input Type is Fields).
Total Claim Amount Currency Currency of the total claim amount. Options: EUR, USD (required when Input Type is Fields).
Due Date Due date of the claim in YYYY-MM-DD format (required when Input Type is Fields).
Subject Matter Detailed description of the delivered goods or provided service (required when Input Type is Fields).
Occurrence Date Date of emergence of the principal claim in YYYY-MM-DD format (optional when Input Type is Fields).
Document Reference Unique reference of your invoice, contract, or other document (optional when Input Type is Fields).
Document Date Date of your invoice, contract, or other document in YYYY-MM-DD format (optional when Input Type is Fields).
Reminder Date Date of your first reminder to your customer in YYYY-MM-DD format (optional when Input Type is Fields).
Delay Date Date from which your debtor is in delay in YYYY-MM-DD format (optional when Input Type is Fields).
Starting Approach The starting approach to collect the claim. Options: extrajudicial (start with extrajudicial collection), judicial (start with judicial proceedings), mail (start with mail notification).
Claim Disputed Boolean indicating whether the claim was disputed by your customer (optional when Input Type is Fields).
Obligation Fulfilled Boolean indicating whether you fully fulfilled your contractual obligation towards the debtor (optional when Input Type is Fields).
Items Collection of items included in the claim, each with description, quantity, unit, amount value, and currency (optional when Input Type is Fields).
Additional Charges Sum Amount Sum of all additional charges (optional when Input Type is Fields).
Additional Charges Sum Currency Currency of the additional charges sum. Options: EUR, USD (optional when Input Type is Fields).
Additional Charges Collection of additional charges, each with references, subject matter, dates, amounts, and related events (optional when Input Type is Fields).
Payments Collection of payments related to the claim, each with references, amount, value date, and metadata (optional when Input Type is Fields).
Metadata Collection of metadata items related to the claim, each with type and value (optional when Input Type is Fields).
Events Collection of events related to the claim, each with title, occurrence date, type, reference, description, and location (optional when Input Type is Fields).

Output

The node outputs an array of JSON objects representing the created claim(s) as returned by the Paywise API. Each output item contains the full response JSON from the API call, which includes details about the newly created claim, its status, identifiers, and any related information.

If binary data were involved (not indicated here), it would typically represent files or documents related to the claim, but this node focuses on JSON data only.

Dependencies

  • Requires an active connection to the Paywise API.
  • Requires an API key credential configured in n8n for authentication.
  • The node depends on the Paywise Case Management API endpoints for claim creation.
  • Proper permissions and user IDs are necessary if acting on behalf of a client.

Troubleshooting

  • Missing Required Fields: Ensure all required fields are provided based on the selected input type (fields or json). Missing mandatory fields like debtor ID, claim amounts, or due date will cause errors.
  • Invalid Date Formats: Dates must be in YYYY-MM-DD or ISO format as specified. Incorrect formats may lead to validation errors.
  • Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Acting on Behalf of Client: If enabled, ensure the user ID is valid and authorized to perform actions on behalf of the client.
  • API Limitations: Large or complex claims with many nested items, charges, or events might hit API limits or timeouts.
  • Error Messages: The node throws errors if the resource or operation is not implemented, or if the API returns an error. Review the error message for missing parameters or invalid values.

Links and References

  • Paywise API Documentation
  • Paywise Case Management API specification for claims (refer to official docs for detailed schema and examples).

Discussion