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

Invoice Lifecycle service

The Invoice Lifecycle service covers the full process of managing invoices, including their printing and distribution, payment monitoring, sending reminders, and handling collections.
Each invoice (case) is monitored throughout its lifecycle, with all actions executed in line with the creditor’s the predefined rules.
As payments are received and processed, they are reconciled and allocated for settlement. Settlements are generated three times per week, and settlement payments are transferred to creditors on the same day.

Lifecycle service flow#

This diagram showcases the normal process flow of lifecycle.
cashin_invoice_lifecycle.svg
Invoice lifecycle flow diagram

Implementation plan - Invoice Lifecycle#

As the use of this service begins with posting new sales invoices, please follow the steps below to ensure optimal use of the API endpoints.
1
Create an invoice
Start the implementation with posting new invoice to the service.
Use the API endpoint Create an invoice
2
Retrieve the delivery information
Retrieval of invoice related delivery information is a key function to finding possible errors or failures on the distribution to the end customers. It's good practice to retrieve this data once a day.
Use the API endpoint Retrieve invoice delivery information
3
Retrieve case information
Each invoice has it's own case identifier, and monitoring of the case details gives your up-to-date information about the status of the case and invoice connected to the case.
Use the API endpoint Retrieve collection case to get updates
4
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.
5
Retrieve 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
6
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

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
Print & Distribution
As a key part of the process, our Print & Distribution service ensures that invoices are delivered to their recipients.
Learn more about Print & Distribution service.
Previous
Invoice Intermediation service
Next
Debt Collection service
Built with