Accounting Document

An Accounting Document is a critical record generated by our system to capture and store financial transactions related to debt collection. These documents serve as the backbone for tracking all monetary exchanges, ensuring accurate and transparent financial records. Accounting documents are created whenever there are transactions involving amounts through our collection API. They capture all necessary details such as transaction type, amount, date, currency, and references, providing a reliable audit trail for financial activities.

Attributes

Attributes	Type	Description
date	date	The value date of the accounting document.
type	enum	This represent the type of accounting document. enum: DIRECT_PAYMENT, AGENCY_PAYMENTS, CREDIT_WAIVER, DEBIT, WRITE_OFF, CANCELLATION, REALLOCATION
number	string	Number of the payment, provided by the client or the agency.
originalType	enum	The original type of the accounting document, if it is a CANCELLATION or REALLOCATION. enum: DIRECT_PAYMENT, AGENCY_PAYMENTS, CREDIT_WAIVER, DEBIT, WRITE_OFF, null
originalNumber	string	The original number of the accounting document, if it is a CANCELLATION or REALLOCATION.
amount	number	The amount
currency	string	This reflects all relevant currencies in ISO-4217.

Sample Request

GET {{collection_api_base_url}}/v1/transactions?type=accountingDocument&from=2024-05-22&to=2024-05-23

Sample Response

{
    "accountingDocument": {
        "amount": -100,
        "currency": "EUR",
        "date": "2023-11-23",
        "type": "directPayment / agencyPayment / creditWaiver",
        "number": "PAY12345",
        "lineItems": [
            {
                "id": "13145326",
                "amount": -20,
                "allocateTo": "principalClaim",
                "invoiceNumber": "INV1234",
                "contractNumber": "V12345"
            },
            {
                "id": "9876543",
                "amount": -80,
                "allocateTo": "overPayment",
                "invoiceNumber": "INV4567",
                "contractNumber": "V12345"
            }
        ]
    }
}

Criteria for Accounting Document Creation

Accounting documents are generated in the following scenarios:

1. Creating a Claim
   When a client initiates a new claim involving an amount due from a debtor, an accounting document is created to record the claim’s financial details. This includes the claim amount, currency, and any associated reference information.

2. Creating a Payment
   For payment transactions, accounting documents track the amount paid and the transaction details. There are two key payment scenarios:

• Payment to Riverty: If a customer makes a payment directly to Riverty, an accounting document of type agency_payment is generated to record the transaction, including the payment amount, date, and associated claim details.
• Payment to Client: Alternatively, if the payment is made to the client rather than directly to Riverty, an accounting document of type direct_payment will also be generated. This document will specify the payment amount, date, and indicate the client as the recipient.

3. Creating a Payment Cancellation
   If a payment needs to be canceled, an accounting document will be generated to reverse the transaction. This document captures the cancellation details, including the original payment amount and reason for cancellation.

4. Creating a Credit Waiver
   A credit waiver, which might involve reducing the claim amount or waiving certain charges, also leads to the creation of an accounting document. This document reflects the amount waived and the updated claim details.

5. Creating a Recall
   A recall can either be partial or total, and accounting documents are created in both scenarios. Both types of recalls result in the creation of accounting documents to capture the adjusted claim details and maintain accurate financial records.

• Total Recall: A total recall occurs when a client decides to recall the entire claim, effectively withdrawing the entire debt collection process.
• Partial Recall: In contrast, a partial recall involves recalling only specific invoices that are part of a claim, rather than the entire claim.