---
title: "Get a document"
method: GET
path: "/v2/doc/{doc_hash_id}"
tags: ["Document V2"]
---

# Get a document

`GET /v2/doc/{doc_hash_id}`

## Path parameters

- `doc_hash_id` string, required

## Response `200`

Success

- GetInvoice
  - `success` boolean — Success flag
  - `message` string — Message
  - `error_code` string — Error code
  - `errors` object — Error details
  - `data` GetTransaction
    - `invoice_details` TransactionModelV2
      - `serial_number` string — Invoice number assigned to document
      - `document_type` string — Document type
      - `document_date` string — Transaction date [DD-MM-YYYY]
      - `party` Party
        - `id` string, required — Unique id for each party.
        - `type` 'customer' | 'vendor', 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, .
        - `name` string, required — Name of the Party
        - `country_code` string — Party Phone Number Country code
        - `phone_number` string — Party Phone Number
        - `company_name` string — Company Name
        - `email` string — Party Email
        - `gstin` string — GSTIN
        - `shipping_address` ShippingAddressV2
          - `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.
          - `addr_id_v2` string — Address ID. It must be alphanumeric, not empty, and up to 16 characters long.
          - `address_line1` string, required — Address Line 1
          - `address_line2` string, required — Address Line 2
          - `city` string, required — City
          - `state` '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', 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
          - `country` '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', required — Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
          - `pincode` string, required — Pincode
        - `billing_address` ShippingAddressV2
          - `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.
          - `addr_id_v2` string — Address ID. It must be alphanumeric, not empty, and up to 16 characters long.
          - `address_line1` string, required — Address Line 1
          - `address_line2` string, required — Address Line 2
          - `city` string, required — City
          - `state` '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', 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
          - `country` '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', required — Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
          - `pincode` string, required — Pincode
      - `due_date` string — Transaction date [DD-MM-YYYY]
      - `amount_paid` number — Amount Paid for the document
      - `amount_pending` number — Remaining amount to be paid for the document
      - `reference` string — Reference Text
      - `notes` string — Notes for the document
      - `terms` string — Terms and Conditions
      - `items` DocItemV2[] — List of items in the document
        - `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
        - `name` string, required — Name of the Product
        - `quantity` number, required — Quantity
        - `unit_price` number, required — Price per item without Tax
        - `tax_rate` number — Tax percentage for each item . Only valid tax rates are accepted
        - `price_with_tax` number, required — Price per item with Tax
        - `net_amount` number, required — Net Amount
        - `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.
        - `discount_percent` number — Discount Percent
        - `discount_amount` number — Discount Amount, will be ignored if discount_percent is provided
        - `description` string — Item Description
        - `hsn_code` string — HSN Code. HSN Code can only be of length 4,6 & 8
        - `item_type` 'Product' | 'Service', required — Product or Service enum
        - `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.
        - `category` string — Category
        - `custom_columns` ItemCustomFields[] — Item Custom Fields. Custom fields should already be added in Swipe Portal.
          - `label` string, required
          - `value` string, required
      - `is_created_by_recurring` integer — Is the invoice created from subscriptions
      - `net_amount` number — Net amount of the transaction
      - `hash_id` string — Hash id for the document
      - `payment_status` 'paid' | 'pending' | 'cancelled' — Payment status of the document
      - `payments` PaymentV2[] — List of payments recorded for this document
        - `amount` number, required — Payment Amount
        - `method` 'cash' | 'card' | 'upi' | 'netBanking' | 'cheque' | 'emi', required — Payment method, use only specified values
        - `notes` string — Any internal notes for payment
        - `bank_details` BankDetails
          - `account_number` string, required — Account Number
          - `ifsc` string, required — IFSC Code
          - `bank_name` string, required — Bank Name
          - `branch` string, required — Branch
      - `tax_amount` number — Tax amount of the transaction
      - `total_amount` number — Total amount of the transaction
      - `total_discount` number — Discount given on this document
      - `record_time` string — Epoch Timestamp when the document was created

## Other responses

- `400` — Error
- `401` — Unauthorized
- `404` — Error
- `500` — Server Error

---

[API](https://skmtc.dev/getswipe/apis/swipeapi.md) · [All operations](https://skmtc.dev/getswipe/apis/swipeapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getswipe/swipeapi/revisions/80fcaf1a3463/schema)