HisabKitab
  1. Income Credit Note Transaction
HisabKitab
  • Third Party APIs
    • How to Generate ApiKey ?
    • Account Master
      • Ledger Groups
        • List of All Groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Ledgers
        • Create Ledger
          • Customer Ledger
          • Supplier Ledger
          • Bank Ledger
          • Capital Ledger
          • Cash Ledger
          • Income Ledger
          • Expense Ledger
          • Fixed Asset Ledger
          • Investment Ledger
          • Loan and Advance (Asset) Ledger
          • Misc Assets Ledger
          • Other Current Assets Ledger
          • Taxes - GST Ledger
          • Taxes - TDS Ledger
          • Taxes - TCS Ledger
          • Provisions Ledger
          • Reserve and Surplus Ledger
          • Secured Loan Ledger
          • Unsecured Loan Ledger
          • Stock In Hand Ledger
          • Other Current Liabilities Ledger
          • TDS Receivable Ledger
          • TCS Receivable Ledger
        • Ledger Detail
        • List of all Ledgers
        • Edit Ledger
        • Update Ledger
        • Delete Ledger
        • Delete Ledger Media
        • Add Location(Fixed Asset )
        • Check Unique GST Number
        • Check Unique GST Number with Ledger
        • Holding & Profit Ratio
        • Ledger TDS tax Data
        • Ledger TCS tax Data
    • Item Master
      • Item Groups
        • List of all groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Items
        • Item Form Details
        • List of items
        • Create Good Item
        • Create Service Item
        • Edit Item
        • Update Item
        • Delete Item
      • Unit of Measurement
        • List of Unit of Measurement
        • Create Unit of Measurement
        • Edit Unit of Measurement
        • Update Unit of Measurement
        • Delete Unit of Measurement
    • Broker Master
      • List of Brokers
      • Create Broker
      • Edit Broker
      • Update Broker
      • Delete Broker
    • Transport Master
      • List of Transport
      • Create Transport
      • Edit Transport
      • Update Transport
      • Delete Transport
    • Cess Rate
      • List of Cess Rate
      • Create Cess Rate
      • Edit Cess Rate
      • Update Cess Rate
      • Delete Cess Rate
    • Dispatch Address
      • List of Dispatch Address
      • Create Dispatch Address
      • Edit Dispatch Address
      • Update Dispatch Address
      • Delete Dispatch Address
    • Shipping Address
      • List of Shipping Addresses
      • Create Shipping Address
      • Edit Shipping Address
      • Update Shipping Address
      • Delete Shipping Address
    • Comman APIs
      • Company Details
      • Countries
      • States
      • Cities
      • Gst Rates
      • Classification-nature-type
    • Configuration
      • Sale
        • Sale Configuration
        • Update Configuration
        • Update Configuration with Type
      • Sale Return
        • Sale Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Debit Note
        • Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Credit Note
        • Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Estimate Quote
        • Estimate Configuration
        • Update Configuration with Type
        • Update Configuration
      • Delivery Challan
        • Delivery Challan Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase
        • Purchase Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Return
        • Purchase Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Credit Note
        • Expense Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Debit Note
        • Expense Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Order
        • Purchase Order Configuration
        • Update Configuration
        • Update Configuration with Type
    • Sale Transactions
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale
      • Create Accounting Sale
      • Edit Sale
      • Update Sale
      • Duplicate Sale
      • Delete Sale
      • Get Sale For Sale Return
      • Create Challan From Sale Invoice
    • Sale Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale Return
      • Create Accounting Sale Return
      • Edit Sale Return
      • Update Sale Return
      • Duplicate Sale Return
      • Delete Sale Return
    • Income Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Debit Note
      • Create Accounting Debit Note
      • Edit Debit Note
      • Update Debit Note
      • Duplicate Debit Note
      • Delete Debit Note
    • Income Credit Note Transaction
      • List of Transactions
        GET
      • Next Invoice Number
        GET
      • Create Item Credit Note
        POST
      • Create Accounting Credit Note
        POST
      • Edit Credit Note
        GET
      • Update Credit Note
        POST
      • Duplicate Credit Note
        GET
      • Delete Credit Note
        DELETE
    • Estimate Quote Transaction
      • List of Transactions
      • Next Estimate Number
      • Create Item Estimate
      • Create Accounting Estimate
      • Edit Estimate
      • Update Estimate
      • Duplicate Estimate
      • Create Sale From Estimate
      • Delete Estimate
    • Delivery Challan Transaction
      • List of Transactions
      • Next Challan Number
      • Create Delivery Challan
      • Edit Delivery Challan
      • Update Delivery Challan
      • Duplicate Delivery Challan
      • Create Sale From Delivery Challan
      • Delete Delivery Challan
    • Purchase Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase
      • Create Accounting Purchase
      • Edit purchase
      • Update purchase
      • Duplicate purchase
      • Get purchase For purchase Return
      • Delete purchase
    • Purchase Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Return
      • Create Accounting Purchase Return
      • Edit purchase Return
      • Update purchase Return
      • Duplicate purchase Return
      • Delete purchase Return
    • Expense Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Credit Note
      • Create Accounting Expense Credit Note
      • Edit Expense Credit Note
      • Update Expense Credit Note
      • Duplicate Expense Credit Note
      • Delete Expense Credit Note
    • Expense Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Debit Note
      • Create Accounting Expense Debit Note
      • Edit Expense Debit Note
      • Update Expense Debit Note
      • Duplicate Expense Debit Note
      • Delete Expense Debit Note
    • Purchase Order Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Order
      • Create Accounting Purchase Order
      • Edit purchase Order
      • Update Purchase Order
      • Duplicate purchase Order
      • Delete purchase Order
      • Book Purchase Order
    • Receipt Transaction
      • List of Receipts
      • Next invoice number
      • Create Receipt
      • Edit Receipt
      • Update Receipt
      • Delete Receipt
    • Payment Transaction
      • List of Payments
      • Next invoice number
      • Create Payment
      • Edit Payment
      • Update Payment
      • Delete Payment
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Income Credit Note Transaction

Edit Credit Note

GET
{{host}}income-credit-notes/{id}
This endpoint allows you to retrieve an existing credit note transaction based on its unique ID for modifications or updates of it.

Request#

The request must be sent as a GET request, with the ID of the credit note included in the URL.

Response#

The response contains details of the specified credit note transaction, which can be edited. The response includes the current transaction data, including the credit note invoice number, items, and other relevant information.

Request

Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Path Params
id
integer 
required
The id represents income credit note transaction id.
Example:
1

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{host}}income-credit-notes/1' \
--header 'ApiKey;'

Responses

🟢200Edit Credit Note
application/json
Body
data
object 
required
id
integer 
required
A unique identifier for the income credit note transaction.
company_id
integer 
required
Represents the company associated with this credit note.
payment_mode
integer 
required
Specifies the mode of payment for the transaction.
payment_type_ledger_id
integer 
required
Refers to the ledger associated with the payment type.
credit_note_number
string 
required
A sequential numeric identifier for the invoice.
full_invoice_number
string 
required
The complete formatted invoice number, which may include prefixes or suffixes (e.g., "Bill-3").
date
string 
required
The date on which the transaction was recorded.
original_inv_no
string 
required
Represents the sales transaction invoice number that is used as a reference to create a debit note invoice. This links the debit note invoice to the original sale.
original_inv_date
string 
required
The invoice date represents the date on which the sales invoice was created. It serves as a reference for generating a debit note invoice.
customer_ledger_id
integer 
required
The unique identifier for the customer ledger, which maintains financial records related to this transaction.
party_phone_number
string 
required
The contact number of the customer.
region_iso
string 
required
Represents the ISO code for the country of the customer. For example, "IN" indicates India, helping in country-specific tax.
region_code
string 
required
Represents the country-specific regional code (e.g., 91 for India).
gstin
string 
required
The GST identification number of the customer.
broker_id
integer 
required
The broker id is the unique identifier assigned to the broker involved in the transaction or deal.
brokerage_for_sale
number 
required
The brokerage value is the percentage fee that the broker receives for facilitating the deal.
brokerage_on_value_type
integer 
required
This field determines the basis on which the brokerage fee is calculated such as invoice value (1) and taxable value (2).
credit_period
integer 
required
Refers to the credit period (number of days or month) granted to the buyer, which is the time allowed to make payment for the goods or services received.
credit_period_type
integer 
required
This field defines the type of credit period applied months (1) and days (2).
credit_period_due_date
string 
required
The date on which the payment is due based on the credit period.
transport_id
integer 
required
Represents the unique identifier for the transport service provider that is responsible for delivering the goods.
billing_state_id
integer 
required
This field represents the unique identifier of the billing state associated with the transaction
transporter_document_number
string 
required
Refers to the document number issued by the transporter, such as a bill.
transporter_document_date
string 
required
This is the date when the transporter's document was issued.
transporter_vehicle_number
string 
required
Represents the vehicle number used for transporting the goods.
eway_bill_number
string 
required
This field holds the unique identification number of the E-way bill generated for the shipment of goods.
eway_bill_date
string 
required
This is the date when the E-way bill was generated.
po_no
string 
required
Represents the Purchase Order Number associated with the transaction issued by the buyer.
po_date
string 
required
This is the date on which the Purchase Order was issued.
cn_item_type
integer 
required
Indicates the type of invoice such as item invoice (2) and accounting invoice (1).
shipping_freight
integer 
required
This field represents the cost of shipping or freight for transporting the goods.
packing_charge
integer 
required
This field refers to the cost associated with packaging the goods.
tcs_tax_id
integer 
required
This field stores the identifier for the Tax Collected at Source (TCS) tax.
tcs_rate
integer 
required
This represents the percentage rate of TCS applicable to the transaction.
tcs_amount
integer 
required
This field captures the total monetary amount of TCS deducted from the transaction.
tds_tax_id
integer 
required
This field stores the identifier for the Tax Deducted at Source (TDS) tax.
tds_rate
number 
required
This field represents the percentage rate of TDS applicable to the transaction.
tds_amount
number 
required
The total monetary amount of TDS deducted from the transaction.
cgst
integer 
required
The total amount of Central Goods and Services Tax (CGST) applied to the transaction.
sgst
integer 
required
The total amount of State Goods and Services Tax (SGST) applied to the transaction.
igst
number 
required
The total amount of Integrated Goods and Services Tax (IGST) applicable to the transaction.
shipping_freight_with_gst
number 
required
This field represents the shipping freight charges, including GST
packing_charge_with_gst
number 
required
This field represents the packing charges, including GST.
shipping_freight_sgst_amount
integer 
required
GST tax Detail of shipping freight including SGST, CGST and IGST.
shipping_freight_cgst_amount
integer 
required
shipping_freight_igst_amount
number 
required
packing_charge_sgst_amount
integer 
required
GST tax Detail of packing charges including SGST, CGST and IGST.
packing_charge_cgst_amount
integer 
required
packing_charge_igst_amount
number 
required
rounding_amount
number 
required
The amount adjusted for rounding off the total bill.
total
number 
required
The total value of the sale transaction before tax.
grand_total
integer 
required
The final amount of the invoice, which includes all items, taxes, additional charges, and rounding adjustments.
taxable_value
integer 
required
The amount on which tax is calculated.
payment_status
string 
required
The current payment status of the transaction (e.g., "Unpaid").
due_amount
integer 
required
This field indicates the remaining balance that is yet to be paid or adjusted for the transaction. It is calculated as the difference between the invoice_amount and the paid_amount.
narration
string 
required
An optional narrative field for providing additional notes or descriptions related to the transaction
term_and_condition
string 
required
Includes any terms and conditions relevant to the transaction, such as payment terms, delivery schedules, or return policies.
dispatch_address_id
integer 
required
The field represents the unique identifier for the dispatch (shipping) address associated with the transaction.
is_gst_enabled
boolean 
required
Indicates whether GST is enabled for the transaction.
is_gst_na
integer 
required
Indicates if GST is not applicable to the transaction.
is_cgst_sgst_igst_calculated
integer 
required
Indicates whether CGST, SGST, or IGST has been calculated.
cess
integer 
required
Represents the cess (additional tax) applied to the transaction.
shipping_gstin
string 
required
The GSTIN (Goods and Services Tax Identification Number) of the shipping address.
shipping_name
string 
required
The name of the shipping party or recipient.
is_round_off_not_changed
boolean 
required
Specifies whether the round fo amount change or not.
customer_ledger_name
string 
required
The name of customer ledger, which linked to the transaction.
gross_value
number 
required
The total gross value of the sale before deductions.
media
array[string]
required
Stores media-related data associated with the transaction.
tcs_calculated
object 
required
paid_amount
integer 
required
This field represents the amount that has already been paid by the customer or business entity for the transaction.
customer
object 
required
Represents customer details.
dispatch_address
object 
required
Represents the address where the goods should be picked up or dispatched from.
billing_address
object 
required
Contains details about the billing address linked to the transaction.
shipping_address
object 
required
Stores the delivery address where the items should be shipped.
income_credit_note_items
array [object {39}] 
required
income_credit_note_ledgers
array[string]
required
Stores ledger entries related to the transaction if invoice type is accounting invoice.
additional_charges
array[string]
required
Holds any extra charges applied to the transaction.
add_less
array[string]
required
Contains adjustments that either increase (add) or decrease (less) the total transaction amount.
payment_details
array[string]
required
Stores information about payments linked to the transaction.
payment_transaction_item
array[string]
required
Contains detailed records of receipt transactions associated with the debit note.
journal_transaction_item
array[string]
required
Holds journal entries created due to the debit note.
via_api
integer 
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 sale return transaction.
deleted_at
string 
required
Stores the date and time when the sale return transaction was deleted.
success
boolean 
required
message
string 
required
Example
{
    "data": {
        "id": 1,
        "company_id": 6,
        "payment_mode": 2,
        "payment_type_ledger_id": null,
        "credit_note_number": "3",
        "full_invoice_number": "2023-243",
        "date": "2024-06-06T18:30:00.000000Z",
        "original_inv_no": null,
        "original_inv_date": "2024-06-06T18:30:00.000000Z",
        "customer_ledger_id": 1,
        "party_phone_number": null,
        "region_iso": null,
        "region_code": null,
        "gstin": "09AAACC1206D5ZA",
        "broker_id": null,
        "brokerage_for_sale": null,
        "brokerage_on_value_type": 2,
        "credit_period": 2,
        "credit_period_type": 1,
        "credit_period_due_date": null,
        "transport_id": null,
        "billing_state_id": 5,
        "transporter_document_number": null,
        "transporter_document_date": null,
        "transporter_vehicle_number": null,
        "eway_bill_number": null,
        "eway_bill_date": null,
        "po_no": null,
        "po_date": null,
        "cn_item_type": 2,
        "shipping_freight": 2,
        "packing_charge": 2,
        "tcs_tax_id": 3,
        "tcs_rate": 1,
        "tcs_amount": 5,
        "tds_tax_id": null,
        "tds_rate": null,
        "tds_amount": null,
        "cgst": 0,
        "sgst": 0,
        "igst": 1.08,
        "shipping_freight_with_gst": 2.36,
        "packing_charge_with_gst": 2.36,
        "shipping_freight_sgst_amount": 0,
        "shipping_freight_cgst_amount": 0,
        "shipping_freight_igst_amount": 0.18,
        "packing_charge_sgst_amount": 0,
        "packing_charge_cgst_amount": 0,
        "packing_charge_igst_amount": 0.18,
        "rounding_amount": -0.07999999999999996,
        "total": 512.08,
        "grand_total": 512,
        "taxable_value": 504,
        "gross_value": null,
        "payment_status": "Unpaid",
        "due_amount": 512,
        "narration": "2",
        "term_and_condition": "2",
        "dispatch_address_id": null,
        "is_gst_enabled": 1,
        "is_gst_na": 1,
        "is_cgst_sgst_igst_calculated": 0,
        "cess": 2,
        "shipping_gstin": null,
        "shipping_name": null,
        "is_round_off_not_changed": null,
        "customer_ledger_name": "Armaan Shah",
        "media": [],
        "tcs_calculated": {
            "tax_rate": "1",
            "calculated_on": 2
        },
        "paid_amount": 0,
        "customer": {
            "id": 1,
            "name": "Armaan Shah",
            "company_id": 6,
            "group_id": 4,
            "parent_id": null,
            "model_id": 2,
            "model_type": "App\\Models\\Master\\Customer",
            "ledgers_data": {
                "Bank": {
                    "upi_id": null,
                    "bank_name": null,
                    "ifsc_code": null,
                    "swift_code": null,
                    "branch_name": null,
                    "account_type": null,
                    "account_number": null,
                    "opening_balance": null,
                    "opening_balance_dr_cr": "1"
                },
                "Capital": {
                    "aadhar_number": null,
                    "holding_ratio": 100,
                    "opening_balance": null,
                    "pan_card_number": null,
                    "name_of_proprietor": "Armaan Shah",
                    "opening_balance_dr_cr": 1,
                    "billing_address_city_id": null,
                    "billing_address_pin_code": null,
                    "billing_address_state_id": null,
                    "billing_address_address_1": null,
                    "billing_address_address_2": null,
                    "profit_loss_sharing_ratio": 100,
                    "billing_address_country_id": null
                },
                "Customer": {
                    "tan": null,
                    "gstin": null,
                    "phone_1": null,
                    "phone_2": null,
                    "website": null,
                    "brokerage": null,
                    "reference": true,
                    "cin_number": "",
                    "entity_type": 9,
                    "person_name": null,
                    "credit_limit": false,
                    "person_email": null,
                    "broker_master": null,
                    "reference_name": null,
                    "opening_balance": null,
                    "pan_card_number": null,
                    "rate_of_interest": null,
                    "reference_address": null,
                    "brokerage_on_value": 3,
                    "credit_period_type": 1,
                    "credit_limit_action": null,
                    "credit_limit_amount": null,
                    "credit_limit_period": null,
                    "gst_registration_type": null,
                    "opening_balance_dr_cr": 1,
                    "billing_address_city_id": null,
                    "billing_address_pin_code": null,
                    "billing_address_state_id": null,
                    "shipping_address_city_id": null,
                    "billing_address_address_1": null,
                    "billing_address_address_2": null,
                    "reference_contact_details": null,
                    "shipping_address_pin_code": null,
                    "shipping_address_state_id": null,
                    "billing_address_country_id": null,
                    "shipping_address_address_1": null,
                    "shipping_address_address_2": null,
                    "shipping_address_country_id": null
                }
            },
            "opening_balance_dr_cr": 1,
            "opening_balance": null,
            "is_import": null,
            "via_api": 0,
            "is_default": false,
            "created_at": "2024-03-09T07:31:19.000000Z",
            "updated_at": "2024-03-11T04:25:39.000000Z"
        },
        "dispatch_address": null,
        "billing_address": {
            "id": 1,
            "address_1": "CENTRAL WAREHOUSING CORPORATION, INLAND CONTAINER DEPOT",
            "address_2": "NSEZ NOIDA DADRI ROAD",
            "country_id": 1,
            "state_id": 2,
            "city_id": 1,
            "pin_code": "201301",
            "model_id": 3,
            "model_type": "App\\Models\\IncomeCreditNoteTransaction",
            "address_type": 1,
            "created_at": "2024-06-07T11:34:46.000000Z",
            "updated_at": "2024-06-07T11:34:46.000000Z"
        },
        "shipping_address": {
            "id": 2,
            "address_1": null,
            "address_2": null,
            "country_id": null,
            "state_id": null,
            "city_id": null,
            "pin_code": null,
            "model_id": 5,
            "model_type": "App\\Models\\IncomeCreditNoteTransaction",
            "address_type": 2,
            "created_at": "2024-06-07T11:34:46.000000Z",
            "updated_at": "2024-06-07T11:34:46.000000Z"
        },
        "income_credit_note_items": [
            {
                "id": 1,
                "income_cn_id": 1,
                "item_id": 4,
                "additional_description": null,
                "unit_id": 1,
                "quantity": 1,
                "mrp": null,
                "with_tax": false,
                "rpu_with_gst": 500,
                "rpu_without_gst": 500,
                "discount_type": 1,
                "discount_value": 0,
                "discount_type_2": null,
                "discount_value_2": null,
                "total_discount_amount": 0,
                "gst_id": 1,
                "gst_tax_percentage": 0,
                "total": 500,
                "ledger_id": 6,
                "classification_igst_tax": 0,
                "classification_cgst_tax": 0,
                "classification_sgst_tax": 0,
                "classification_cess_tax": 0,
                "classification_is_rcm_applicable": 0,
                "classification_nature_type": 4,
                "consolidating_items_to_invoice": null,
                "cess_rate": 0,
                "cess_amount": 0,
                "taxable_amount": 0,
                "item_name": "Sharpener",
                "ledger_name": "Sale",
                "units_of_array": [
                    {
                        "id": 1,
                        "name": "PIECES",
                        "code": "PCS",
                        "full_name": "PCS-PIECES",
                        "is_default": true,
                        "for_gst_use_name": null,
                        "company_id": null,
                        "created_at": "2023-02-10T04:22:56.000000Z",
                        "updated_at": "2023-02-10T04:22:56.000000Z"
                    }
                ],
                "decimal_places": 2,
                "decimal_places_for_rate": 2,
                "secondary_unit_of_measurement": null,
                "conversion_rate": null,
                "taxable_value": 500,
                "created_at": "2024-06-07T11:36:17.000000Z",
                "updated_at": "2024-06-07T11:36:17.000000Z"
            }
        ],
        "income_credit_note_ledgers": [],
        "additional_charges": [],
        "add_less": [],
        "payment_details": [],
        "payment_transaction_item": [],
        "journal_transaction_item": [],
        "via_api": 1,
        "is_import": 0,
        "created_by": 8,
        "created_at": "2024-06-07T11:34:46.000000Z",
        "updated_at": "2024-10-18T09:14:39.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Income Credit Note Transaction Retrieved Successfully"
}
Modified at 2025-02-20 10:35:00
Previous
Create Accounting Credit Note
Next
Update Credit Note
Built with