Update Journal

POST

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

These API allows users to modify an existing journal transaction and requires the transaction ID in the URL to specify which journal transaction needs to be updated.

Request

The request is a POST method, and the request body must include the updated transaction details such as debit and credit ledger entries, invoice settlements, narration, and other relevant fields.

Response

The API returns a success message along with a confirmation flag indicating that the journal transaction details have been successfully updated.

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Path Params

integer

required

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

Example:

Body Params multipart/form-data

date

string

required

This field represents the date on which the journal transaction is recorded, formatted as DD-MM-YYYY.

Example:

13-02-2025

voucher_number

string

required

The voucher number is a unique identifier assigned to the journal transaction.

Example:

debit_credit_type[]

array[string]

optional

This field indicates whether the ledger transaction is a debit (1) or credit (2). Debit transactions generally represent expenses or asset additions, while credit transactions signify revenue or liability increases.

Example:

["1","2","2"]

debit_credit_type_id[]

array[string]

optional

This field holds the unique ID of debit or credit transactions that have been recorded in the journal entry using multiple ledgers.

Example:

["6634","6635"]

ledger_id[]

array[string]

optional

The ledger ID refers to the unique identifier assigned to each account involved in the transaction.

Example:

["2702","25718"]

amount[]

array[string]

optional

The amount[] field represents the value assigned by the user for each ledger in the transaction. It ensures that the total debit and credit amounts remain balanced(same).

Example:

["1500","1500"]

append_debit_id

string

optional

This field contains the unique identifier for the debit transaction that has been recorded using a specific ledger in the journal entry.

Example:

append_credit_id

string

optional

This field contains the unique identifier for the credit transaction that has been recorded using a specific ledger in the journal entry.

Example:

debit_total

number

optional

The total debit amount represents the sum of all debit transactions recorded in the journal entry.

Example:

85000

credit_total

number

optional

This field holds the total amount of credits in the journal entry, ensuring that it matches the corresponding debits.

Example:

85000

is_manage_credit_transaction[25718][]

array[string]

optional

This flag determines whether the system should auto-manage credit transactions.

Example:

cr_transaction_id[25718][]

array[string]

optional

This field represents the unique identifier for a credit transaction associated with the ledger ID in the journal transaction.

Example:

1697

credit_ledger_id[25718][]

array[string]

optional

The credit ledger ID (credit_ledger_id[ledger_id][]) represents the account that will receive the credit entry.

Example:

25718

credit_transaction_id[25718][]

array[string]

optional

A unique identifier assigned to each credit transaction.

Example:

12418

credit_invoice_number[25718][]

array[string]

optional

This field contains the invoice number linked to the credit transaction.

Example:

credit_bill_type[25718][]

array[string]

optional

This field specifies the type of bill that is being settled in the transaction. It helps categorize the financial entry based on its nature, such as sale, purchase return, payment, debit note, or credit note.

Example:

credit_received_amount[25718][]

array[string]

optional

The amount credited to an invoice as part of the transaction. It represents the portion of the total receivable amount that has been collected.

Example:

505

credit_discount_amount[25718][]

array[string]

optional

Any discount applied to the credit transaction is recorded in this field.

Example:

credit_rounding_amount[25718][]

array[string]

optional

This field stores any rounding adjustments applied to the credit transaction.

Example:

is_manage_credit_transaction[2702][]

string

optional

This flag determines whether the system should auto-manage credit transactions.

Example:

dr_transaction_id[2702][]

array[string]

optional

This field represents the unique identifier for a debit transaction associated with the ledger ID in the journal transaction.

Example:

["1477","1478"]

debit_ledger_id[2702][]

array[string]

optional

This debit_ledger_id[ledger_id][] specifies the ledger ID associated with each debit transaction. It ensures that the transaction is correctly linked to the appropriate account in the financial system.

Example:

["2702","2702"]

edit_transaction_id[2702][]

array[string]

optional

This field contains the ledger ID that has been added as either a debit or credit entry in the journal transaction.

Example:

["2702","2702"]

debit_transaction_id[2702][]

array[string]

optional

The transaction ID (debit_transaction_id[ledger_id][]) represents a unique identifier for each debit transaction.

Example:

["890","7503"]

debit_invoice_number[2702][]

array[string]

optional

This debit_invoice_number[ledger_id][] field contains the invoice number associated with a debit transaction.

Example:

["6","16"]

debit_bill_type[2702][]

array[string]

optional

The bill type determines the nature of the debit transaction, such as purchase invoices, expense notes, or other financial documents.

Example:

["1","1"]

debit_paid_amount[2702][]

array[string]

optional

This field represents the amount debited for a specific invoice. It is the portion of the total payable amount that has been settled.

Example:

["785","10642"]

debit_discount_amount[2702][]

array[string]

optional

If any discount is applied to a debit transaction, it is recorded in this field.

Example:

["0","0"]

debit_rounding_amount[2702][]

array[string]

optional

This field accounts for rounding adjustments applied to a debit transaction. Minor rounding differences occur due to currency conversions or decimal approximations.

Example:

["0","0"]

narration

string

optional

The field is used to provide a brief description of the journal 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/journal-transactions/1' \
--header 'ApiKey;' \
--form 'date="13-02-2025"' \
--form 'voucher_number="6"' \
--form 'debit_credit_type[]="1"' \
--form 'debit_credit_type[]="2"' \
--form 'debit_credit_type[]="2"' \
--form 'debit_credit_type_id[]="6634"' \
--form 'debit_credit_type_id[]="6635"' \
--form 'ledger_id[]="2702"' \
--form 'ledger_id[]="25718"' \
--form 'amount[]="1500"' \
--form 'amount[]="1500"' \
--form 'append_debit_id="1"' \
--form 'append_credit_id="2"' \
--form 'debit_total="85000"' \
--form 'credit_total="85000"' \
--form 'is_manage_credit_transaction[25718][]="1"' \
--form 'cr_transaction_id[25718][]="1697"' \
--form 'credit_ledger_id[25718][]="25718"' \
--form 'credit_transaction_id[25718][]="12418"' \
--form 'credit_invoice_number[25718][]="14"' \
--form 'credit_bill_type[25718][]="1"' \
--form 'credit_received_amount[25718][]="505"' \
--form 'credit_discount_amount[25718][]="0"' \
--form 'credit_rounding_amount[25718][]="0"' \
--form 'is_manage_credit_transaction[2702][]="1"' \
--form 'dr_transaction_id[2702][]="1477"' \
--form 'dr_transaction_id[2702][]="1478"' \
--form 'debit_ledger_id[2702][]="2702"' \
--form 'debit_ledger_id[2702][]="2702"' \
--form 'edit_transaction_id[2702][]="2702"' \
--form 'edit_transaction_id[2702][]="2702"' \
--form 'debit_transaction_id[2702][]="890"' \
--form 'debit_transaction_id[2702][]="7503"' \
--form 'debit_invoice_number[2702][]="6"' \
--form 'debit_invoice_number[2702][]="16"' \
--form 'debit_bill_type[2702][]="1"' \
--form 'debit_bill_type[2702][]="1"' \
--form 'debit_paid_amount[2702][]="785"' \
--form 'debit_paid_amount[2702][]="10642"' \
--form 'debit_discount_amount[2702][]="0"' \
--form 'debit_discount_amount[2702][]="0"' \
--form 'debit_rounding_amount[2702][]="0"' \
--form 'debit_rounding_amount[2702][]="0"' \
--form 'narration=""'

Responses

🟢200Update Journal

application/json

Body

data

boolean

required

success

boolean

required

message

string

required

Example

{
    "data": true,
    "success": true,
    "message": "Journal Transaction updated successfully."
}

Modified at 2025-04-03 10:24:28

Edit Journal

Delete Journal

Update Journal

Request#

Response#

Request

Request samples

Responses

Request

Response