Get Started
Document V2
Payment V2
Customer V2
Vendor V2
Product V2
Subscriptions V2
Utility V2
Create 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",
"due_date": "15-11-2024",
"party": {
"id": "CUST123",
"type": "customer",
"name": "John Doe"
},
"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"
}
]
}'
{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {
"hash_id": "SL123",
"serial_number": "SL123",
"irn": "<string>",
"qr_code": "<string>"
}
}
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Value should always be the string 'invoice'
invoice
, subscription
, pro_forma_invoice
, estimate
, sales_return
, purchase_return
"invoice"
DD-MM-YYYY
"11-06-2024"
Array of Products/Services, refer Item Object below for parameters
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
"ITEM123"
Name of the Product
"Item Name"
Quantity
1
Price per item without Tax
100
Price per item with Tax
118
Net Amount
100
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.
118
Product or Service enum
Product
, Service
"Product"
Tax percentage for each item . Only valid tax rates are accepted
18
Discount Percent
10
Discount Amount, will be ignored if discount_percent is provided
10
Item Description
"Item Description"
HSN Code. HSN Code can only be of length 4,6 & 8
"1234"
Item quantity unit. You can find the GST-approved units in the UQC Codes section at: https://einvoice1.gst.gov.in/Others/MasterCodes.
"kg"
Category
"Electronics"
Serial Number (deprecated, please use New Serial Number)
"INV123"
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.
Unique id for each party.
"CUST123"
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, .
customer
, vendor
"customer"
Name of the Party
"John Doe"
Party Phone Number Country code
"91"
Party Phone Number
"1234567890"
Company Name
"Company Name"
Party Email
"johndoe@example.com"
GSTIN
"27AARCS7202C1ZD"
Party shipping to Address, refer Shipping Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
-1
Address Line 1
"123 Street"
Address Line 2
"Apt 4B"
City
"City Name"
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
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
"State Name"
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
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
"Country Name"
Pincode
"123456"
Party billing to Address, refer Shipping Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
-1
Address Line 1
"123 Street"
Address Line 2
"Apt 4B"
City
"City Name"
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
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
"State Name"
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
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
"Country Name"
Pincode
"123456"
DD-MM-YYYY
"11-06-2024"
Any references you want to add to the doc
"Reference Text"
Notes to show in invoice - please check template in swipe application to see where this is displayed
"Notes for the document"
Terms to show in invoice - please check template in swipe application to see where this is displayed
"Terms and Conditions"
Adjustment on overall invoice, doesn’t effect any tax amounts.
20
Should Round Off total amount
true
Array of Payments, refer Payment Object for parameters
Payment Amount
100
Payment method, use only specified values
cash
, card
, upi
, netBanking
, cheque
, emi
"upi"
Any internal notes for payment
"Payment notes"
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. It will link document payments to your company bank details.
Account Number
"1234567890"
IFSC Code
"SBIN0000001"
Bank Name
"State Bank of India"
Branch
"Mumbai"
Bank Details, it is used to display bank details in document PDFs. No payments are associated with these bank details.
You can check the tds id and details mapping from https://developers.getswipe.in/api-reference/references#tds-tax-deducted-at-source
You can check the tcs id and details mapping from https://developers.getswipe.in/api-reference/references#tcs-tax-collected-at-source
Array of Charges and Deductions, refer Additional Charges Deductions Object for parameters
Unique ID for the charge/deduction. 0 < id <= 999999
1
Name of the charge/deduction.
"Delivery Charge"
Total Amount
100
Tax Rate
18
Type
charge
, deduction
"charge"
SAC Code
"1234"
Company shipping from Address, refer Shipping Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
-1
Address Line 1
"123 Street"
Address Line 2
"Apt 4B"
City
"City Name"
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
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
"State Name"
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
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
"Country Name"
Pincode
"123456"
Company billing Address, refer Billing Address Object for parameters
Address ID. Value should be n >= 0 and n <= 999999, It will automatically update the existing address if the address ID already exists.
-1
Address Line 1
"123 Street"
Address Line 2
"Apt 4B"
City
"City Name"
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
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
"State Name"
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
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
"Country Name"
Pincode
"123456"
Generate einvoice
false
Is Export
false
Export Invoice Details
Export Type
Export under bond/LUT
, Export with IGST
, SEZ with IGST Payment
, SEZ without IGST Payment
, Deemed Export
"With Payment of Tax"
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
Shipping Bill Date [DD-MM-YYYY]
"14-02-2024"
Shipping Bill Number
"123456"
Shipping Port Code
"123456"
Country ID
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
"Afghanistan"
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
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
"AED"
Is Subscription
false
Subscription Details
Start Time [DD-MM-YYYY]
"1919-08-17T00:00:00.000Z"
End Time [DD-MM-YYYY]
"1919-08-18T00:00:00.000Z"
Repeat in value, Frequency of the repetition
1
Repeat type, Entity of the repetition
days
, weeks
, months
, years
"days"
Convert Document. Needed only when the document is already created and you want to convert it to another document
Response
true
Success Message
"Message"
Error Code
""
Error details
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",
"due_date": "15-11-2024",
"party": {
"id": "CUST123",
"type": "customer",
"name": "John Doe"
},
"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"
}
]
}'
{
"success": true,
"message": "Message",
"error_code": "",
"errors": {},
"data": {
"hash_id": "SL123",
"serial_number": "SL123",
"irn": "<string>",
"qr_code": "<string>"
}
}