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?

    Introduction

    The Cash‑In API Service (CIAS) is a RESTful API that lets partners and cooperation clients integrate Cash‑In’s financial services directly into their systems. With CIAS, you can automate invoice distribution, payment monitoring, settlement management, and debt collection, improving cash flow, reducing risk, and saving time on manual processes.
    CIAS is designed for developers and finance teams who want to manage receivables efficiently while maintaining control over the process. Whether you need simple invoice distribution, full lifecycle management, or targeted debt collection, the API supports your business needs.

    How it works#

    cashin_api_diagram.webp
    Cash-In API Service

    Services Overview#

    CIAS provides four core service areas, each with its own endpoints and workflow. Before starting your integration, choose the service that best fits your business need.
    ServiceWhat it DoesWhen to Use
    Invoice IntermediationPrints and distributes invoices without handling payments.You want to send invoices quickly but manage follow-up and payments yourself
    Invoice LifecycleAutomates invoice distribution, reminders, and staged collection.Recommended for most clients — You want proactive payment management with minimal manual work to reduce late payments
    Debt CollectionProvides reminder and collection workflows for overdue invoices.You need to recover overdue invoices after payment issues occur
    Partner servicesManages multiple creditors via Confirma Software integration.You are managing multiple creditors or partners from a single integration
    Need more info?
    For a step-by-step guide on implementing each service, refer to Services.

    Authentication#

    Authentication is handled via API key, which must be included in the X-Api-Key request header on every call.
    Learn more
    For full details on obtaining and managing your access token, see the Authentication & security page.

    Environments#

    The API is available in two environments — production and sandbox.
    Separate access tokens are issued for each environment.
    Learn more
    For environment-specific base URLs and further details, see the Environments page.

    API design principles#

    The CIAS is built on REST principles.
    All endpoints are resource-oriented, accept JSON-encoded request bodies, and return JSON-encoded responses.
    Standard HTTP verbs and response codes are used throughout.

    Request scope#

    Most endpoints are designed to operate on a single object per request.
    Where bulk operations are supported — such as batch invoice submission — this is noted explicitly in the endpoint documentation.

    Error handling#

    Cash-In API Service (CIAS) uses conventional HTTP response codes to indicate the success or failure of an API request.
    Learn more
    For more information about errors, see Errors page.

    Versions#

    Latest version of the API service is version 2.0 - /v2/

    Steps after development#

    Once you have completed development and tested your integration in the sandbox environment, the next step is to go live with your API client.
    Our Go-Live & Deployment guide walks you through onboarding new clients, verifying production integration, and monitoring your first live requests.

    Explore the Cash-In Client Portal#

    After development and testing, your clients can access their data and manage their services through the Cash-In Client Portal. online.cash-in.fi
    Näyttökuva 2026-04-03 kello 4.28.36.png
    The portal provides secure, real-time visibility into:
    1.
    Debt Collection – Track cases, settlements, and collection progress.
    2.
    Invoicing – Send invoices, monitor distribution, and access reporting.
    3.
    Intermediation – View intermediation invoices and quantitative metrics.
    Additional features include secure messaging to contact support and Credit Information Services to make informed decisions.
    The portal complements the API, giving clients an intuitive interface for tracking invoices and collections while ensuring all data is consistent across systems.
    Learn more
    For more information, see Cash-In Client Portal page.

    Technical Environment#

    This API service is built using .NET Core and ASP.NET Web API, providing a modern, high-performance, and cross-platform foundation for service development. It leverages the robust middleware pipeline of ASP.NET to handle request processing, authentication, logging, and error handling in a scalable and maintainable way.
    For data persistence and management, the service utilizes the Oracle Database engine. Oracle provides a reliable, enterprise-grade relational database system with strong support for transactional integrity, scalability, and advanced querying capabilities. It enables efficient handling of large datasets, supports complex data relationships, and ensures high availability through robust backup and recovery mechanisms.
    Overall, this technology stack enables reliable performance, strong security practices, and easy integration with a wide range of clients and services.
    Next
    Authentication & security
    Built with