Create a document

POST

doc

object

serial_number

string

serial_number_v2

object

prefix

string

doc_number

integer

suffix

string

document_type

enum<string>

document_date

string

party

object

string

type

enum<string>

name

string

country_code

string

phone_number

string

company_name

string

gstin

string

shipping_address

object

addr_id

integer

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

billing_address

object

addr_id

integer

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

due_date

string

reference

string

notes

string

terms

string

items

array

extra_discount

number

round_off

boolean

payments

array

tds_id

integer

tcs_id

integer

charges_and_deductions

array

company_shipping_address

object

addr_id

integer

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

company_billing_address

object

addr_id

integer

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

einvoice

boolean

is_export

boolean

export_invoice_details

object

shipping_bill_date

string

shipping_bill_number

string

shipping_port_code

string

export_type

enum<string>

conversion_factor

number

country_id

enum<string>

currency_id

enum<string>

is_subscription

boolean

subscription_details

object

start_time

string

end_time

string

repeat

integer

repeat_type

enum<string>

send_email

boolean

send_sms

boolean

convert

object

convert_from

enum<string>

hash_id

string

custom_headers

array

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/doc \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document_type": "invoice",
  "document_date": "15-11-2024",
  "party": {
    "id": "CUST123",
    "type": "customer",
    "name": "John Doe",
    "due_date": "15-11-2024"
  },
  "items": [
    {
      "id": "ITEM123455667ghg",
      "name": "Item Namgergggree",
      "quantity": 1,
      "unit_price": 200,
      "tax_rate": 18,
      "price_with_tax": 236,
      "net_amount": 200,
      "total_amount": 236,
      "item_type": "Product"
    }
  ]
}'

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

headerrequired

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

document_date

string

required

DD-MM-YYYY

items

object[]

required

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

serial_number

string

Serial Number (deprecated, please use New Serial Number)

serial_number_v2

object

party

object

Party

party.id

string

required

Unique id for each party.

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

party.name

string

required

Name of the Party

party.country_code

string

Party Phone Number Country code

party.phone_number

string

Party Phone Number

party.company_name

string

Company Name

party.email

string

Party Email

party.gstin

string

GSTIN

party.shipping_address

object

Party shipping to Address, refer Shipping Address Object for parameters

party.billing_address

object

Party billing to Address, refer Shipping Address Object for parameters

due_date

string

DD-MM-YYYY

reference

string

Any references you want to add to the doc

notes

string

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

terms

string

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

extra_discount

number

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

round_off

boolean

default: false

Should Round Off total amount

payments

object[]

Array of Payments, refer Payment Object for parameters

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_billing_address

object

Company billing Address, refer Billing Address Object for parameters

einvoice

boolean

Generate einvoice

is_export

boolean

Is Export

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

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]

export_invoice_details.shipping_bill_number

string

Shipping Bill Number

export_invoice_details.shipping_port_code

string

Shipping Port Code

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

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

is_subscription

boolean

Is Subscription

subscription_details

object

Subscription Details

convert

object

Convert Document. Needed only when the document is already created and you want to convert it to another document

custom_headers

object[]

Document Custom Headers. Custom headers should already be added in Swipe Portal.

Response

200 - application/json

success

boolean

default: true

message

string

Success Message

error_code

string

Error Code

errors

object

Error details

data

object

Update customer mapping Get a document

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/doc \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document_type": "invoice",
  "document_date": "15-11-2024",
  "party": {
    "id": "CUST123",
    "type": "customer",
    "name": "John Doe",
    "due_date": "15-11-2024"
  },
  "items": [
    {
      "id": "ITEM123455667ghg",
      "name": "Item Namgergggree",
      "quantity": 1,
      "unit_price": 200,
      "tax_rate": 18,
      "price_with_tax": 236,
      "net_amount": 200,
      "total_amount": 236,
      "item_type": "Product"
    }
  ]
}'

API Documentation

Document

Customer

Payment

Product

Subscriptions

Utility

Customer V2

Document V2

Payment V2

Product V2

Create a document

Authorizations

Body

Response