Create a document

POST

doc

curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/doc \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document_type": "invoice",
  "document_date": "01-04-2024",
  "customer": {
    "id": "cus123",
    "name": "Charan Cus"
  },
  "items": [
    {
      "id": "p123",
      "name": "Book",
      "item_type": "goods",
      "quantity": 1,
      "unit_price": 100,
      "tax_rate": 18,
      "price_with_tax": 118,
      "net_amount": 100,
      "total_amount": 118
    }
  ]
}'

{
  "success": true,
  "message": "Document created successfully",
  "serialNumber": "SL123",
  "hashId": "SL123",
  "irn": "SL123",
  "qrCode": "",
  "einvoiceSuccess": true,
  "einvoiceMessage": "true"
}

Customer id and Product id should be unique, if a new id is sent, a new Customer/Product with given details will be automatically created. For Product If an existing id is sent, the details will not override the original product details. They will be applicable only to the current document. For updating the product details, use the update product API

Authorizations

Authorization

string

header

required

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

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, Invoice date (Ex: 11-06-2024 Need not to the current date)

Example:

"11-06-2024"

items

object[]

required

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

serial_number

string

Serial Number, if not sent will be auto generated based on the default prefix.

Example:

"INV123"

customer

object

Customer (deprecated, please use Party). If there are any changes made to the customer's details, we will update those details and any documents linked to this customer's ID will be updated to reflect the changes.

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.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.shipping_address.addr_id

integer

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.addr_id_v2

string

Address ID. It must be alphanumeric, not empty, and up to 16 characters long.

Example:

"addr1"

party.billing_address

object

Party billing to Address, refer Shipping Address Object for parameters

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"

party.billing_address.addr_id

integer

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.addr_id_v2

string

Address ID. It must be alphanumeric, not empty, and up to 16 characters long.

Example:

"addr1"

due_date

string

DD-MM-YYYY, Payment Due date for the invoice (Ex: 11-06-2024)

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

Example:

"Notes for the document"

terms

string

Terms to show in invoice

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

payments

object[]

Array of Payments, refer Payment Object for parameters

bank_details

object

Bank Details, refer Bank Details Object below for parameters, If account_number, ifsc matched with existing bank details, it will be used, else new bank details will be added to your swipe account

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 copy the tcs id and details mapping from https://developers.getswipe.in/api-reference/references#tcs-tax-collected-at-source

company_shipping_address

object

Company shipping from Address, refer Shipping Address Object for parameters

customer_shipping_address

object

Customer shipping to Address, refer Shipping Address Object for parameters

customer_billing_address

object

Customer billing to Address, refer Shipping Address Object for parameters

is_subscription

boolean

Is Subscription

Example:

false

subscription_details

object

Subscription Details

einvoice

boolean

Generate einvoice

Example:

false

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

export_invoice_details.shipping_bill_date

string

export_invoice_details.shipping_bill_number

string

export_invoice_details.shipping_port_code

string

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"

Response

200

application/json

Success

success

boolean

Success

Example:

true

message

string

Message

Example:

"Document created successfully"

serialNumber

string

Serial Number

Example:

"SL123"

hashId

string

Hash ID

Example:

"SL123"

irn

string

IRN

Example:

"SL123"

qrCode

string

QR Code

Example:

""

einvoiceSuccess

boolean

EInvoice Success

Example:

true

einvoiceMessage

string

EInvoice Message

Example:

"true"

Change Log Get document PDF

curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/doc \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document_type": "invoice",
  "document_date": "01-04-2024",
  "customer": {
    "id": "cus123",
    "name": "Charan Cus"
  },
  "items": [
    {
      "id": "p123",
      "name": "Book",
      "item_type": "goods",
      "quantity": 1,
      "unit_price": 100,
      "tax_rate": 18,
      "price_with_tax": 118,
      "net_amount": 100,
      "total_amount": 118
    }
  ]
}'

{
  "success": true,
  "message": "Document created successfully",
  "serialNumber": "SL123",
  "hashId": "SL123",
  "irn": "SL123",
  "qrCode": "",
  "einvoiceSuccess": true,
  "einvoiceMessage": "true"
}

Get Started

Document

Payment

Customer

Product

Subscriptions

Utility

EwayBill

Create a document

Authorizations

Body

Response