Update Payment

POST

https://app.hisabkitab.co/third-party/payment-transactions/{id}

These API enables users to modify an existing payment transaction, ensuring accurate financial records and proper payment tracking.

Request

This API uses a POST request, and the request body must contain the updated details of the payment transaction, such as the payment voucher number, amount, payment mode, and ledger information. The request URL includes the unique ID of the payment transaction that needs to be updated.

Response

Upon a successful update, the API returns the modified payment details along with a success message, confirming that the payment transaction has been updated successfully.

Request

Authorization

Add parameter in header

ApiKey

Example:

ApiKey: ********************

Path Params

integer

required

It will be the ID of the payment transaction you want to update.

Example:

Body Params multipart/form-data

payment_voucher_number

string

required

A unique identifier is assigned to each payment transaction. This number ensures that each payment has a distinct record in the system.

Example:

date

string

required

The date on which the payment transaction is recorded, formatted as DD-MM-YYYY.

Example:

13-02-2025

bank_cash_ledger_id

integer

required

A unique identifier for the bank or cash ledger from which the payment is being made. This helps categorize the payment as coming from a bank account, petty cash, or any other source.

Example:

total_paid_amount

number

required

The total sum of all payments made in this transaction, covering multiple invoices or bills.

Example:

11771.00

ledger_id

integer

required

The unique identifier of the party (vendor/supplier) receiving the payment.

Example:

narration

string

optional

A brief textual description of the payment transaction. It helps provide context for why the payment was made.

is_manage_transaction

boolean

optional

A flag (0 or 1) indicating whether the system should automatically allocate payments to invoices based on outstanding amounts.

Example:

payment_mode

integer

optional

Specifies the method used for payment, such as cash, bank transfer, or online transaction.

Example:

pc_transaction_item_id[]

array[string]

optional

Example:

transaction_id[]

array[string]

optional

A list of unique transaction IDs linking this payment to specific invoices. Each ID represents a separate financial transaction.

Example:

invoice_number[]

array[string]

optional

A list of invoice numbers associated with the payment. This helps track which invoices are being settled with the current transaction.

Example:

bill_type[]

array[string]

optional

Indicates the type of bill or transaction being settled, where: 1 = Purchase, 2 = Sale Return, 3 = income credit note, 4 = expense credit note, and 5 = Receipt Transaction. This categorization helps in accurately classifying financial transactions within the accounting system.

Example:

paid_amount[]

array[string]

optional

The specific amount paid for each respective invoice or bill.

Example:

11771.00

discount_amount[]

array[string]

optional

The discount applied to the payment for each invoice. If no discount is applied, the value remains "0".

Example:

rounding_amount[]

array[string]

optional

The rounding adjustment applied to the payment to maintain accuracy in financial calculations.

Example:

upload_receipt_invoice

file

optional

The field is used to attach a digital copy of the payment invoice as proof of the transaction.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/payment-transactions/1' \
--header 'ApiKey;' \
--form 'payment_voucher_number="3"' \
--form 'date="13-02-2025"' \
--form 'bank_cash_ledger_id="4"' \
--form 'total_paid_amount="11771.00"' \
--form 'ledger_id="2"' \
--form 'narration=""' \
--form 'is_manage_transaction="1"' \
--form 'payment_mode="2"' \
--form 'pc_transaction_item_id[]="9"' \
--form 'transaction_id[]="6"' \
--form 'invoice_number[]="8"' \
--form 'bill_type[]="1"' \
--form 'paid_amount[]="11771.00"' \
--form 'discount_amount[]="0"' \
--form 'rounding_amount[]="0"' \
--form 'upload_receipt_invoice=@""'

Responses

🟢200Update Payment

application/json

Body

data

object

required

integer

required

A unique ID assigned to each payment transaction to differentiate it from others.

company_id

integer

required

The ID of the company making the payment helps to associate transactions with specific business entities.

date

string

required

The date when the payment transaction was recorded.

payment_voucher_number

string

required

The reference number assigned to the payment transaction, often formatted with a prefix to indicate the type of transaction (e.g., "sale/25128").

is_default_created_by_transaction

boolean

required

A flag that indicates whether this payment was auto-generated as part of another transaction, such as a sale or purchase.

bank_cash_ledger_id

string

required

The ID of the bank or cash ledger from which the payment was made.

ledger_id

string

required

The ID of the party ledger (customer, vendor, or account) associated with the receipt transaction.

total_paid_amount

number

required

The total amount paid in the transaction.

narration

string

required

An optional field that stores additional notes or descriptions related to the transaction.

is_manage_transaction

boolean

required

The field is a boolean value that indicates whether the payment transaction is directly associated with invoice settlement.

payment_mode

string

required

Indicates how the payment was received, such as Cash, Bank Transfer, Cheque, or Digital Payment.

reference_number

string

required

Stores a reference number for transactions involving bank transfers, UPI, or cheques.

via_api

boolean

required

is_import

boolean

required

created_by

integer

required

A unique identifier of the user who created the transaction.

created_at

string

required

The date and time indicating when the record was initially created in the system,

updated_at

string

required

The date and time indicating when the record was last modified or updated in the system.

deleted_by

integer

required

This field records the ID of the user who deleted the transaction.

deleted_at

string

required

Stores the date and time when the transaction was deleted.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 1,
        "company_id": 6,
        "date": "2025-02-12T18:30:00.000000Z",
        "payment_voucher_number": "3",
        "is_default_created_by_transaction": false,
        "bank_cash_ledger_id": "4",
        "ledger_id": "2",
        "total_paid_amount": "11771.00",
        "narration": null,
        "is_manage_transaction": true,
        "payment_mode": "2",
        "reference_number": null,
        "via_api": true,
        "is_import": 0,
        "created_by": 8,
        "created_at": "2025-02-13T10:30:43.000000Z",
        "updated_at": "2025-02-13T10:43:29.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Payment Transaction updated successfully"
}

Modified at 2025-04-03 10:23:37

Edit Payment

Delete Payment

Update Payment

Request#

Response#

Request

Request samples

Responses

Request

Response