Submit payment for an invoice

POST

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

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

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

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

Body Params application/json

Examples

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.cash-in.com/v2/postinvoicepayment' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "InvoiceNumber": 0,
    "PaymentGuid": "string",
    "PaymentDate": "2019-08-24T14:15:22.123Z",
    "PaymentCurrency": "string",
    "PaymentAmount": -999999999999999,
    "PaymentDescription": "string",
    "PointOfSalesName": "string"
}'

Response Example

200 - Example 1

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

Update an invoice

Retrieve delivery statistics