Cash-In API
    • Introduction
    • Access tokens
    • Environments
    • Errors
    • Contact us
    • Resources
      • Services
      • Invoice Intermediation service
      • Invoice Lifecycle service
      • Debt Collection service
      • Debt Collection process
      • Confirma Software Partner services
    • Authorization
      • Authentication and authorization of the user
      • Validate token
        GET
      • Renew token
        GET
    • Collection & Payment Control
      • 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
    • Invoice Intermediation
      • Invoice Service
        • Create an invoice
        • Create batch of invoices
        • Create an invoice with seller information
        • 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
    • Confirma Software Partners
      • Submit new creditor
      • Update creditor
      • Retrieve creditor credentials
      • Retrieve External Agreement Identifiers
      • Retrieve invoice delivery information by seller
      • Send SMS message
    • Document Print Service
      • Create meter reading documents
    • Schemas
      • BatchDataResponse
      • BatchInvoices
      • BatchInvoicesList
      • BatchStatus
      • Case
      • CaseInvoiceExtended
      • 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
      • SalesInvoice
      • SalesInvoiceBatchResponse
      • SalesInvoicePayment
      • SalesInvoiceResponse
      • SalesInvoiceRow
      • SalesInvoiceUpdate
      • SalesInvoiceUpdateResponse
      • SalesInvoiceWithSellerInfoDTO
      • SalesItemResponse
      • SalesItems
      • SellerInfoDTO
      • Settlement
      • SettlementList
      • SettlementRows
      • SmsData
      • SmsDeliveryReport
      • SmsResponse
      • ValidationResponse
      • ViewOnlineInvoiceDeliveryStats

    Introduction

    The Cash-In API gives cooperation clients and partners programmatic access to Cash-In's financial services — including invoice distribution, payment control, debt collection, and settlement management. This documentation covers all available endpoints, their request and response structures, and guidance on how to implement each service correctly.

    API design#

    The Cash-In API 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.
    Authentication is handled via API key, which must be included in the X-Api-Key request header on every call. For full details on obtaining and managing your access token, see the Access tokens page.

    Environments#

    The API is available in two environments — production and sandbox. The sandbox is intended for development and endpoint testing only and does not execute business processes or affect live data. Separate access tokens are issued for each environment.
    For environment-specific base URLs and further details, see the Environments page.

    Services#

    The API covers four core service areas, each with its own set of endpoints and implementation workflow.
    Before building your integration, it is important to identify which service applies to your use case:
    ServiceDescription
    Invoice IntermediationInvoice printing and distribution without payment control
    Invoice LifecycleInvoice distribution with payment control, reminders, and collection
    Debt CollectionReminder and collection services
    Partner servicesConfirma Software partner management and creditor provisioning
    For a step-by-step guide on implementing each service, refer to Services.

    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.

    Versions#

    Current version of the API Service is version 2.0
    Next
    Access tokens
    Built with