Create meter reading documents

POST

https://api.cash-in.com/v2/meterreadings

This API Endpoint is for the Creditor to create and send meter reading documents to customers.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Body Params application/json

Examples

Responses

🟢202

application/json

Data saved

Body

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.cash-in.com/v2/meterreadings' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Documents": [
        {
            "Customer": {
                "CustomerName": "string",
                "CustomerIdentifier": "string",
                "CustomerNameExtension": "string",
                "Address": "string",
                "City": "string",
                "PostalCode": "string",
                "LangCode": 1,
                "CustomerEmailAddress": "string",
                "CustomerDeliveryMethod": 0
            },
            "UsageLocation": {
                "UniqueIdentifier": "string",
                "Address": "string",
                "City": "string",
                "PostalCode": "string",
                "ConsumptionEstimation": 0
            },
            "Meter": {
                "UniqueIdentifier": "string",
                "Reading": 0,
                "ReadingDate": "string"
            },
            "Company": {
                "Name": "string",
                "Address": "string",
                "City": "string",
                "PostalCode": "string",
                "Phone": "string",
                "InfoText": "string",
                "PostalText": "string",
                "ReturnDate": "string"
            }
        }
    ]
}'

Response Example

202 - Example 1

{
    "Message": "string",
    "CountOfDocuments": 0
}

Send SMS message

BatchDataResponse