Create Accounting Credit Note

This endpoint allows the creation of a new income credit note transaction of accounting type invoice with the unique credit note invoice number. In create Invoice detail credit note item type must be set 1 to create accounting type debit note invoice.

Request

The request must be sent as a POST request and include the necessary details for creating a credit note transaction.

Response

The API will return a confirmation message along with the details of the newly created credit note transaction.

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Body Params application/json

invoice_number

string

required

The unique invoice number is system-generated and assigned to each invoice and Typically fetched from the Next Invoice Number API.

date

string

required

The invoice date represents the date on which an invoice is issued, and the date is set within the applicable financial year.

customer_ledger_id

integer

required

Represents the unique identifier of the customer for whom the invoice is being created, linking the invoice to the relevant business entity. you get it from Ledger List API.

billing_address

object

required

Represents the billing address of the customer for invoicing purposes.

country_id

integer

required

Reference ID for the country. it get from Country API.

state_id

integer

required

Reference ID for the state of the selected country. it get from State API.

address_1

string

optional

Primary address line (e.g., office or building name).

address_2

string

optional

Secondary address line, often for road or area name.

city_id

integer

optional

Reference ID for the city of the selected state. it get from City API.

pin_code

string

optional

Postal code of the address.

cn_item_type

integer

required

Indicates the type of invoice here is must 1, such as item invoice (2) and accounting invoice (1). This field is nullable. If no specific type is provided, the system will automatically assign the item invoice (2) type by default.

ledgers

array [object {11}]

required

An array of ledgers for accounting invoice

ledger_id

integer

required

Refers to the unique identifier of the ledger account where the transaction is recorded. get it from Ledger List API.

rpu

number

required

Represents the Rate Per Unit of the ledger, the selling price for the ledger before taxes and discounts.

with_tax

integer

required

This indicates whether the price is inclusive of tax. A value of 0 means the price is exclusive of tax.

discount_type

integer

required

Type of discount applied to the selling price (2 = Percentage, 1 = Fixed amount).

discount_value

number | null

optional

Represents the discount amount applied to the ledger.

total

number

required

This is the final total for the ledger after all calculations, including discounts.

additional_description

string | null

optional

Provides any extra details or notes about the ledger being sold.

discount_type_2

integer | null

optional

Similar to discount_type applicable on the second discount amount.

discount_value_2

number | null

optional

Represents the second discount amount applied.

gst_id

integer

optional

This field refers to the GST tax rate associated with the ledger. get it from Gst Rates API.

cess

integer

optional

Represents the cess (additional tax) applied to the legder.

main_classification_nature_type

string

required

Describes the nature of the transaction for tax purposes, such as "Intrastate Sales Taxable". you get it from Classification-nature-type

is_rcm_applicable

boolean

required

Indicates whether the Reverse Charge Mechanism (RCM) is applicable, it is a tax mechanism where the buyer, rather than the seller, is liable to pay the tax.

Default:

false

gross_value

number

required

Represents the total value of the transaction before applying any discounts, taxes, or additional charges.

taxable_value

number

required

The total value of the invoice, after applying discounts and additional charges but before adding any taxes.

cgst

number

required

These fields represent the Central GST

sgst

number

required

These fields represent the State GST

igst

number

required

These fields represent the Integrated GST

cess

number

required

Represents the cess (additional tax) applied to the transaction.

rounding_amount

number <double>

required

The rounding adjustment to make the total amount a round figure. This is usually done for simplifying invoice totals.

grand_total

number <double>

required

The final amount of the invoice, which includes all items, taxes, additional charges, and rounding adjustments.

is_gst_enabled

boolean

required

Indicates whether GST is enabled for the transaction.

is_cgst_sgst_igst_calculated

boolean

required

Indicates whether CGST, SGST, or IGST has been calculated.

is_gst_na

boolean

required

Indicates if GST is not applicable to the transaction.

is_round_off_not_changed

boolean

required

check if adjustments are made to the rounding of the invoice total.

gstin

string

optional

The GSTIN (Goods and Services Tax Identification Number) is a unique number assigned to the customer for claim tax credits.

original_inv_no

string

optional

Represents the sales transaction invoice number that is used as a reference to create a credit note invoice. This links the credit note invoice to the original sale.

original_inv_date

string

optional

The invoice date represents the date on which the sales invoice was created. It serves as a reference for generating a credit note invoice.

dispatch_address_id

integer

optional

Contains the delivery address for the products or services being invoiced.

shipping_address

object

optional

The shipping address where goods should be delivered. This includes customer details, GSTIN, and address information.

country_id

integer

required

Reference ID for the country. it get from Country API.

state_id

integer

required

Reference ID for the state of the selected country. it get from State API.

shipping_name

string

optional

Define the shipping customer's name.

shipping_gstin

string

optional

Define the shipping customer gstin number.

address_1

string

optional

Primary address line (e.g., office or building name).

address_2

string

optional

Secondary address line, often for road or area name.

city_id

integer

optional

Reference ID for the city of the selected state. it get from City API.

pin_code

string

optional

Postal code of the address.

eway_bill_details

object

optional

eway_bill_number

string

optional

This field holds the unique identification number of the E-way bill generated for the shipment of goods.

eway_bill_date

string

optional

This is the date when the E-way bill was generated.

other_details

object

optional

po_no

string

optional

Represents the Purchase Order Number associated with the transaction issued by the buyer.

po_date

string

optional

This is the date on which the Purchase Order was issued.

credit_period

string

optional

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

optional

This field defines the type of credit period applied months (1) and days (2).

narration

string | null

optional

An optional narrative field for providing additional notes or descriptions related to the transaction

term_and_condition

string | null

optional

Includes any terms and conditions relevant to the transaction, such as payment terms, delivery schedules, or return policies.

tcs_details

object

optional

Includes Tax Collected at Source (TCS) information

tcs_tax_id

integer

required

This field holds the id for the TCS rate applied to the transaction.

tcs_rate

integer

required

Represents the rate (%) at which TCS is collected on the transaction.

tcs_amount

number

required

This field shows the amount of TCS collected on the transaction.

tds_details

object

optional

Contains information regarding Tax Deducted at Source (TDS).

tds_tax_id

integer

required

This field holds the id for the TDS applied to the transaction.

tds_rate

integer

required

Represents the rate (%) at which TDS is collected on the transaction.

tds_amount

number

required

This field shows the amount of TDS collected on the transaction.

submit_button_value

integer

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

{
    "invoice_number": "1",
    "date": "05-01-2025",
    "customer_ledger_id": 1,
    "gstin": "06AAKCA6445Q1Z2",
    "original_inv_no": 1,
    "original_inv_date": "12-08-2024",
    "dispatch_address_id": null,
    "billing_address": {
        "address_1": "172/5, , Coastal City Center",
        "address_2": "Undi Road,  Bhimavaram town and Municipality",
        "country_id": 1,
        "state_id": 2,
        "city_id": 1,
        "pin_code": "395010"
    },
    "shipping_address": {
        "shipping_name": null,
        "shipping_gstin": null,
        "address_1": "",
        "address_2": "",
        "country_id": 1,
        "state_id": 1,
        "city_id": 2,
        "pin_code": "395010"
    },
    "broker_details": {
        "broker_id": null,
        "brokerage_for_sale": 0,
        "brokerage_on_value_type": null
    },
    "transport_details": {
        "transport_id": 1,
        "transporter_document_number": "212",
        "transporter_document_date": "12-10-2024",
        "transporter_vehicle_number": "GJ05-SG-1234"
    },
    "eway_bill_details": {
        "eway_bill_number": null,
        "eway_bill_date": null
    },
    "other_details": {
        "po_no": "FASG522",
        "po_date": "12-08-2024",
        "credit_period": "30",
        "credit_period_type": 2
    },
    "cn_item_type": 1,
    "ledgers": [
        {
            "ledger_id": 1,
            "additional_description": "test",
            "rpu": 100,
            "with_tax": 0,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 12,
            "total": 100
        },
        {
            "ledger_id": 2,
            "additional_description": "test",
            "rpu": 100,
            "with_tax": 0,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 12,
            "total": 100
        }
    ],
    "main_classification_nature_type": "Interstate Sales Taxable",
    "is_rcm_applicable": 0,
    "narration": null,
    "term_and_condition": null,
    "gross_value": 200,
    "additional_charges": [
        {
            "ac_ledger_id": 1,
            "ac_type": 1,
            "ac_value": 100,
            "ac_gst_rate_id": 12,
            "ac_total": 100
        }
    ],
    "taxable_value": 200,
    "cgst": 0,
    "sgst": 0,
    "igst": 0,
    "cess": 0,
    "tcs_details": {
        "tcs_tax_id": null,
        "tcs_rate": null,
        "tcs_amount": null
    },
    "tds_details": {
        "tds_tax_id": null,
        "tds_rate": null,
        "tds_amount": null
    },
    "add_less": [
        {
            "al_ledger_id": 1,
            "al_is_show_in_print": false,
            "al_type": 1,
            "al_value": 100
        }
    ],
    "rounding_amount": 0,
    "grand_total": 200,
    "payment_details": [],
    "is_gst_enabled": 0,
    "is_cgst_sgst_igst_calculated": 0,
    "is_gst_na": 1,
    "is_round_off_not_changed": 0,
    "submit_button_value": 2
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create Accounting Credit Note

application/json

Body

data

object

required

income_credit_note_transaction

object

required

transaction_id

integer

required

A unique identifier assigned to the transaction.

e_invoice_is_create

boolean

required

A boolean flag indicates whether an e-invoice has been generated for thistransaction.

success

boolean

required

message

string

required

Example

{
    "data": {
        "income_credit_note_transaction": {
            "id": 2,
            "company_id": 6,
            "payment_mode": null,
            "payment_type_ledger_id": null,
            "full_invoice_number": "CN1",
            "credit_note_number": "1",
            "date": "2025-01-04T18:30:00.000000Z",
            "customer_ledger_id": 1,
            "party_phone_number": null,
            "region_iso": null,
            "region_code": null,
            "gstin": null,
            "original_inv_no": null,
            "original_inv_date": null,
            "broker_id": null,
            "brokerage_for_sale": null,
            "brokerage_on_value_type": null,
            "credit_period": 30,
            "credit_period_type": 2,
            "credit_period_due_date": "2025-02-03T18:30:00.000000Z",
            "transport_id": null,
            "transporter_document_number": null,
            "transporter_document_date": null,
            "transporter_vehicle_number": null,
            "shipping_name": null,
            "shipping_gstin": null,
            "po_no": "FASG522",
            "po_date": "2024-08-11T18:30:00.000000Z",
            "eway_bill_number": null,
            "eway_bill_date": null,
            "cn_item_type": 1,
            "tcs_tax_id": null,
            "tcs_rate": null,
            "tcs_amount": null,
            "tds_tax_id": null,
            "tds_rate": null,
            "tds_amount": null,
            "cgst": 0,
            "sgst": 0,
            "igst": 0,
            "rounding_amount": 0,
            "total": 200,
            "grand_total": 200,
            "taxable_value": 200,
            "gross_value": 200,
            "narration": null,
            "term_and_condition": null,
            "dispatch_address_id": null,
            "is_gst_enabled": 0,
            "cess": 0,
            "billing_state_id": 4012,
            "is_cgst_sgst_igst_calculated": 0,
            "is_gst_na": 1,
            "is_round_off_not_changed": 0,
            "payment_status": "Unpaid",
            "due_amount": 200,
            "paid_amount": 0,
            "payment_transaction_item": [],
            "journal_transaction_item": [],
            "income_crdit_note_ledgers": [
                {
                    "id": 1,
                    "income_cn_id": 1,
                    "ledger_id": 1,
                    "additional_description": "test",
                    "with_tax": false,
                    "rpu_with_gst": 100,
                    "rpu_without_gst": 100,
                    "discount_type": 1,
                    "discount_value": null,
                    "discount_type_2": 1,
                    "discount_value_2": null,
                    "total_discount_amount": 0,
                    "gst_id": null,
                    "gst_tax_percentage": null,
                    "total": 100,
                    "cess_rate": 0,
                    "cess_amount": 0,
                    "classification_igst_tax": null,
                    "classification_cgst_tax": null,
                    "classification_sgst_tax": null,
                    "classification_cess_tax": null,
                    "classification_is_rcm_applicable": 0,
                    "classification_nature_type": null,
                    "taxable_value": 100,
                    "created_at": "2025-01-28T10:25:13.000000Z",
                    "updated_at": "2025-01-28T10:25:13.000000Z"
                },
                {
                    "id": 2,
                    "income_cn_id": 1,
                    "ledger_id": 2,
                    "additional_description": "test",
                    "with_tax": false,
                    "rpu_with_gst": 100,
                    "rpu_without_gst": 100,
                    "discount_type": 1,
                    "discount_value": null,
                    "discount_type_2": 1,
                    "discount_value_2": null,
                    "total_discount_amount": 0,
                    "gst_id": null,
                    "gst_tax_percentage": null,
                    "total": 100,
                    "cess_rate": 0,
                    "cess_amount": 0,
                    "classification_igst_tax": null,
                    "classification_cgst_tax": null,
                    "classification_sgst_tax": null,
                    "classification_cess_tax": null,
                    "classification_is_rcm_applicable": 0,
                    "classification_nature_type": null,
                    "taxable_value": 100,
                    "created_at": "2025-01-28T10:25:13.000000Z",
                    "updated_at": "2025-01-28T10:25:13.000000Z"
                }
            ],
            "via_api": false,
            "is_import": false,
            "created_by": 8,
            "created_at": "2025-01-28T10:23:12.000000Z",
            "updated_at": "2025-01-28T10:23:12.000000Z",
        },
        "transaction_id": 2,
        "e_invoice_is_create": false
    },
    "success": true,
    "message": "Income Credit Note Transaction Created Successfully."
}

Create Accounting Credit Note

Request#

Response#

Request

Request samples

Responses

Request

Response