1. Resources
Cash-In API
  • Introduction
  • Authentication & security
  • Environments
  • Errors
  • Contact us
  • Resources
    • Services
    • Invoice Intermediation service
    • Invoice Lifecycle service
    • Debt Collection service
    • Debt Collection process
    • Cash-In Client Portal
    • Print & Distribution service
    • Confirma Software Partner services
    • Go-Live & Deployment Guide
    • General data types
    • Invoice Service Data types
    • Release Notes
  • Token endpoints
    • Validate token
      GET
    • Renew token
      GET
  • Collection endpoints
    • Create Collection Cases
      POST
    • Update Collection Receivables
      POST
    • Retrieve Collection Receivables Status
      GET
    • Retrieve Case Batch Status
      GET
    • Retrieve collection case
      GET
    • Retrieve debtor summary
      GET
    • Retrieve list of settlements
      GET
    • Retrieve settlement data
      GET
    • Retrieve list of direct settlements
      GET
    • Retrieve direct settlement data
      GET
    • Retrieve Credit Loss Receivables
      GET
    • Retrieve allocated payment transactions
      GET
  • Invoice endpoints
    • Invoice Service
      • Create an invoice
      • Create an invoice with seller information
      • Submit a batch of sales invoices
      • List batch uploads and export lines
      • List all sales invoices
      • Retrieve invoice delivery information
      • Retrieve invoice status
      • Update an invoice
      • Submit payment for an invoice
      • Retrieve delivery statistics
      • Retrieve received payments
      • Submit update to Finvoice Account
      • Retrieve electronic invoicing contracts
    • Product Management
      • List all products
      • Submit new products
      • Delete an product
    • Customer Management
      • List all customers
      • Submit new customers
      • Update an customer
      • Delete an customer
    • External invoices
      • Retrieve delivery information
      • Retrieve payment information
      • Create an direct payment
      • Submit an invoice action
      • Retrieve status of the agreement
  • Partner endpoints
    • Submit new creditor
    • Update creditor
    • Retrieve Creditor Credentials
    • Retrieve Finvoice Credentials
    • Retrieve External Agreement Identifiers
    • Retrieve invoice delivery information by seller
    • Send SMS message
  • Document endpoints
    • Create meter reading documents
  • Operations endpoints
    • Service Status
  • Schemas
    • BatchDataResponse
    • SalesInvoiceBatchResponse
    • OnlineInvoiceBatchProcedureOutcomeDto
    • OnlineInvoiceBatchListResponse
    • OnlineInvoiceBatchListItemDto
    • OnlineInvoiceBatchExportLineDto
    • AllocatedPaymentTransactionsResponse
    • Finvoice Registry Credentials Record
    • BatchInvoices
    • AllocatedPaymentTransactionItem
    • SalesInvoice
    • BatchInvoicesList
    • PaymentTypeInfo
    • BatchStatus
    • PaymentDatesInfo
    • Case
    • PaymentAmountsInfo
    • CaseInvoiceExtended
    • AllocatedPaymentTransactionsMeta
    • CaseList
    • CaseSummary
    • CollectionResponse
    • ContactPerson
    • CreditLossReceivable
    • Creditor
    • CreditorData
    • CreditorDetails
    • CreditorIdentifiers
    • CreditorResponse
    • CreditorUpdateData
    • CreditorUpdateDetails
    • CreditorUpdateResponse
    • CustomParameters
    • Debtor
    • DirectSettlementList
    • DirectSettlementRows
    • DirectSettlements
    • DocumentCustomer
    • DocumentResponse
    • ElectronicInvoicingContracts
    • ErrorMessage
    • ExternalAgreementIdentifiers
    • ExternalAgreementStatusResponse
    • ExternalInvoice
    • ExternalInvoiceActions
    • ExternalInvoiceRows
    • FinvoiceAccountUpdate
    • FinvoiceAccountUpdateResponse
    • IntegrationsAccountingLedgerData
    • IntermediationInvoiceDirectPaymentResponse
    • IntermediationInvoiceDirectPayments
    • IntermediatorInvoice
    • Invoice
    • InvoiceActionResponse
    • InvoicePaymentsResponse
    • InvoicesDeliveryInformation
    • LedgerRowDimensions
    • LedgerRows
    • Ledgers
    • Messages
    • MeterCompany
    • MeterDocument
    • MeterDocumentList
    • MeterReading
    • MeterUsageLocation
    • NxsReceivedPayments
    • OnlineCustomer
    • OnlineCustomerResponse
    • OnlineCustomerUpdateResponse
    • OnlineInvoicePaymentControl
    • OnlineProduct
    • OnlineSalesInvoices
    • PagedSalesInvoicesResponse
    • Payment
    • Receivable
    • ReceivablesList
    • ReceivedPaymentRows
    • ReceivedPayments
    • ReceivedPaymentsResponse
    • RenewResponse
    • SalesAddressDTO
    • SalesInvoiceBatchResponse
    • SalesInvoicePayment
    • SalesInvoiceResponse
    • SalesInvoiceRow
    • SalesInvoiceUpdate
    • SalesInvoiceUpdateResponse
    • SalesInvoiceWithSellerInfoDTO
    • SalesItemResponse
    • SalesItems
    • SellerInfoDTO
    • Settlement
    • SettlementList
    • SettlementRows
    • SmsData
    • SmsDeliveryReport
    • SmsResponse
    • ValidationResponse
    • ViewOnlineInvoiceDeliveryStats
Need help?
  1. Resources

Debt Collection service

The Debt Collection service includes reminder and collection services. Each case is monitored and managed according to the predefined rules defined with the creditor.
Settlement Schedule
Settlements are created once a week, including all pending allocated payments, and sent to creditors the same day.

Implementation plan#

To enable full debt collection integration, use the following API endpoints.
1
Create collection case(s)
Start the implementation by submitting outstanding receivable(s) to the service.
Use the API endpoint Create Collection Cases
2
Retrieve case information
Monitoring of the case details gives your up-to-date information about the status of the case and connected outstanding receivables.
Use the API endpoint Retrieve collection case to get updates
3
Update of the receivables
When a creditor receives payments from a debtor, this information must be updated in Cash-In Payment Control. Use the Update Collection Receivables API endpoint to record these payments.
4
List of settlements
Retrieve the list of fresh settlements for the sales invoices that have received payments, and are part of the settlement.
Use the API endpoint Retrieve list of settlements
5
Retrieve settlement data
For detailed information on an individual settlement, the payload contains all invoices to which payments have been allocated.
Use the API endpoint Retrieve settlement data with settlement number
6
Retrieve credit loss data
Sometimes the debt collection process does not complete with success - due to debtor situation. We publish credit loss cases once a month (first day of each month)
Use the API endpoint Retrieve Credit Loss Receivables

Optional feature: Allocated Payment Transactions#

This endpoint allows creditors to retrieve detailed payment transaction data related to debt collection cases. The returned transactions include rebates, write-offs, bank transfers, and other fund allocation events associated with payments.
The endpoint can be used to track how received funds have been allocated across cases and transactions.
API endpoint: Retrieve allocated payment transactions

Collection process flow#

This diagram demonstrates the normal process flow of collection.
cashin_debt_collection.svg
Debt collection flow diagram

Learn more about Debt Collection Process
It’s recommended to familiarize yourself with the Debt Collection process to better understand how the service works and what steps are involved.
Previous
Invoice Lifecycle service
Next
Debt Collection process
Built with