Create a document

POST

doc

object

document_type

enum<string>

document_date

string

customer

object

string

name

string

country_code

string

phone_number

string

company_name

string

gstin

string

due_date

string

reference

string

notes

string

terms

string

items

array

extra_discount

number

round_off

boolean

payments

array

bank_details

object

account_number

string

ifsc

string

bank_name

string

branch

string

tds_id

integer

tcs_id

integer

company_shipping_address

object

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

customer_shipping_address

object

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

string

customer_billing_address

object

address_line1

string

address_line2

string

city

string

state

enum<string>

country

string

pincode

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

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>

curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/doc \
  --header 'Authorization: Bearer <token>' \
  --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
    }
  ]
}'

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. If an existing Customer/Product id is sent, the details will not override the original customer/product details. They will be applicable only to the current document.

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

document_date

string

required

DD-MM-YYYY, Invoice date (Ex: 11-06-2024 Need not to the current date)

customer

object

required

Customer

due_date

string

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

reference

string

Any references you want to add to the doc

notes

string

Notes to show in invoice

terms

string

Terms to show in invoice

items

object[]

required

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

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

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

The provided array contains data where each object has a unique TDS_ID. This TDS_ID maps to the rest of the data in the object. Here are the details:

TDS_ID: 1, NAME: EPF premature withdrawal, SECTION: 192A, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 2, NAME: Interest of securities, SECTION: 193, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 3, NAME: Dividends, SECTION: 194, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 4, NAME: Interest (Banks), SECTION: 194A, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 5, NAME: Senior Citizens, SECTION: 194A, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 6, NAME: Single contractor payment (Individual & HUF), SECTION: 194C, APPLIED ON: net_amount, TAX: 1.0

TDS_ID: 7, NAME: Aggregate contractor payment (Individual & HUF), SECTION: 194C, APPLIED ON: net_amount, TAX: 1.0

TDS_ID: 8, NAME: Insurance commission, SECTION: 194D, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 9, NAME: Insurance commission on Life Insurance policies, SECTION: 194DA, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 10, NAME: NSS, SECTION: 194EE, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 11, NAME: Repurchase Units by MFs, SECTION: 194F, APPLIED ON: net_amount, TAX: 20.0

TDS_ID: 12, NAME: Commission – Lottery, SECTION: 194G, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 13, NAME: Commission/Brokerage, SECTION: 194H, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 14, NAME: Plant/Equipment/Machinery Rent, SECTION: 194I(a), APPLIED ON: net_amount, TAX: 2.0

TDS_ID: 15, NAME: Land Building and furniture rent, SECTION: 194I(b), APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 16, NAME: Transfer of certain immovable property other than agricultural land, SECTION: 194IA, APPLIED ON: net_amount, TAX: 1.0

TDS_ID: 17, NAME: Rent by Individual / HUF, SECTION: 194IB, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 18, NAME: Payment under specified agreement applicable for F.Y: 2017-18 onwards, SECTION: 194IC, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 19, NAME: Fees-tech services, call centre, royalty for sale etc., SECTION: 194J(a), APPLIED ON: net_amount, TAX: 2.0

TDS_ID: 20, NAME: Fee for professional service or royalty etc.., SECTION: 194J(b), APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 21, NAME: Payment of dividends by mutual funds, SECTION: 194K, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 22, NAME: Compensation on the transfer of certain immovable property other than agricultural land, SECTION: 194LA, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 23, NAME: Income on infrastructure debt fund(non-resident), SECTION: 194LB, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 24, NAME: Income from a business trust (applicable from 01.10.2014), SECTION: 194LBA, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 25, NAME: Income from a business trust to non-resident (applicable from 01.10.2014), SECTION: 194LBA, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 26, NAME: Interest on certain bonds and Govt. securities (from 01.06.2013), SECTION: 194LD, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 27, NAME: Payment to commission or brokerage by individual & HUF, SECTION: 194M, APPLIED ON: net_amount, TAX: 5.0

TDS_ID: 28, NAME: Cash withdrawal exceeding 1 crore during the previous year from 1 or more accounts with a bank or co, SECTION: 194N, APPLIED ON: net_amount, TAX: 2.0

TDS_ID: 29, NAME: TDS on e-commerce participants, SECTION: 194O, APPLIED ON: net_amount, TAX: 1.0

TDS_ID: 30, NAME: Purchase of Goods (Recommended by Income Tax), SECTION: 194Q, APPLIED ON: total_amount, TAX: 0.1

TDS_ID: 31, NAME: Single contractor payment (Others), SECTION: 194C, APPLIED ON: net_amount, TAX: 2.0

TDS_ID: 32, NAME: Aggregate contractor payment (Others), SECTION: 194C, APPLIED ON: net_amount, TAX: 2.0

TDS_ID: 33, NAME: Perquisite or benefit to a business or profession, SECTION: 194R, APPLIED ON: net_amount, TAX: 10.0

TDS_ID: 34, NAME: TDS on the transfer of virtual digital assets, SECTION: 194S, APPLIED ON: net_amount, TAX: 1.0

TDS_ID: 45, NAME: Purchase of Goods (Taxable Amount). Use this on your own discretion., SECTION: 194Q, APPLIED ON: net_amount, TAX: 0.1

tcs_id

integer

The provided array contains data where each object has a unique TCS_ID. This TCS_ID maps to the rest of the data in the object. Here are the details:

TCS_ID: 35, NAME: TCS upon receivables, SECTION: 206C(IH), APPLIED ON: total_amount, TAX: 0.1

TCS_ID: 36, NAME: Liquor of alcoholic nature, made for consumption by humans, SECTION: 206C, APPLIED ON: total_amount, TAX: 1.0

TCS_ID: 37, NAME: Timber wood under a forest leased, SECTION: 206C, APPLIED ON: total_amount, TAX: 2.5

TCS_ID: 38, NAME: Tendu leaves, SECTION: 206C, APPLIED ON: total_amount, TAX: 5.0

TCS_ID: 39, NAME: Timber wood by any other mode than forest leased, SECTION: 206c, APPLIED ON: total_amount, TAX: 2.5

TCS_ID: 40, NAME: Forest produce other than Tendu leaves and timber, SECTION: 206C, APPLIED ON: total_amount, TAX: 2.5

TCS_ID: 41, NAME: Scrap, SECTION: 206C, APPLIED ON: total_amount, TAX: 1.0

TCS_ID: 42, NAME: Minerals like lignite, coal and iron ore, SECTION: 206C, APPLIED ON: total_amount, TAX: 1.0

TCS_ID: 43, NAME: Purchase of Motor vehicle exceeding Rs.10 Lakhs, SECTION: 206C, APPLIED ON: total_amount, TAX: 1.0

TCS_ID: 44, NAME: Parking lot, Toll Plaza and Mining and Quarrying, SECTION: 206C, APPLIED ON: total_amount, TAX: 2.0

TCS_ID: 46, NAME: Remittance out of India under the Liberalized Remittance Scheme of RBI, SECTION: 206C(1G)(a), APPLIED ON: net_amount, TAX: 5.0

TCS_ID: 47, NAME: TCS on selling of overseas tour package, SECTION: 206C(1G)(b), APPLIED ON: net_amount, TAX: 5.0

TCS_ID: 48, NAME: Collection at source on remittance under LRS except for the purposes of education or medical treatme, SECTION: 206C, APPLIED ON: net_amount, TAX: 20.0

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

subscription_details

object

Subscription Details

einvoice

boolean

Generate einvoice

is_export

boolean

Is Export

export_invoice_details

object

Export Invoice Details

Response

200 - application/json

success

boolean

Success

message

string

Message

serialNumber

string

Serial Number

hashId

string

Hash ID

einvoiceSuccess

boolean

EInvoice Success

einvoiceMessage

string

EInvoice Message

Introduction Get document PDF

curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/doc \
  --header 'Authorization: Bearer <token>' \
  --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
    }
  ]
}'

API Documentation

Document

Customer

Payment

Product

Create a document

Authorizations

Body

Response