Payment Updates in Invoices

Add Payment to Invoice

post /businesses/:urlKey/invoices/:invoice/payments

This endpoint allows the you to add a payment to a specific invoice for a business.

Request

Path Params

urlKey - will be provided by us
invoice - unique ID of the invoice.

Headers

Name	Type	Value Description
Content-Type *	string	application-json
Authorization *	string	Bearer <jwt>

Body

Name	Type	Value Description
tds	number	The TDS (Tax Deducted at Source) amount for the payment.
transactionCharge	number	The transaction charge for the payment.
amount	number	The amount of the payment.
paymentDate	string	The date of the payment.
paymentMethod	string (enum)	The method used for the payment: ACCOUNT_TRANSFER -> Account Transfer CASH -> Cash CHEQUE -> Cheque CREDIT_CARD -> Credit Card DEBIT_CARD -> Debit Card DD -> Demand Draft UPI -> UPI .
notes	string	Any additional notes for the payment.
refId	string	Reference ID for the payment.

Response

201: Created

Payment successfully added.

{
  "tds": 0,
  "transactionCharge": 0,
  "amount": 3000,
  "paymentDate": "2024-08-18T12:08:38.000Z",
  "paymentMethod": "CHEQUE",
  "notes": "Payment for invoice #123",
  "business": "60cc8cc6aa3024abd4bef997",
  "payerBusiness": "60aa8hf6aa3024abd4bef447",
  "isApproved": true,
  "isRemoved": false,
  "appId": "60cc8cc6aa3024abd4bej98k",
  "_id": "60cc8cc6ps9024abd4bej98k"
}

401: Unauthorized

Invalid authentication.

{
  "name": "NotAuthenticated",
  "message": "Invalid login",
  "code": 401,
  "className": "not-authenticated",
  "data": {
    "message": "Invalid login"
  },
  "errors": {}
}

---

Get Payments on Invoice

get /businesses/:urlKey/invoices/:invoice/payments

This endpoint retrieves the payments associated with a specific invoice for a business.

Request

Path Params

urlKey - The unique identifier of the business.
invoice - The invoice ID for which the payments are being retrieved.

Headers

Name	Type	Value Description
Content-Type *	string	application-json
Authorization *	string	Bearer <jwt>

Response

200: OK

The response will include the details of the payments made towards the specified invoice.

{
  "payments": [
    {
      "tds": 0,
      "transactionCharge": 0,
      "amount": 1000,
      "paymentDate": "2023-10-01",
      "paymentMethod": "CREDIT_CARD",
      "notes": "Payment for invoice #123",
      "business": "60cc8cc6aa3024abd4bef997",
      "payerBusiness": "60aa8hf6aa3024abd4bef447",
      "isApproved": true,
      "isRemoved": false,
      "appId": "60cc8cc6aa3024abd4bej98k",
      "_id": "60cc8cc6ps9024abd4bej98k"
    }
  ]
}

401: Unauthorized

Invalid authentication.

{
  "name": "NotAuthenticated",
  "message": "Invalid login",
  "code": 401,
  "className": "not-authenticated",
  "data": {
    "message": "Invalid login"
  },
  "errors": {}
}