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",
  "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
    }
  ]
}
'

{
  "success": true,
  "message": "Document created successfully",
  "serialNumber": "SL123",
  "hashId": "SL123"
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

Document

Create a document

v1 is deprecated — use the v2 endpoint instead. Creates a document — an invoice, purchase, estimate, return, delivery challan, or subscription — based on document_type. Unknown party and items IDs are created automatically from the details you send; existing IDs are reused. Returns the document’s hash_id, which addresses the document in every subsequent call, plus the IRN and QR code when einvoice is set. Send your own serial_number to make retries safe — a duplicate fails with DUPLICATE_DOC_SERIAL_NUMBER instead of creating a second document.

POST

doc

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",
  "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
    }
  ]
}
'

{
  "success": true,
  "message": "Document created successfully",
  "serialNumber": "SL123",
  "hashId": "SL123"
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

{
  "success": false,
  "error_code": "INVALID_HASH_ID",
  "message": "Some error occurred",
  "errors": {}
}

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

header

required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Body

application/json

document_type

enum<string>

required

Type of document to create. One of the enum values listed below; use 'invoice' for a standard GST invoice.

Available options:

invoice,

subscription,

pro_forma_invoice,

estimate,

sales_return,

purchase_return

Example:

"invoice"

document_date

string

required

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

Example:

"11-06-2024"

items

object[]

required

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

Show child attributes

serial_number

string

Serial Number, if not sent will be auto generated based on the default prefix.

Example:

"INV123"

customer

object

Customer (deprecated, please use Party). If there are any changes made to the customer's details, we will update those details and any documents linked to this customer's ID will be updated to reflect the changes.

Show child attributes

party

object

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.

Show child attributes

due_date

string

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

Example:

"11-06-2024"

reference

string

Any references you want to add to the doc

Example:

"Reference Text"

notes

string

Notes to show in invoice

Example:

"Notes for the document"

terms

string

Terms to show in invoice

Example:

"Terms and Conditions"

extra_discount

number

default:0

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

Example:

20

round_off

boolean

default:false

Should Round Off total amount

Example:

true

payments

object[]

Array of Payments, refer Payment Object for parameters

Show child attributes

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

Show child attributes

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 copy the tcs id and details mapping from https://developers.getswipe.in/api-reference/references#tcs-tax-collected-at-source

company_shipping_address

object

Company shipping from Address, refer Shipping Address Object for parameters

Show child attributes

customer_shipping_address

object

Customer shipping to Address, refer Shipping Address Object for parameters

Show child attributes

customer_billing_address

object

Customer billing to Address, refer Shipping Address Object for parameters

Show child attributes

is_subscription

boolean

Is Subscription

Example:

false

subscription_details

object

Subscription Details

Show child attributes

einvoice

boolean

Generate einvoice

Example:

false

is_export

boolean

Is Export

Example:

false

export_invoice_details

object

Export Invoice Details

Show child attributes

Response

Success

success

boolean

Success

Example:

true

message

string

Message

Example:

"Document created successfully"

serialNumber

string

Serial Number

Example:

"SL123"

hashId

string

Hash ID

Example:

"SL123"

Get Started

Guides

Resources

Document

Payment

Customer

Product

Subscriptions

Utility

EwayBill

Create a document

Authorizations

Body

Response