Get a document

GET

doc

{doc_hash_id}

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/doc/{doc_hash_id} \
  --header 'Authorization: <api-key>'

{
  "success": true,
  "message": "Details Fetched",
  "error_code": "",
  "errors": {},
  "data": {
    "invoice_details": {
      "serial_number": "INV-12",
      "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,
          "addr_id_v2": "addr1",
          "address_line1": "123 Street",
          "address_line2": "Apt 4B",
          "city": "City Name",
          "state": "State Name",
          "country": "Country Name",
          "pincode": "123456"
        },
        "billing_address": {
          "addr_id": -1,
          "addr_id_v2": "addr1",
          "address_line1": "123 Street",
          "address_line2": "Apt 4B",
          "city": "City Name",
          "state": "State Name",
          "country": "Country Name",
          "pincode": "123456"
        }
      },
      "due_date": "11-06-2024",
      "amount_paid": 28,
      "amount_pending": 90,
      "reference": "<string>",
      "notes": "<string>",
      "terms": "<string>",
      "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"
            }
          ]
        }
      ],
      "is_created_by_recurring": 0,
      "net_amount": 100,
      "hash_id": "<string>",
      "payment_status": "paid",
      "payments": [
        {
          "amount": 100,
          "method": "upi",
          "notes": "Payment notes",
          "bank_details": {
            "account_number": "1234567890",
            "ifsc": "SBIN0000001",
            "bank_name": "State Bank of India",
            "branch": "Mumbai"
          }
        }
      ],
      "tax_amount": 18,
      "total_amount": 118,
      "total_discount": 100
    }
  }
}

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 to be fetched

Response

200

application/json

Success

success

boolean

Success flag

Example:

true

message

string

Message

Example:

"Details Fetched"

error_code

string

Error code

Example:

""

errors

object

Error details

data

object

data.invoice_details

object

data.invoice_details.serial_number

string

Invoice number assigned to document

Example:

"INV-12"

data.invoice_details.document_type

string

Document type

Example:

"invoice"

data.invoice_details.document_date

string

Transaction date [DD-MM-YYYY]

Example:

"11-06-2024"

data.invoice_details.party

object

Party Details for the document

data.invoice_details.party.id

string

required

Unique id for each party.

Example:

"CUST123"

data.invoice_details.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"

data.invoice_details.party.name

string

required

Name of the Party

Example:

"John Doe"

data.invoice_details.party.country_code

string

Party Phone Number Country code

Example:

"91"

data.invoice_details.party.phone_number

string

Party Phone Number

Example:

"1234567890"

data.invoice_details.party.company_name

string

Company Name

Example:

"Company Name"

data.invoice_details.party.email

string

Party Email

Example:

"johndoe@example.com"

data.invoice_details.party.gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

data.invoice_details.party.shipping_address

object

Party shipping to Address, refer Shipping Address Object for parameters

data.invoice_details.party.shipping_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

data.invoice_details.party.shipping_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

data.invoice_details.party.shipping_address.city

string

required

City

Example:

"City Name"

data.invoice_details.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"

data.invoice_details.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"

data.invoice_details.party.shipping_address.pincode

string

required

Pincode

Example:

"123456"

data.invoice_details.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

data.invoice_details.party.shipping_address.addr_id_v2

string

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

Example:

"addr1"

data.invoice_details.party.billing_address

object

Party billing to Address, refer Shipping Address Object for parameters

data.invoice_details.party.billing_address.address_line1

string

required

Address Line 1

Example:

"123 Street"

data.invoice_details.party.billing_address.address_line2

string

required

Address Line 2

Example:

"Apt 4B"

data.invoice_details.party.billing_address.city

string

required

City

Example:

"City Name"

data.invoice_details.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"

data.invoice_details.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"

data.invoice_details.party.billing_address.pincode

string

required

Pincode

Example:

"123456"

data.invoice_details.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

data.invoice_details.party.billing_address.addr_id_v2

string

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

Example:

"addr1"

data.invoice_details.due_date

string

Transaction date [DD-MM-YYYY]

Example:

"11-06-2024"

data.invoice_details.amount_paid

number

Amount Paid for the document

Example:

28

data.invoice_details.amount_pending

number

Remaining amount to be paid for the document

Example:

90

data.invoice_details.reference

string

Reference Text

data.invoice_details.notes

string

Notes for the document

data.invoice_details.terms

string

Terms and Conditions

data.invoice_details.items

object[]

List of items in the document

data.invoice_details.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"

data.invoice_details.items.name

string

required

Name of the Product

Example:

"Item Name"

data.invoice_details.items.quantity

number

required

Quantity

Example:

1

data.invoice_details.items.unit_price

number

required

Price per item without Tax

Example:

100

data.invoice_details.items.price_with_tax

number

required

Price per item with Tax

Example:

118

data.invoice_details.items.net_amount

number

required

Net Amount

Example:

100

data.invoice_details.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

data.invoice_details.items.item_type

enum<string>

required

Product or Service enum

Available options:

Product,

Service

Example:

"Product"

data.invoice_details.items.tax_rate

number

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

Example:

18

data.invoice_details.items.discount_percent

number

Discount Percent

Example:

10

data.invoice_details.items.discount_amount

number

Discount Amount, will be ignored if discount_percent is provided

Example:

10

data.invoice_details.items.description

string

Item Description

Example:

"Item Description"

data.invoice_details.items.hsn_code

string

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

Example:

"1234"

data.invoice_details.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"

data.invoice_details.items.category

string

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Subscriptions V2

Utility V2

Get a document

Authorizations

Path Parameters

Response