# Cash-In API ## Docs - [Introduction](https://developer-api.cash-in.com/introduction-362678m0.md): - [Access tokens](https://developer-api.cash-in.com/access-tokens-362679m0.md): - [Environments](https://developer-api.cash-in.com/environments-362682m0.md): - [Errors](https://developer-api.cash-in.com/errors-362775m0.md): - [Contact us](https://developer-api.cash-in.com/contact-us-362680m0.md): - Resources [Services](https://developer-api.cash-in.com/services-362681m0.md): - Resources [Invoice Intermediation service](https://developer-api.cash-in.com/invoice-intermediation-service-362788m0.md): - Resources [Invoice Lifecycle service](https://developer-api.cash-in.com/invoice-lifecycle-service-362789m0.md): - Resources [Debt Collection service](https://developer-api.cash-in.com/debt-collection-service-362790m0.md): - Resources [Debt Collection process](https://developer-api.cash-in.com/debt-collection-process-362792m0.md): - Resources [Confirma Software Partner services](https://developer-api.cash-in.com/confirma-software-partner-services-362791m0.md): - Authorization [Authentication and authorization of the user](https://developer-api.cash-in.com/authentication-and-authorization-of-the-user-362732m0.md): - [Collection & Payment Control](https://developer-api.cash-in.com/collection-payment-control-520465f0.md): - [Confirma Software Partners](https://developer-api.cash-in.com/confirma-software-partners-520469f0.md): ## API Docs - Authorization [Validate token](https://developer-api.cash-in.com/validate-token-4156741e0.md): Validate your access token with this endpoint - add the current token to the header as X-Api-Key - Authorization [Renew token](https://developer-api.cash-in.com/renew-token-4156742e0.md): You can renew your access token with this endpoint. Enter your customer code and your public IP address to validate the request. - Collection & Payment Control [Create Collection Cases](https://developer-api.cash-in.com/create-collection-cases-4156730e0.md): This API endpoint is for the Creditor to create new collection cases for outstanding receivables. - Collection & Payment Control [Update Collection Receivables](https://developer-api.cash-in.com/update-collection-receivables-4156728e0.md): This API Endpoint is for the Creditor to update debt collection receivables information. - Collection & Payment Control [Retrieve Collection Receivables Status](https://developer-api.cash-in.com/retrieve-collection-receivables-status-4156729e0.md): Check the status of the collection receivables with given batch identifier - Collection & Payment Control [Retrieve Case Batch Status](https://developer-api.cash-in.com/retrieve-case-batch-status-4156731e0.md): Check the status of the collection cases with given batch Identifier - Collection & Payment Control [Retrieve collection case](https://developer-api.cash-in.com/retrieve-collection-case-4156732e0.md): This API endpoint is for the Creditor to inquire collection case identifiers for the collection receivables (invoice number and reference). Data returned contains collection case id, status, outstanding capital amount and latest payment date for the invoice. - Collection & Payment Control [Retrieve debtor summary](https://developer-api.cash-in.com/retrieve-debtor-summary-4156733e0.md): Get a summary of the collection cases per debtor. - Collection & Payment Control [Retrieve list of settlements](https://developer-api.cash-in.com/retrieve-list-of-settlements-4156736e0.md): Get a list of settlements. List contains all settlement numbers. - Collection & Payment Control [Retrieve settlement data](https://developer-api.cash-in.com/retrieve-settlement-data-4156734e0.md): This API endpoint is for the Creditor to download debt collection settlements from Cash-In Collection. - Collection & Payment Control [Retrieve list of direct settlements](https://developer-api.cash-in.com/retrieve-list-of-direct-settlements-4156737e0.md): This API Service is for the Creditor to download direct settlement numbers from Cash-In Collection. - Collection & Payment Control [Retrieve direct settlement data](https://developer-api.cash-in.com/retrieve-direct-settlement-data-4156738e0.md): Fetch single direct settlement data payload. Contains the data of the given settlement number. - Collection & Payment Control [Retrieve Credit Loss Receivables](https://developer-api.cash-in.com/retrieve-credit-loss-receivables-4156739e0.md): This API endpoint is for the Creditor to retrieve debt collection credit loss receivables from Cash-In Collection Agency. Payload contains accounting information related to receivables that have been marked as Credit Loss by the Debt Collection. Credit Loss declarations are generated by Cash-In Debt Collection at the end of each calendar month, and are available for download at the first weekday of each month. - Invoice Intermediation > Invoice Service [Create an invoice](https://developer-api.cash-in.com/create-an-invoice-4156743e0.md): Post an payload containing one or many sales invoices to create them in Cash-In Invoice Service. - Invoice Intermediation > Invoice Service [Create batch of invoices](https://developer-api.cash-in.com/create-batch-of-invoices-4156744e0.md): Post of an batch of sales invoices. - Invoice Intermediation > Invoice Service [Create an invoice with seller information](https://developer-api.cash-in.com/create-an-invoice-with-seller-information-4156745e0.md): This API endpoint is for the authenticated Intermediation Seller to generate new sales invoice with seller information attached per invoice. - Invoice Intermediation > Invoice Service [List all sales invoices](https://developer-api.cash-in.com/list-all-sales-invoices-4156766e0.md): Lists all sales invoices for the authenticated client account. - Invoice Intermediation > Invoice Service [Retrieve invoice delivery information](https://developer-api.cash-in.com/retrieve-invoice-delivery-information-4156746e0.md): This API Service is for the Creditor / Seller to download invoice delivery information from Cash-In Intermediator Services. Invoice Delivery Info payload contains all information related to delivery of the invoice. - Invoice Intermediation > Invoice Service [Retrieve invoice status](https://developer-api.cash-in.com/retrieve-invoice-status-4156747e0.md): This API Service endpoint is for the Creditor / Seller to get invoice status related to Payment Control transfer. - Invoice Intermediation > Invoice Service [Update an invoice](https://developer-api.cash-in.com/update-an-invoice-4156748e0.md): This API endpoint is for the Creditor / Seller to update invoice related details to the Cash-In Intermediator Services. Please keep in mind that the invoice can only be updated if it has not yet been delivered to the end-customer or it has resulted in failure. - Invoice Intermediation > Invoice Service [Submit payment for an invoice](https://developer-api.cash-in.com/submit-payment-for-an-invoice-4156749e0.md): This API endpoint is for the Creditor / Seller to post invoice related received payment to invoice. Payment deducts the total account receivables amount of the invoice. Payment is considered as a partial payment if the payment amount is less than the the total amount of the invoice - Invoice Intermediation > Invoice Service [Retrieve delivery statistics](https://developer-api.cash-in.com/retrieve-delivery-statistics-4156750e0.md): This API endpoint is for the Creditor / Seller to get invoice delivery statistics data from a specific timeperiod. Returns the invoice qty, sum of total amount grouped by delivery type and invoice date. - Invoice Intermediation > Invoice Service [Retrieve received payments](https://developer-api.cash-in.com/retrieve-received-payments-4156751e0.md): This API endpoint returns a list of incoming payment transactions to the creditor outstanding invoices in Cash-In Payment Control. This is however not the FINAL status of the payment, but a list of transactions that have been received to the payment control from debtors. - Invoice Intermediation > Invoice Service [Submit update to Finvoice Account](https://developer-api.cash-in.com/submit-update-to-finvoice-account-4156752e0.md): This API endpoint updates the end customers Finvoice account details in the Cash-In Intermediator Services. If the the Finvoice account is not found for the sales account, it will be created -- and set as the default delivery method for the customer. - Invoice Intermediation > Invoice Service [Retrieve electronic invoicing contracts](https://developer-api.cash-in.com/retrieve-electronic-invoicing-contracts-4156758e0.md): This API endpoint is for the authenticated Cash-In Intermediator to fetch electronic invoicing details from registry. - Invoice Intermediation > Product Management [List all products](https://developer-api.cash-in.com/list-all-products-4156759e0.md): This API Service is for the Creditor / Seller to download product registry from Cash-In Intermediator Services. - Invoice Intermediation > Product Management [Submit new products](https://developer-api.cash-in.com/submit-new-products-4156760e0.md): This API Service is for the Creditor / Seller to import new products into their product registry from third party or their own registry. - Invoice Intermediation > Product Management [Delete an product](https://developer-api.cash-in.com/delete-an-product-4156761e0.md): This API Service is for the Creditor / Seller to delete product from registry. Notice! Product that has statistics or is in use should not be deleted but it can be done via API. - Invoice Intermediation > Customer Management [List all customers](https://developer-api.cash-in.com/list-all-customers-4156762e0.md): This API Service is for the Creditor / Seller to download customer registry from Cash-In Invoice Service. - Invoice Intermediation > Customer Management [Submit new customers](https://developer-api.cash-in.com/submit-new-customers-4156763e0.md): This API Service is for the Creditor / Seller to import new end customers into their customer registry from third party or their own registry - Invoice Intermediation > Customer Management [Update an customer](https://developer-api.cash-in.com/update-an-customer-4156764e0.md): This API Service is for the Creditor / Seller to update an existing customer in their customer registry. - Invoice Intermediation > Customer Management [Delete an customer](https://developer-api.cash-in.com/delete-an-customer-4156765e0.md): This API Service is for the Creditor / Seller to delete customer from registry. - Invoice Intermediation > External invoices [Retrieve delivery information](https://developer-api.cash-in.com/retrieve-delivery-information-4156753e0.md): This API Service is for the Intermediation Invoice Creditor / Seller to download a list of intermediation delivery information + invoice rows. - Invoice Intermediation > External invoices [Retrieve payment information](https://developer-api.cash-in.com/retrieve-payment-information-4156754e0.md): This API Service is for the Creditor / Seller to download a list of payments (external system) from Cash-In Intermediator Services. - Invoice Intermediation > External invoices [Create an direct payment](https://developer-api.cash-in.com/create-an-direct-payment-4156755e0.md): This API Service is for the Intermediation Invoice Creditor / Seller to send invoice direct payments messages to target system, by notifiying the payment details like date and type of the payment - Invoice Intermediation > External invoices [Submit an invoice action](https://developer-api.cash-in.com/submit-an-invoice-action-4156756e0.md): This API Service is for the Intermediation Invoice Creditor / Seller to send invoice related messages to target system - Invoice Intermediation > External invoices [Retrieve status of the agreement](https://developer-api.cash-in.com/retrieve-status-of-the-agreement-4156757e0.md): This API Service endpoint is for the external intermediation Invoice Creditor / Seller to get the agreement contract status from Cash-In Intermediator Services. - Confirma Software Partners [Submit new creditor](https://developer-api.cash-in.com/submit-new-creditor-4156767e0.md): This API endpoint creates a new creditor into Cash-In agency. Use your partner master key as the access token. - Confirma Software Partners [Update creditor](https://developer-api.cash-in.com/update-creditor-4156768e0.md): Update the creditor details like address, phone number, email etc. - Confirma Software Partners [Retrieve creditor credentials](https://developer-api.cash-in.com/retrieve-creditor-credentials-4156769e0.md): Search Creditor Details from the Cash-In Creditor Registry by Business Code. - Confirma Software Partners [Retrieve External Agreement Identifiers](https://developer-api.cash-in.com/retrieve-external-agreement-identifiers-4156770e0.md): This API endpoint allows the partner to retrieve the external agreement Identifiers for specific customer. - Confirma Software Partners [Retrieve invoice delivery information by seller](https://developer-api.cash-in.com/retrieve-invoice-delivery-information-by-seller-4156771e0.md): This API endpoint returns invoice delivery information regarding a specific seller. - Confirma Software Partners [Send SMS message](https://developer-api.cash-in.com/send-sms-message-4156772e0.md): This API endpoint sends text message to given phone number. The SMS service provided by LinkMobility. - Document Print Service [Create meter reading documents](https://developer-api.cash-in.com/create-meter-reading-documents-4156740e0.md): This API Endpoint is for the Creditor to create and send meter reading documents to customers. ## Schemas - [BatchDataResponse](https://developer-api.cash-in.com/batchdataresponse-776852d0.md): - [BatchInvoices](https://developer-api.cash-in.com/batchinvoices-776853d0.md): - [BatchInvoicesList](https://developer-api.cash-in.com/batchinvoiceslist-776854d0.md): - [BatchStatus](https://developer-api.cash-in.com/batchstatus-776855d0.md): - [Case](https://developer-api.cash-in.com/case-776856d0.md): - [CaseInvoiceExtended](https://developer-api.cash-in.com/caseinvoiceextended-776857d0.md): - [CaseList](https://developer-api.cash-in.com/caselist-776858d0.md): - [CaseSummary](https://developer-api.cash-in.com/casesummary-776859d0.md): - [CollectionResponse](https://developer-api.cash-in.com/collectionresponse-776860d0.md): - [ContactPerson](https://developer-api.cash-in.com/contactperson-776861d0.md): - [CreditLossReceivable](https://developer-api.cash-in.com/creditlossreceivable-776862d0.md): - [Creditor](https://developer-api.cash-in.com/creditor-776863d0.md): - [CreditorData](https://developer-api.cash-in.com/creditordata-776864d0.md): - [CreditorDetails](https://developer-api.cash-in.com/creditordetails-776865d0.md): - [CreditorIdentifiers](https://developer-api.cash-in.com/creditoridentifiers-776866d0.md): - [CreditorResponse](https://developer-api.cash-in.com/creditorresponse-776867d0.md): - [CreditorUpdateData](https://developer-api.cash-in.com/creditorupdatedata-776868d0.md): - [CreditorUpdateDetails](https://developer-api.cash-in.com/creditorupdatedetails-776869d0.md): - [CreditorUpdateResponse](https://developer-api.cash-in.com/creditorupdateresponse-776870d0.md): - [CustomParameters](https://developer-api.cash-in.com/customparameters-776871d0.md): - [Debtor](https://developer-api.cash-in.com/debtor-776872d0.md): - [DirectSettlementList](https://developer-api.cash-in.com/directsettlementlist-776873d0.md): - [DirectSettlementRows](https://developer-api.cash-in.com/directsettlementrows-776874d0.md): - [DirectSettlements](https://developer-api.cash-in.com/directsettlements-776875d0.md): - [DocumentCustomer](https://developer-api.cash-in.com/documentcustomer-776876d0.md): - [DocumentResponse](https://developer-api.cash-in.com/documentresponse-776877d0.md): - [ElectronicInvoicingContracts](https://developer-api.cash-in.com/electronicinvoicingcontracts-776878d0.md): - [ErrorMessage](https://developer-api.cash-in.com/errormessage-776879d0.md): - [ExternalAgreementIdentifiers](https://developer-api.cash-in.com/externalagreementidentifiers-776880d0.md): - [ExternalAgreementStatusResponse](https://developer-api.cash-in.com/externalagreementstatusresponse-776881d0.md): - [ExternalInvoice](https://developer-api.cash-in.com/externalinvoice-776882d0.md): - [ExternalInvoiceActions](https://developer-api.cash-in.com/externalinvoiceactions-776883d0.md): - [ExternalInvoiceRows](https://developer-api.cash-in.com/externalinvoicerows-776884d0.md): - [FinvoiceAccountUpdate](https://developer-api.cash-in.com/finvoiceaccountupdate-776885d0.md): - [FinvoiceAccountUpdateResponse](https://developer-api.cash-in.com/finvoiceaccountupdateresponse-776886d0.md): - [IntegrationsAccountingLedgerData](https://developer-api.cash-in.com/integrationsaccountingledgerdata-776887d0.md): - [IntermediationInvoiceDirectPaymentResponse](https://developer-api.cash-in.com/intermediationinvoicedirectpaymentresponse-776888d0.md): - [IntermediationInvoiceDirectPayments](https://developer-api.cash-in.com/intermediationinvoicedirectpayments-776889d0.md): - [IntermediatorInvoice](https://developer-api.cash-in.com/intermediatorinvoice-776890d0.md): - [Invoice](https://developer-api.cash-in.com/invoice-776891d0.md): - [InvoiceActionResponse](https://developer-api.cash-in.com/invoiceactionresponse-776892d0.md): - [InvoicePaymentsResponse](https://developer-api.cash-in.com/invoicepaymentsresponse-776893d0.md): - [InvoicesDeliveryInformation](https://developer-api.cash-in.com/invoicesdeliveryinformation-776894d0.md): - [LedgerRowDimensions](https://developer-api.cash-in.com/ledgerrowdimensions-776895d0.md): - [LedgerRows](https://developer-api.cash-in.com/ledgerrows-776896d0.md): - [Ledgers](https://developer-api.cash-in.com/ledgers-776897d0.md): - [Messages](https://developer-api.cash-in.com/messages-776898d0.md): - [MeterCompany](https://developer-api.cash-in.com/metercompany-776899d0.md): - [MeterDocument](https://developer-api.cash-in.com/meterdocument-776900d0.md): - [MeterDocumentList](https://developer-api.cash-in.com/meterdocumentlist-776901d0.md): - [MeterReading](https://developer-api.cash-in.com/meterreading-776902d0.md): - [MeterUsageLocation](https://developer-api.cash-in.com/meterusagelocation-776903d0.md): - [NxsReceivedPayments](https://developer-api.cash-in.com/nxsreceivedpayments-776904d0.md): - [OnlineCustomer](https://developer-api.cash-in.com/onlinecustomer-776905d0.md): - [OnlineCustomerResponse](https://developer-api.cash-in.com/onlinecustomerresponse-776906d0.md): - [OnlineCustomerUpdateResponse](https://developer-api.cash-in.com/onlinecustomerupdateresponse-776907d0.md): - [OnlineInvoicePaymentControl](https://developer-api.cash-in.com/onlineinvoicepaymentcontrol-776908d0.md): - [OnlineProduct](https://developer-api.cash-in.com/onlineproduct-776909d0.md): - [OnlineSalesInvoices](https://developer-api.cash-in.com/onlinesalesinvoices-776910d0.md): - [PagedSalesInvoicesResponse](https://developer-api.cash-in.com/pagedsalesinvoicesresponse-776911d0.md): - [Payment](https://developer-api.cash-in.com/payment-776912d0.md): - [Receivable](https://developer-api.cash-in.com/receivable-776913d0.md): - [ReceivablesList](https://developer-api.cash-in.com/receivableslist-776914d0.md): - [ReceivedPaymentRows](https://developer-api.cash-in.com/receivedpaymentrows-776915d0.md): - [ReceivedPayments](https://developer-api.cash-in.com/receivedpayments-776916d0.md): - [ReceivedPaymentsResponse](https://developer-api.cash-in.com/receivedpaymentsresponse-776917d0.md): - [RenewResponse](https://developer-api.cash-in.com/renewresponse-776918d0.md): - [SalesAddressDTO](https://developer-api.cash-in.com/salesaddressdto-776919d0.md): - [SalesInvoice](https://developer-api.cash-in.com/salesinvoice-776920d0.md): - [SalesInvoiceBatchResponse](https://developer-api.cash-in.com/salesinvoicebatchresponse-776921d0.md): - [SalesInvoicePayment](https://developer-api.cash-in.com/salesinvoicepayment-776922d0.md): - [SalesInvoiceResponse](https://developer-api.cash-in.com/salesinvoiceresponse-776923d0.md): - [SalesInvoiceRow](https://developer-api.cash-in.com/salesinvoicerow-776924d0.md): - [SalesInvoiceUpdate](https://developer-api.cash-in.com/salesinvoiceupdate-776925d0.md): - [SalesInvoiceUpdateResponse](https://developer-api.cash-in.com/salesinvoiceupdateresponse-776926d0.md): - [SalesInvoiceWithSellerInfoDTO](https://developer-api.cash-in.com/salesinvoicewithsellerinfodto-776927d0.md): - [SalesItemResponse](https://developer-api.cash-in.com/salesitemresponse-776928d0.md): - [SalesItems](https://developer-api.cash-in.com/salesitems-776929d0.md): - [SellerInfoDTO](https://developer-api.cash-in.com/sellerinfodto-776930d0.md): - [Settlement](https://developer-api.cash-in.com/settlement-776931d0.md): - [SettlementList](https://developer-api.cash-in.com/settlementlist-776932d0.md): - [SettlementRows](https://developer-api.cash-in.com/settlementrows-776933d0.md): - [SmsData](https://developer-api.cash-in.com/smsdata-776934d0.md): - [SmsDeliveryReport](https://developer-api.cash-in.com/smsdeliveryreport-776935d0.md): - [SmsResponse](https://developer-api.cash-in.com/smsresponse-776936d0.md): - [ValidationResponse](https://developer-api.cash-in.com/validationresponse-776937d0.md): - [ViewOnlineInvoiceDeliveryStats](https://developer-api.cash-in.com/viewonlineinvoicedeliverystats-776938d0.md):