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?

    Environments

    The environments for the Cash-In API service are as follows:

    Production environment#

    Base URL: https://api.cash-in.com
    Append /v2/ for the current API version before endpoint paths.
    The production environment is fully operational service that will respond and process the data as expected.
    Do not submit real-life data unless you have notified the IT department of Cash-In prior moving to production environment.

    Sandbox environment#

    Base URL: https://sandbox.cash-in.com
    Append /v2/ for the current API version before endpoint paths.
    The sandbox environment is available for the developers for testing the endpoints and getting response from the endpoints.
    Sandbox environment however does not support the business-process and can only used for developing and testing endpoints.
    Access tokens
    Please observe that we provide you separate API access tokens to sandbox and production environments
    Previous
    Authentication & security
    Next
    Errors
    Built with