1. Partner endpoints
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
      POST
    • Update creditor
      POST
    • Retrieve Creditor Credentials
      GET
    • Retrieve Finvoice Credentials
      GET
    • Retrieve External Agreement Identifiers
      GET
    • Retrieve invoice delivery information by seller
      GET
    • Send SMS message
      POST
  • 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?
  1. Partner endpoints

Submit new creditor

POST
https://api.cash-in.com/v2/newcreditor
This API endpoint creates a new creditor in the Cash-In agency system.
The submitted creditor data must include the Partner Code and integration service code for evaluation and processing.
Partner Access Control
Use your Partner-level API key in the X-Api-Key header.

Request

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

Examples

Responses

🟢200
application/json
New creditor created
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.cash-in.com/v2/newcreditor' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Creditor": {
        "Creditor_Details": {
            "Creditor_Business_Code": "123456-7",
            "Creditor_Department_Code": "string",
            "Creditor_VATRegNbr": "FI1234567",
            "Creditor_Name1": "Company Official Name",
            "Creditor_Name2": null,
            "Creditor_Type": "Y",
            "Creditor_Language_Code": "S",
            "Creditor_Company_Type": "2",
            "Creditor_Country_Code": "FIN",
            "Creditor_Telephone": "0400400400",
            "Creditor_Email_Address": "contact@company.com",
            "Creditor_Website": null,
            "Creditor_Visiting_Address": "Testaajankatu 1",
            "Creditor_Postal_Address": "Testaajankatu 1",
            "Creditor_Postal_Code": "00100",
            "Creditor_Postal_District": "HELSINKI",
            "Creditor_IBAN": "FI1410093000123458",
            "Creditor_BIC": "NDEAFIHH",
            "Creditor_Bankgiro": "string",
            "Creditor_Plusgiro": "string",
            "Billing_Postal_Address": "Testaajankatu 1",
            "Billing_Postal_Code": "00100",
            "Billing_Postal_District": "HELSINKI",
            "Billing_Country_Code": "FIN",
            "Partner_Code": null,
            "Partner_Name": null,
            "Integration_Service_Code": 0
        },
        "Contact_Persons": [
            {
                "Name": "Anna Malli",
                "Position": "Consultant",
                "Title": null,
                "Telephone": "06-1111111",
                "Mobile": "0400400400",
                "Email_Address": "Anna.Malli@mail.com",
                "Activate_Creditor_Letter": "E",
                "Country_Code": "FIN"
            }
        ]
    }
}'
Response Response Example
200 - Example 1
{
    "StatusDescription": "string",
    "CustomerCode": "string",
    "LicenceCode": "string",
    "ApiKey": "string",
    "UpdateUrl": "string"
}
Previous
Partner endpoints
Next
Update creditor
Built with