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

    Access tokens

    Any use of the Cash-In API requires a valid access token, which must be included in the request header as X-Api-Key
    cashin_auth_flow.svg
    Authentication flow
    Add the X-Api-Key header to every request, using your access token as the value.
    Tokens are created separately for the production and sandbox environments.
    Your access token will be sent upon email request from Cash-In IT department. We will verify the request before emailing the credentials to you.
    Your API Access Tokens carry many privileges, so be sure to keep them secure!
    You can use the endpoint Validate token any time, and Renew token after production has started.
    Since the Cash-In API service is open to public internet, we restrict the use of the API service by IP address restrictions.
    Submit your IP address information directly to Cash-In IT department. This is mandatory prior going to production with your API client.
    Previous
    Introduction
    Next
    Environments
    Built with