1. Collection & Payment Control
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
  1. Collection & Payment Control

Update Collection Receivables

POST
https://api.cash-in.com/v2/updcollectionreceivables
This API Endpoint is for the Creditor to update debt collection receivables information.
Use Cases:
  1. Debtor made an direct payment to creditor.
  2. Creditor has credited the receivable partially.
  3. Creditor has credited the entire receivable.

Request

Authorization
API Key
Add parameter in header
X-Api-Key
Example:
X-Api-Key: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢202
application/json
Data saved
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cash-in.com/v2/updcollectionreceivables' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Receivables": [
        {
            "CaseID": "1008945",
            "Invoice_Number": "486567",
            "Invoice_Reference": "4865678",
            "Invoice_CustomerRef": null,
            "Invoice_Payment_Date": "2021-10-23",
            "Invoice_Payment_Amt": 100,
            "Invoice_Outstanding_Capital_Amt": 0,
            "Invoice_Delay_Interest_Amt": 0,
            "Invoice_Cost_Amt": 0,
            "Invoice_Currency": "EUR",
            "Transaction_Type": "P"
        }
    ]
}'
Response Response Example
202 - Example 1
{
    "BatchId": 0,
    "Url": "string"
}
Previous
Create Collection Cases
Next
Retrieve Collection Receivables Status
Built with