API breaking changes - December 2024

We plan to introduce breaking changes in the process of creating Loans, Credit Limits, and Invoices, on December 4, 2024. These changes aim to improve data consistency and ensure that necessary information is captured at each step. Please review the changes below to prepare for these updates.

1. Required Credit Limit Before Loan Creation

When creating a Loan, a Credit Limit must be established for the Debtor associated with the Invoice linked to the Loan. Failure to do so will result in an API error.

Steps to Ensure Compliance:

• Option 1: Create a Debtor:
  1. Create a Debtor:
     • POST /debtor
  2. Create a Credit Limit:
     • POST /credit-limit with debtorId and same debtorIdentifier
  3. Create an Invoice:
     • POST /invoice with debtorId or creditLimitId, or same debtorIdentifier as the one on the Credit Limit you created.
  4. Create a Loan:
     • POST /loan with invoiceId
• Option 2: Create a Credit Limit Directly:
  1. Create a Credit Limit:
     • POST /credit-limit with the required details
  2. Create an Invoice:
     • POST /invoice with creditLimitId or same debtorIdentifier as the one on the Credit Limit you created.
  3. Create a Loan:
     • POST /loan with invoiceId

2. Required Debtor Contact on Invoice

A contact, along with their email, is now mandatory when creating an Invoice. This requirement can be fulfilled in one of the following ways:

Steps to Ensure Compliance:

• Option 1: Directly on the Invoice
  1. Create an Invoice with Contact Details:
     • POST /invoice with at least one contact with a value for the email attribute
• Option 2: Linking to a Debtor
  1. Create a Debtor with Contact Details:
     • POST /debtor with at least one contact with a value for the email attribute
  2. Create an Invoice Linked to the Debtor:
     • POST /invoice with debtorId or same debtorIdentifier as the one on the Debtor you created.

By providing contact details on either the Invoice or the Debtor, you can ensure compliance with this requirement. We also strongly recommend you to fill a phone number for debt collection purposes.

3. Required Debtor Name for Credit Limits

The Debtor name field is now required when creating a Credit-limit. This information is crucial for authenticating the counterparty.

Steps to Ensure Compliance:

• Option 1: Through Debtor Creation
  1. Create a Debtor with Name:
     • POST /debtor with name
  2. Create a Credit Limit with DebtorId:
     • POST /credit-limit with debtorId
• Option 2: Directly on the Credit-limit
  1. Create a Credit Limit with Debtor name:
     • POST /credit-limit with debtorName

Additional Information

• Usage of Debtor name: The Debtor name will only be used for counterparty authentication. If you have a more specific company name available at the time of Invoice creation, it will not affect the Loan decision as long as both entities share or relate to the same parent organization.

Please review these changes carefully and update your implementation accordingly to avoid disruptions in your workflow. Should you have any questions or require further assistance, feel free to contact our support team.