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

    Errors

    Cash-In API uses conventional HTTP response codes to indicate the success or failure of an API request.
    In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Cash-In API service - should not happen.

    Common error codes#

    CodeMessageDescription
    200OKEverything worked as expected
    400Bad requestThe request was unacceptable, often due to missing a required parameter
    401UnauthorizedNo valid API key provided
    402Request FailedThe parameters were valid but the request failed
    403ForbiddenThe API key doesn’t have permissions to perform the request
    404Not FoundThe requested resource doesn’t exist or data not found
    Previous
    Environments
    Next
    Contact us
    Built with