Edit a document

PUT

doc

{doc_hash_id}

curl --request PUT \
  --url https://app.getswipe.in/api/partner/v2/doc/{doc_hash_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "serial_number": "INV123",
  "serial_number_v2": {
    "prefix": "INV",
    "doc_number": 1,
    "suffix": "2024"
  },
  "document_type": "invoice",
  "document_date": "11-06-2024",
  "party": {
    "id": "CUST123",
    "type": "customer",
    "name": "John Doe",
    "country_code": "91",
    "phone_number": "1234567890",
    "company_name": "Company Name",
    "email": "johndoe@example.com",
    "gstin": "27AARCS7202C1ZD",
    "shipping_address": {
      "addr_id": -1,
      "address_line1": "123 Street",
      "address_line2": "Apt 4B",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "pincode": "123456"
    },
    "billing_address": {
      "addr_id": -1,
      "address_line1": "123 Street",
      "address_line2": "Apt 4B",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "pincode": "123456"
    }
  },
  "due_date": "11-06-2024",
  "reference": "Reference Text",
  "notes": "Notes for the document",
  "terms": "Terms and Conditions",
  "items": [
    {
      "id": "ITEM123",
      "name": "Item Name",
      "quantity": 1,
      "unit_price": 100,
      "tax_rate": 18,
      "price_with_tax": 118,
      "net_amount": 100,
      "total_amount": 118,
      "discount_percent": 10,
      "discount_amount": 10,
      "description": "Item Description",
      "hsn_code": "1234",
      "item_type": "Product",
      "unit": "kg",
      "category": "Electronics",
      "custom_columns": [
        {
          "label": "Custom Field 1",
          "value": "Value 1"
        }
      ]
    }
  ],
  "extra_discount": 20,
  "round_off": true,
  "bank_details": {
    "account_number": "1234567890",
    "ifsc": "SBIN0000001",
    "bank_name": "State Bank of India",
    "branch": "Mumbai"
  },
  "tds_id": 123,
  "tcs_id": 123,
  "charges_and_deductions": [
    {
      "id": 1,
      "name": "Delivery Charge",
      "amount": 100,
      "tax_rate": 18,
      "sac_code": "1234",
      "type": "charge"
    }
  ],
  "company_shipping_address": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "company_billing_address": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "is_export": false,
  "export_invoice_details": {
    "shipping_bill_date": "14-02-2024",
    "shipping_bill_number": "123456",
    "shipping_port_code": "123456",
    "export_type": "With Payment of Tax",
    "conversion_factor": 123,
    "country_id": "Afghanistan",
    "currency_id": "AED"
  }
}'

{
  "success": true,
  "message": "Message",
  "error_code": "",
  "errors": {},
  "data": {
    "hash_id": "SL123",
    "serial_number": "SL123",
    "irn": "<string>",
    "qr_code": "<string>"
  }
}

To update a document, include the document’s unique doc_hash_id in the request URL and send all the keys with their updated values in the request body, ensuring the document is updated correctly with the provided data.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

doc_hash_id

string

required

The hash ID of the document that needs to be updated.

Body

application/json

document_type

enum<string>

required

Value should always be the string 'invoice'

Available options:

invoice,

subscription,

pro_forma_invoice,

estimate,

sales_return,

purchase_return

Example:

"invoice"

document_date

string

required

DD-MM-YYYY

Example:

"11-06-2024"

items

object[]

required

Array of Products/Services, refer Item Object below for parameters

items.id

string

required

Unique id for each item. If a new id is sent, a new Item with the below details will be automatically created. if existing Item id is sent the details will not override the original item details. They will be applicable only to the current documents. Use update item to actually update the item details in swipe

Example:

"ITEM123"

items.name

string

required

Name of the Product

Example:

"Item Name"

items.quantity

number

required

Quantity

Example:

1

items.unit_price

number

required

Price per item without Tax

Example:

100

items.price_with_tax

number

required

Price per item with Tax

Example:

118

items.net_amount

number

required

Net Amount

Example:

100

items.total_amount

number

required

Item total amount (Net Amount + Tax). We calculate the discount amount by multiplying the item's quantity, unit price, and discount percentage. If a discount amount is provided instead, we reverse-calculate the percentage. If no discount is given, it is set to 0.

Example:

118

items.item_type

enum<string>

required

Product or Service enum

Available options:

Product,

Service

Example:

"Product"

items.tax_rate

number

Tax percentage for each item . Only valid tax rates are accepted

Example:

18

items.discount_percent

number

Discount Percent

Example:

10

items.discount_amount

number

Discount Amount, will be ignored if discount_percent is provided

Example:

10

items.description

string

Item Description

Example:

"Item Description"

items.hsn_code

string

HSN Code. HSN Code can only be of length 4,6 & 8

Example:

"1234"

items.unit

string

Item quantity unit. You can find the GST-approved units in the UQC Codes section at: https://einvoice1.gst.gov.in/Others/MasterCodes.

Example:

"kg"

items.category

string

Category

Example:

"Electronics"

items.custom_columns

object[]

Item Custom Fields. Custom fields should already be added in Swipe Portal.

Example:

[
  {
    "label": "Custom Field 1",
    "value": "Value 1"
  }
]

serial_number

string

Serial Number (deprecated, please use New Serial Number)

Example:

"INV123"

serial_number_v2

object

Example:

{
  "prefix": "INV",
  "doc_number": 1,
  "suffix": "2024"
}

party

object

Party. If there are any changes made to the party details, we will update those details and any documents linked to this party ID will be updated to reflect the changes.

party.id

string

required

Unique id for each party.

Example:

"CUST123"

party.type

enum<string>

required

Party type, use only specified values. Party type customer can be used for creating invoices, sales returns, estimates, pro forma invoices and delivery challans. Party type vendor can be used for creating purchases, purchase orders & purchase returns, .

Available options:

customer,

vendor

Example:

"customer"

party.name

string

required

Name of the Party

Example:

"John Doe"

party.country_code

string

Party Phone Number Country code

Example:

"91"

party.phone_number

string

Party Phone Number

Example:

"1234567890"

party.company_name

string

Company Name

Example:

"Company Name"

party.email

string

Party Email

Example:

"johndoe@example.com"

party.gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

party.shipping_address

object

Party shipping to Address, refer Shipping Address Object for parameters

party.shipping_address.addr_id

integer

required

Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.

Example:

-1

party.shipping_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

party.shipping_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

party.shipping_address.city

string

required

City

Example:

"City Name"

party.shipping_address.state

enum<string>

required

State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

JAMMU AND KASHMIR,

HIMACHAL PRADESH,

PUNJAB,

CHANDIGARH,

UTTARAKHAND,

HARYANA,

DELHI,

RAJASTHAN,

UTTAR PRADESH,

BIHAR,

SIKKIM,

ARUNACHAL PRADESH,

NAGALAND,

MANIPUR,

MIZORAM,

TRIPURA,

MEGHALAYA,

ASSAM,

WEST BENGAL,

JHARKHAND,

ODISHA,

CHHATTISGARH,

MADHYA PRADESH,

GUJARAT,

DADRA & NAGAR HAVELI & DAMAN & DIU,

MAHARASHTRA,

ANDHRAPRADESH(BEFOREADDED),

KARNATAKA,

GOA,

LAKSHWADEEP,

KERALA,

TAMIL NADU,

PUDUCHERRY,

ANDAMAN & NICOBAR,

TELANGANA,

ANDHRA PRADESH,

LADAKH(NEWLYADDED),

OTHER TERRITORY

Example:

"State Name"

party.shipping_address.country

enum<string>

required

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

Afghanistan,

Albania,

Algeria,

Andorra,

Angola,

Antigua and Barbuda,

Argentina,

Armenia,

Australia,

Austria,

Azerbaijan,

Bahamas,

Bahrain,

Bangladesh,

Barbados,

Belarus,

Belgium,

Belize,

Benin,

Bhutan,

Bolivia,

Bosnia and Herzegovina,

Botswana,

Brazil,

Brunei,

Bulgaria,

Burkina Faso,

Burundi,

Cabo Verde,

Cambodia,

Cameroon,

Canada,

Central African Republic,

Chad,

Chile,

China,

Colombia,

Comoros,

Congo, Democratic Republic of the,

Congo, Republic of the,

Costa Rica,

Croatia,

Cuba,

Cyprus,

Czechia,

Denmark,

Djibouti,

Dominica,

Dominican Republic,

Ecuador,

Egypt,

El Salvador,

Equatorial Guinea,

Eritrea,

Estonia,

Eswatini,

Ethiopia,

Fiji,

Finland,

France,

Gabon,

Gambia,

Georgia,

Germany,

Ghana,

Greece,

Grenada,

Guatemala,

Guinea,

Guinea-Bissau,

Guyana,

Haiti,

Honduras,

Hungary,

Iceland,

India,

Indonesia,

Iran,

Iraq,

Ireland,

Israel,

Italy,

Jamaica,

Japan,

Jordan,

Kazakhstan,

Kenya,

Kiribati,

Korea, North,

Korea, South,

Kosovo,

Kuwait,

Kyrgyzstan,

Laos,

Latvia,

Lebanon,

Lesotho,

Liberia,

Libya,

Liechtenstein,

Lithuania,

Luxembourg,

Madagascar,

Malawi,

Malaysia,

Maldives,

Mali,

Malta,

Marshall Islands,

Mauritania,

Mauritius,

Mexico,

Micronesia,

Moldova,

Monaco,

Mongolia,

Montenegro,

Morocco,

Mozambique,

Myanmar,

Namibia,

Nauru,

Nepal,

Netherlands,

New Zealand,

Nicaragua,

Niger,

Nigeria,

North Macedonia,

Norway,

Oman,

Pakistan,

Palau,

Palestine,

Panama,

Papua New Guinea,

Paraguay,

Peru,

Philippines,

Poland,

Portugal,

Qatar,

Romania,

Russia,

Rwanda,

Saint Kitts and Nevis,

Saint Lucia,

Saint Vincent and the Grenadines,

Samoa,

San Marino,

Sao Tome and Principe,

Saudi Arabia,

Senegal,

Serbia,

Seychelles,

Sierra Leone,

Singapore,

Slovakia,

Slovenia,

Solomon Islands,

Somalia,

South Africa,

South Sudan,

Spain,

Sri Lanka,

Sudan,

Suriname,

Sweden,

Switzerland,

Syria,

Taiwan,

Tajikistan,

Tanzania,

Thailand,

Timor-Leste,

Togo,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Turkmenistan,

Tuvalu,

Uganda,

Ukraine,

United Arab Emirates,

United Kingdom,

United States,

Uruguay,

Uzbekistan,

Vanuatu,

Vatican City,

Venezuela,

Vietnam,

Yemen,

Zambia,

Zimbabwe

Example:

"Country Name"

party.shipping_address.pincode

string

required

Pincode

Example:

"123456"

party.billing_address

object

Party billing to Address, refer Shipping Address Object for parameters

party.billing_address.addr_id

integer

required

Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.

Example:

-1

party.billing_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

party.billing_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

party.billing_address.city

string

required

City

Example:

"City Name"

party.billing_address.state

enum<string>

required

State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

JAMMU AND KASHMIR,

HIMACHAL PRADESH,

PUNJAB,

CHANDIGARH,

UTTARAKHAND,

HARYANA,

DELHI,

RAJASTHAN,

UTTAR PRADESH,

BIHAR,

SIKKIM,

ARUNACHAL PRADESH,

NAGALAND,

MANIPUR,

MIZORAM,

TRIPURA,

MEGHALAYA,

ASSAM,

WEST BENGAL,

JHARKHAND,

ODISHA,

CHHATTISGARH,

MADHYA PRADESH,

GUJARAT,

DADRA & NAGAR HAVELI & DAMAN & DIU,

MAHARASHTRA,

ANDHRAPRADESH(BEFOREADDED),

KARNATAKA,

GOA,

LAKSHWADEEP,

KERALA,

TAMIL NADU,

PUDUCHERRY,

ANDAMAN & NICOBAR,

TELANGANA,

ANDHRA PRADESH,

LADAKH(NEWLYADDED),

OTHER TERRITORY

Example:

"State Name"

party.billing_address.country

enum<string>

required

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

Afghanistan,

Albania,

Algeria,

Andorra,

Angola,

Antigua and Barbuda,

Argentina,

Armenia,

Australia,

Austria,

Azerbaijan,

Bahamas,

Bahrain,

Bangladesh,

Barbados,

Belarus,

Belgium,

Belize,

Benin,

Bhutan,

Bolivia,

Bosnia and Herzegovina,

Botswana,

Brazil,

Brunei,

Bulgaria,

Burkina Faso,

Burundi,

Cabo Verde,

Cambodia,

Cameroon,

Canada,

Central African Republic,

Chad,

Chile,

China,

Colombia,

Comoros,

Congo, Democratic Republic of the,

Congo, Republic of the,

Costa Rica,

Croatia,

Cuba,

Cyprus,

Czechia,

Denmark,

Djibouti,

Dominica,

Dominican Republic,

Ecuador,

Egypt,

El Salvador,

Equatorial Guinea,

Eritrea,

Estonia,

Eswatini,

Ethiopia,

Fiji,

Finland,

France,

Gabon,

Gambia,

Georgia,

Germany,

Ghana,

Greece,

Grenada,

Guatemala,

Guinea,

Guinea-Bissau,

Guyana,

Haiti,

Honduras,

Hungary,

Iceland,

India,

Indonesia,

Iran,

Iraq,

Ireland,

Israel,

Italy,

Jamaica,

Japan,

Jordan,

Kazakhstan,

Kenya,

Kiribati,

Korea, North,

Korea, South,

Kosovo,

Kuwait,

Kyrgyzstan,

Laos,

Latvia,

Lebanon,

Lesotho,

Liberia,

Libya,

Liechtenstein,

Lithuania,

Luxembourg,

Madagascar,

Malawi,

Malaysia,

Maldives,

Mali,

Malta,

Marshall Islands,

Mauritania,

Mauritius,

Mexico,

Micronesia,

Moldova,

Monaco,

Mongolia,

Montenegro,

Morocco,

Mozambique,

Myanmar,

Namibia,

Nauru,

Nepal,

Netherlands,

New Zealand,

Nicaragua,

Niger,

Nigeria,

North Macedonia,

Norway,

Oman,

Pakistan,

Palau,

Palestine,

Panama,

Papua New Guinea,

Paraguay,

Peru,

Philippines,

Poland,

Portugal,

Qatar,

Romania,

Russia,

Rwanda,

Saint Kitts and Nevis,

Saint Lucia,

Saint Vincent and the Grenadines,

Samoa,

San Marino,

Sao Tome and Principe,

Saudi Arabia,

Senegal,

Serbia,

Seychelles,

Sierra Leone,

Singapore,

Slovakia,

Slovenia,

Solomon Islands,

Somalia,

South Africa,

South Sudan,

Spain,

Sri Lanka,

Sudan,

Suriname,

Sweden,

Switzerland,

Syria,

Taiwan,

Tajikistan,

Tanzania,

Thailand,

Timor-Leste,

Togo,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Turkmenistan,

Tuvalu,

Uganda,

Ukraine,

United Arab Emirates,

United Kingdom,

United States,

Uruguay,

Uzbekistan,

Vanuatu,

Vatican City,

Venezuela,

Vietnam,

Yemen,

Zambia,

Zimbabwe

Example:

"Country Name"

party.billing_address.pincode

string

required

Pincode

Example:

"123456"

due_date

string

DD-MM-YYYY

Example:

"11-06-2024"

reference

string

Any references you want to add to the doc

Example:

"Reference Text"

notes

string

Notes to show in invoice - please check template in swipe application to see where this is displayed

Example:

"Notes for the document"

terms

string

Terms to show in invoice - please check template in swipe application to see where this is displayed

Example:

"Terms and Conditions"

extra_discount

number

Adjustment on overall invoice, doesn’t effect any tax amounts.

Example:

20

round_off

boolean

default:false

Should Round Off total amount

Example:

true

bank_details

object

Bank Details, it is used to display bank details in document PDFs. No payments are associated with these bank details.

tds_id

integer

You can check the tds id and details mapping from https://developers.getswipe.in/api-reference/references#tds-tax-deducted-at-source

tcs_id

integer

You can check the tcs id and details mapping from https://developers.getswipe.in/api-reference/references#tcs-tax-collected-at-source

charges_and_deductions

object[]

Array of Charges and Deductions, refer Additional Charges Deductions Object for parameters

company_shipping_address

object

Company shipping from Address, refer Shipping Address Object for parameters

company_shipping_address.addr_id

integer

required

Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.

Example:

-1

company_shipping_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

company_shipping_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

company_shipping_address.city

string

required

City

Example:

"City Name"

company_shipping_address.state

enum<string>

required

State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

JAMMU AND KASHMIR,

HIMACHAL PRADESH,

PUNJAB,

CHANDIGARH,

UTTARAKHAND,

HARYANA,

DELHI,

RAJASTHAN,

UTTAR PRADESH,

BIHAR,

SIKKIM,

ARUNACHAL PRADESH,

NAGALAND,

MANIPUR,

MIZORAM,

TRIPURA,

MEGHALAYA,

ASSAM,

WEST BENGAL,

JHARKHAND,

ODISHA,

CHHATTISGARH,

MADHYA PRADESH,

GUJARAT,

DADRA & NAGAR HAVELI & DAMAN & DIU,

MAHARASHTRA,

ANDHRAPRADESH(BEFOREADDED),

KARNATAKA,

GOA,

LAKSHWADEEP,

KERALA,

TAMIL NADU,

PUDUCHERRY,

ANDAMAN & NICOBAR,

TELANGANA,

ANDHRA PRADESH,

LADAKH(NEWLYADDED),

OTHER TERRITORY

Example:

"State Name"

company_shipping_address.country

enum<string>

required

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

Afghanistan,

Albania,

Algeria,

Andorra,

Angola,

Antigua and Barbuda,

Argentina,

Armenia,

Australia,

Austria,

Azerbaijan,

Bahamas,

Bahrain,

Bangladesh,

Barbados,

Belarus,

Belgium,

Belize,

Benin,

Bhutan,

Bolivia,

Bosnia and Herzegovina,

Botswana,

Brazil,

Brunei,

Bulgaria,

Burkina Faso,

Burundi,

Cabo Verde,

Cambodia,

Cameroon,

Canada,

Central African Republic,

Chad,

Chile,

China,

Colombia,

Comoros,

Congo, Democratic Republic of the,

Congo, Republic of the,

Costa Rica,

Croatia,

Cuba,

Cyprus,

Czechia,

Denmark,

Djibouti,

Dominica,

Dominican Republic,

Ecuador,

Egypt,

El Salvador,

Equatorial Guinea,

Eritrea,

Estonia,

Eswatini,

Ethiopia,

Fiji,

Finland,

France,

Gabon,

Gambia,

Georgia,

Germany,

Ghana,

Greece,

Grenada,

Guatemala,

Guinea,

Guinea-Bissau,

Guyana,

Haiti,

Honduras,

Hungary,

Iceland,

India,

Indonesia,

Iran,

Iraq,

Ireland,

Israel,

Italy,

Jamaica,

Japan,

Jordan,

Kazakhstan,

Kenya,

Kiribati,

Korea, North,

Korea, South,

Kosovo,

Kuwait,

Kyrgyzstan,

Laos,

Latvia,

Lebanon,

Lesotho,

Liberia,

Libya,

Liechtenstein,

Lithuania,

Luxembourg,

Madagascar,

Malawi,

Malaysia,

Maldives,

Mali,

Malta,

Marshall Islands,

Mauritania,

Mauritius,

Mexico,

Micronesia,

Moldova,

Monaco,

Mongolia,

Montenegro,

Morocco,

Mozambique,

Myanmar,

Namibia,

Nauru,

Nepal,

Netherlands,

New Zealand,

Nicaragua,

Niger,

Nigeria,

North Macedonia,

Norway,

Oman,

Pakistan,

Palau,

Palestine,

Panama,

Papua New Guinea,

Paraguay,

Peru,

Philippines,

Poland,

Portugal,

Qatar,

Romania,

Russia,

Rwanda,

Saint Kitts and Nevis,

Saint Lucia,

Saint Vincent and the Grenadines,

Samoa,

San Marino,

Sao Tome and Principe,

Saudi Arabia,

Senegal,

Serbia,

Seychelles,

Sierra Leone,

Singapore,

Slovakia,

Slovenia,

Solomon Islands,

Somalia,

South Africa,

South Sudan,

Spain,

Sri Lanka,

Sudan,

Suriname,

Sweden,

Switzerland,

Syria,

Taiwan,

Tajikistan,

Tanzania,

Thailand,

Timor-Leste,

Togo,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Turkmenistan,

Tuvalu,

Uganda,

Ukraine,

United Arab Emirates,

United Kingdom,

United States,

Uruguay,

Uzbekistan,

Vanuatu,

Vatican City,

Venezuela,

Vietnam,

Yemen,

Zambia,

Zimbabwe

Example:

"Country Name"

company_shipping_address.pincode

string

required

Pincode

Example:

"123456"

company_billing_address

object

Company billing Address, refer Billing Address Object for parameters

company_billing_address.addr_id

integer

required

Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.

Example:

-1

company_billing_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

company_billing_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

company_billing_address.city

string

required

City

Example:

"City Name"

company_billing_address.state

enum<string>

required

State. Select OTHER TERRITORY for countries other than India. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

JAMMU AND KASHMIR,

HIMACHAL PRADESH,

PUNJAB,

CHANDIGARH,

UTTARAKHAND,

HARYANA,

DELHI,

RAJASTHAN,

UTTAR PRADESH,

BIHAR,

SIKKIM,

ARUNACHAL PRADESH,

NAGALAND,

MANIPUR,

MIZORAM,

TRIPURA,

MEGHALAYA,

ASSAM,

WEST BENGAL,

JHARKHAND,

ODISHA,

CHHATTISGARH,

MADHYA PRADESH,

GUJARAT,

DADRA & NAGAR HAVELI & DAMAN & DIU,

MAHARASHTRA,

ANDHRAPRADESH(BEFOREADDED),

KARNATAKA,

GOA,

LAKSHWADEEP,

KERALA,

TAMIL NADU,

PUDUCHERRY,

ANDAMAN & NICOBAR,

TELANGANA,

ANDHRA PRADESH,

LADAKH(NEWLYADDED),

OTHER TERRITORY

Example:

"State Name"

company_billing_address.country

enum<string>

required

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

Afghanistan,

Albania,

Algeria,

Andorra,

Angola,

Antigua and Barbuda,

Argentina,

Armenia,

Australia,

Austria,

Azerbaijan,

Bahamas,

Bahrain,

Bangladesh,

Barbados,

Belarus,

Belgium,

Belize,

Benin,

Bhutan,

Bolivia,

Bosnia and Herzegovina,

Botswana,

Brazil,

Brunei,

Bulgaria,

Burkina Faso,

Burundi,

Cabo Verde,

Cambodia,

Cameroon,

Canada,

Central African Republic,

Chad,

Chile,

China,

Colombia,

Comoros,

Congo, Democratic Republic of the,

Congo, Republic of the,

Costa Rica,

Croatia,

Cuba,

Cyprus,

Czechia,

Denmark,

Djibouti,

Dominica,

Dominican Republic,

Ecuador,

Egypt,

El Salvador,

Equatorial Guinea,

Eritrea,

Estonia,

Eswatini,

Ethiopia,

Fiji,

Finland,

France,

Gabon,

Gambia,

Georgia,

Germany,

Ghana,

Greece,

Grenada,

Guatemala,

Guinea,

Guinea-Bissau,

Guyana,

Haiti,

Honduras,

Hungary,

Iceland,

India,

Indonesia,

Iran,

Iraq,

Ireland,

Israel,

Italy,

Jamaica,

Japan,

Jordan,

Kazakhstan,

Kenya,

Kiribati,

Korea, North,

Korea, South,

Kosovo,

Kuwait,

Kyrgyzstan,

Laos,

Latvia,

Lebanon,

Lesotho,

Liberia,

Libya,

Liechtenstein,

Lithuania,

Luxembourg,

Madagascar,

Malawi,

Malaysia,

Maldives,

Mali,

Malta,

Marshall Islands,

Mauritania,

Mauritius,

Mexico,

Micronesia,

Moldova,

Monaco,

Mongolia,

Montenegro,

Morocco,

Mozambique,

Myanmar,

Namibia,

Nauru,

Nepal,

Netherlands,

New Zealand,

Nicaragua,

Niger,

Nigeria,

North Macedonia,

Norway,

Oman,

Pakistan,

Palau,

Palestine,

Panama,

Papua New Guinea,

Paraguay,

Peru,

Philippines,

Poland,

Portugal,

Qatar,

Romania,

Russia,

Rwanda,

Saint Kitts and Nevis,

Saint Lucia,

Saint Vincent and the Grenadines,

Samoa,

San Marino,

Sao Tome and Principe,

Saudi Arabia,

Senegal,

Serbia,

Seychelles,

Sierra Leone,

Singapore,

Slovakia,

Slovenia,

Solomon Islands,

Somalia,

South Africa,

South Sudan,

Spain,

Sri Lanka,

Sudan,

Suriname,

Sweden,

Switzerland,

Syria,

Taiwan,

Tajikistan,

Tanzania,

Thailand,

Timor-Leste,

Togo,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Turkmenistan,

Tuvalu,

Uganda,

Ukraine,

United Arab Emirates,

United Kingdom,

United States,

Uruguay,

Uzbekistan,

Vanuatu,

Vatican City,

Venezuela,

Vietnam,

Yemen,

Zambia,

Zimbabwe

Example:

"Country Name"

company_billing_address.pincode

string

required

Pincode

Example:

"123456"

is_export

boolean

Is Export

Example:

false

export_invoice_details

object

Export Invoice Details

export_invoice_details.export_type

enum<string>

required

Export Type

Available options:

Export under bond/LUT,

Export with IGST,

SEZ with IGST Payment,

SEZ without IGST Payment,

Deemed Export

Example:

"With Payment of Tax"

export_invoice_details.conversion_factor

number

required

The conversion factor represents the rate used to convert foreign currencies into Indian rupees. For example, if you're invoicing in dollars, and 1 dollar equals 84 rupees, the conversion factor would be 84

export_invoice_details.shipping_bill_date

string

Shipping Bill Date [DD-MM-YYYY]

Example:

"14-02-2024"

export_invoice_details.shipping_bill_number

string

Shipping Bill Number

Example:

"123456"

export_invoice_details.shipping_port_code

string

Shipping Port Code

Example:

"123456"

export_invoice_details.country_id

enum<string>

Country ID

Available options:

Afghanistan,

Albania,

Algeria,

Andorra,

Angola,

Antigua and Barbuda,

Argentina,

Armenia,

Australia,

Austria,

Azerbaijan,

Bahamas,

Bahrain,

Bangladesh,

Barbados,

Belarus,

Belgium,

Belize,

Benin,

Bhutan,

Bolivia,

Bosnia and Herzegovina,

Botswana,

Brazil,

Brunei,

Bulgaria,

Burkina Faso,

Burundi,

Cabo Verde,

Cambodia,

Cameroon,

Canada,

Central African Republic,

Chad,

Chile,

China,

Colombia,

Comoros,

Congo, Democratic Republic of the,

Congo, Republic of the,

Costa Rica,

Croatia,

Cuba,

Cyprus,

Czechia,

Denmark,

Djibouti,

Dominica,

Dominican Republic,

Ecuador,

Egypt,

El Salvador,

Equatorial Guinea,

Eritrea,

Estonia,

Eswatini,

Ethiopia,

Fiji,

Finland,

France,

Gabon,

Gambia,

Georgia,

Germany,

Ghana,

Greece,

Grenada,

Guatemala,

Guinea,

Guinea-Bissau,

Guyana,

Haiti,

Honduras,

Hungary,

Iceland,

India,

Indonesia,

Iran,

Iraq,

Ireland,

Israel,

Italy,

Jamaica,

Japan,

Jordan,

Kazakhstan,

Kenya,

Kiribati,

Korea, North,

Korea, South,

Kosovo,

Kuwait,

Kyrgyzstan,

Laos,

Latvia,

Lebanon,

Lesotho,

Liberia,

Libya,

Liechtenstein,

Lithuania,

Luxembourg,

Madagascar,

Malawi,

Malaysia,

Maldives,

Mali,

Malta,

Marshall Islands,

Mauritania,

Mauritius,

Mexico,

Micronesia,

Moldova,

Monaco,

Mongolia,

Montenegro,

Morocco,

Mozambique,

Myanmar,

Namibia,

Nauru,

Nepal,

Netherlands,

New Zealand,

Nicaragua,

Niger,

Nigeria,

North Macedonia,

Norway,

Oman,

Pakistan,

Palau,

Palestine,

Panama,

Papua New Guinea,

Paraguay,

Peru,

Philippines,

Poland,

Portugal,

Qatar,

Romania,

Russia,

Rwanda,

Saint Kitts and Nevis,

Saint Lucia,

Saint Vincent and the Grenadines,

Samoa,

San Marino,

Sao Tome and Principe,

Saudi Arabia,

Senegal,

Serbia,

Seychelles,

Sierra Leone,

Singapore,

Slovakia,

Slovenia,

Solomon Islands,

Somalia,

South Africa,

South Sudan,

Spain,

Sri Lanka,

Sudan,

Suriname,

Sweden,

Switzerland,

Syria,

Taiwan,

Tajikistan,

Tanzania,

Thailand,

Timor-Leste,

Togo,

Tonga,

Trinidad and Tobago,

Tunisia,

Turkey,

Turkmenistan,

Tuvalu,

Uganda,

Ukraine,

United Arab Emirates,

United Kingdom,

United States,

Uruguay,

Uzbekistan,

Vanuatu,

Vatican City,

Venezuela,

Vietnam,

Yemen,

Zambia,

Zimbabwe

Example:

"Afghanistan"

export_invoice_details.currency_id

enum<string>

Currency ID, if not provided, the default country currency will be used, please refer to the currency list from https://developers.getswipe.in/api-reference/references#currency-details

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

FOK,

GBP,

GEL,

GGP,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

IMP,

INR,

IQD,

IRR,

ISK,

JEP,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KID,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TVD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XDR,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

Example:

"AED"

Response

200

application/json

Success

success

boolean

default:true

Example:

true

message

string

Success Message

Example:

"Message"

error_code

string

Error Code

Example:

""

errors

object

Error details

data

object

Get document PDF Cancel a document

curl --request PUT \
  --url https://app.getswipe.in/api/partner/v2/doc/{doc_hash_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "serial_number": "INV123",
  "serial_number_v2": {
    "prefix": "INV",
    "doc_number": 1,
    "suffix": "2024"
  },
  "document_type": "invoice",
  "document_date": "11-06-2024",
  "party": {
    "id": "CUST123",
    "type": "customer",
    "name": "John Doe",
    "country_code": "91",
    "phone_number": "1234567890",
    "company_name": "Company Name",
    "email": "johndoe@example.com",
    "gstin": "27AARCS7202C1ZD",
    "shipping_address": {
      "addr_id": -1,
      "address_line1": "123 Street",
      "address_line2": "Apt 4B",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "pincode": "123456"
    },
    "billing_address": {
      "addr_id": -1,
      "address_line1": "123 Street",
      "address_line2": "Apt 4B",
      "city": "City Name",
      "state": "State Name",
      "country": "Country Name",
      "pincode": "123456"
    }
  },
  "due_date": "11-06-2024",
  "reference": "Reference Text",
  "notes": "Notes for the document",
  "terms": "Terms and Conditions",
  "items": [
    {
      "id": "ITEM123",
      "name": "Item Name",
      "quantity": 1,
      "unit_price": 100,
      "tax_rate": 18,
      "price_with_tax": 118,
      "net_amount": 100,
      "total_amount": 118,
      "discount_percent": 10,
      "discount_amount": 10,
      "description": "Item Description",
      "hsn_code": "1234",
      "item_type": "Product",
      "unit": "kg",
      "category": "Electronics",
      "custom_columns": [
        {
          "label": "Custom Field 1",
          "value": "Value 1"
        }
      ]
    }
  ],
  "extra_discount": 20,
  "round_off": true,
  "bank_details": {
    "account_number": "1234567890",
    "ifsc": "SBIN0000001",
    "bank_name": "State Bank of India",
    "branch": "Mumbai"
  },
  "tds_id": 123,
  "tcs_id": 123,
  "charges_and_deductions": [
    {
      "id": 1,
      "name": "Delivery Charge",
      "amount": 100,
      "tax_rate": 18,
      "sac_code": "1234",
      "type": "charge"
    }
  ],
  "company_shipping_address": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "company_billing_address": {
    "addr_id": -1,
    "address_line1": "123 Street",
    "address_line2": "Apt 4B",
    "city": "City Name",
    "state": "State Name",
    "country": "Country Name",
    "pincode": "123456"
  },
  "is_export": false,
  "export_invoice_details": {
    "shipping_bill_date": "14-02-2024",
    "shipping_bill_number": "123456",
    "shipping_port_code": "123456",
    "export_type": "With Payment of Tax",
    "conversion_factor": 123,
    "country_id": "Afghanistan",
    "currency_id": "AED"
  }
}'

{
  "success": true,
  "message": "Message",
  "error_code": "",
  "errors": {},
  "data": {
    "hash_id": "SL123",
    "serial_number": "SL123",
    "irn": "<string>",
    "qr_code": "<string>"
  }
}

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Subscriptions V2

Utility V2

Edit a document

Authorizations

Path Parameters

Body

Response