Update Receipt

POST

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

The Update Receipt API allows users to update an existing receipt transaction by providing the transaction ID and the new details that need to be updated.

Request

The request is a POST method, and the body must contain the updated details of the receipt transaction. The ID of the receipt should be included in the URL, indicating which transaction is to be updated.

Response

The API will return the details of the updated receipt transaction, confirming that the changes have been successfully applied. The response will include the updated transaction details.

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Path Params

integer

required

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

Example:

Body Params multipart/form-data

date

string

required

The date on which the receipt transaction is created. The format is DD-MM-YYYY.

Example:

13-02-2025

receipt_number

string

required

A unique identifier assigned to the receipt for tracking purposes. The value indicates that this is the 9th receipt issued in the system. It helps in referencing transactions efficiently.

Example:

bank_cash_ledger_id

integer

required

The unique identifier for the bank or cash ledger where the received payment is recorded.

Example:

ledger_id

integer

required

The unique identifier of the customer or party ledger from whom the payment is received.

Example:

total_received_amount

number

required

The total amount received from the customer across multiple invoices. The value represents the sum of all payments recorded in this receipt transaction.

Example:

55388.00

is_manage_transaction

boolean

optional

A flag (1 or 0) indicating whether transaction management is enabled. The value "1" means that the system will handle and allocate payments automatically based on the provided details.

Example:

payment_mode

integer

optional

Specifies the mode of payment used in the transaction. The value represents a particular payment method (e.g., cash, bank transfer, or cheque), as defined in the system.

Example:

transaction_id[]

array[string]

optional

A list of unique transaction identifiers corresponding to the invoices being settled. Each transaction ID links the receipt to a specific invoice payment.

Example:

["8","2","5","6"]

rc_transaction_item_id

array[string]

optional

Example:

["1","2","3","4"]

invoice_number[]

array[string]

optional

A list of invoice numbers associated with the transactions. Each invoice number corresponds to a bill that is being paid with this receipt.

Example:

["82023-24","22023-24","22023-24","3"]

bill_type[]

array[string]

optional

Indicates the type of bill or transaction being settled, where: 1 = Sale, 2 = Income Debit Note, 3 = Payment, 4 = Purchase Return, and 5 = Expense Debit Note. This categorization helps in accurately classifying financial transactions within the accounting system.

Example:

["1","1","1","3"]

received_amount[]

array[string]

optional

The amount received for each respective invoice as part of the payment transaction. This value represents the portion of the total due amount paid by the customer for a specific invoice, which is included in the total received amount.

Example:

["263.00","5000.00","100.00","50000.00"]

discount_amount[]

array[string]

optional

Any discount applied to the invoice payment. The value "0" means no discount was given. If a discount were applied, the value would reflect the reduced amount.

Example:

["0","0","0","0"]

rounding_amount[]

array[string]

optional

The rounding adjustment made to the received amount for calculation accuracy. The value "0" means no rounding adjustment was needed.

Example:

["0","0","0","0"]

narration

string

optional

A short note or description explaining the receipt transaction.

Example:

A receipt is a written acknowledgment issued by a seller upon purchasing goods or services.

upload_receipt_invoice

file

optional

These field is used to upload and associate a receipt or invoice document with the transaction.

submit_button_value

string

optional

Defines the action of the button used for submitting the form, where 1 means Save, 2 means Save & New, and 3 means Save & Print.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/receipt-transactions/1' \
--header 'ApiKey;' \
--form 'date="13-02-2025"' \
--form 'receipt_number="9"' \
--form 'bank_cash_ledger_id="3"' \
--form 'ledger_id="2"' \
--form 'total_received_amount="55388.00"' \
--form 'is_manage_transaction="1"' \
--form 'payment_mode="2"' \
--form 'transaction_id[]="8"' \
--form 'transaction_id[]="2"' \
--form 'transaction_id[]="5"' \
--form 'transaction_id[]="6"' \
--form 'rc_transaction_item_id="1"' \
--form 'rc_transaction_item_id="2"' \
--form 'rc_transaction_item_id="3"' \
--form 'rc_transaction_item_id="4"' \
--form 'invoice_number[]="82023-24"' \
--form 'invoice_number[]="22023-24"' \
--form 'invoice_number[]="22023-24"' \
--form 'invoice_number[]="3"' \
--form 'bill_type[]="1"' \
--form 'bill_type[]="1"' \
--form 'bill_type[]="1"' \
--form 'bill_type[]="3"' \
--form 'received_amount[]="263.00"' \
--form 'received_amount[]="5000.00"' \
--form 'received_amount[]="100.00"' \
--form 'received_amount[]="50000.00"' \
--form 'discount_amount[]="0"' \
--form 'discount_amount[]="0"' \
--form 'discount_amount[]="0"' \
--form 'discount_amount[]="0"' \
--form 'rounding_amount[]="0"' \
--form 'rounding_amount[]="0"' \
--form 'rounding_amount[]="0"' \
--form 'rounding_amount[]="0"' \
--form 'narration="A receipt is a written acknowledgment issued by a seller upon purchasing goods or services."' \
--form 'upload_receipt_invoice=@""' \
--form 'submit_button_value="1"'

Responses

🟢200Update Receipt

application/json

Body

data

object

required

integer

required

A unique identifier for the receipt transaction, used to distinguish it from other transactions.

company_id

integer

required

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

date

string

required

The date when the receipt transaction was created, recorded in DD-MM-YYYY format.

receipt_number

string

required

The field represents the unique identifier assigned to a receipt transaction.

is_default_created_by_transaction

boolean

required

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

bank_cash_ledger_id

string

required

Specifies the payment source, indicating whether the amount was received in cash or through a bank account.

ledger_id

string

required

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

total_received_amount

number

required

The total amount received in this transaction, representing incoming funds recorded in the financial records.

narration

string

required

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

is_manage_transaction

boolean

required

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

payment_mode

string

required

The field specifies the ID of the method used to receive the payment in the receipt transaction.

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": 5,
        "company_id": 6,
        "date": "2025-02-12T18:30:00.000000Z",
        "receipt_number": "9",
        "is_default_created_by_transaction": false,
        "bank_cash_ledger_id": "3",
        "ledger_id": "2",
        "total_received_amount": 55388,
        "narration": "A receipt is a written acknowledgment issued by a seller upon purchasing goods or services.",
        "is_manage_transaction": true,
        "payment_mode": "2",
        "reference_number": null,
        "via_api": true,
        "is_import": 0,
        "created_by": 8,
        "created_at": "2025-02-13T09:23:44.000000Z",
        "updated_at": "2025-02-13T09:28:47.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Receipt transaction updated successfully."
}

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

Edit Receipt

Delete Receipt

Update Receipt

Request#

Response#

Request

Request samples

Responses

Request

Response