What We Offer
All the features mentioned below, and more, can be accessed directly using
the Swipe Portal.
-
Document Creation: Easily generate professional invoices, pro forma invoices, sales returns, and purchase returns tailored to your business needs.
Steps to create a document:
- Checkout the create document endpoint in the API playground and use your API key to test the endpoint.
- If your API key is valid, this API endpoint returns a 200 response with document details in a specified JSON format.
Things to keep in mind:
- You can send your product_id and customer_id to create a document. These will be internally mapped to the product and customer details in Swipe.
- If the Product or Party is not found, they will be created automatically with the details provided.
- If new details for Party are provided, they will be updated in the system which will be reflected in your existing documents as well.
Create Document
Try Creating a document -
Fetch PDF: Access PDFs of already created documents.
Steps to get document PDFs:
- Checkout the get document PDF endpoint in the API playground. For
doc_hash_id
, use thehash_id
received from creating the document. - If your API key is valid, this API endpoint returns a 200 response along with the PDF.
Fetch Document PDF
Fetch PDFs of documents that are already createdSnapshot of a document PDF
- Checkout the get document PDF endpoint in the API playground. For
-
Get Document: Access specific product information quickly for operational needs or customer queries.
Steps to get particular document details:
- Checkout the get document endpoint in the API playground. For
doc_hash_id
, use thehash_id
received from creating the document. - If your API key is valid, this API endpoint returns a 200 response with document details in a specified JSON format.
Get Document
Try fetching document details - Checkout the get document endpoint in the API playground. For
-
Document Cancellation: Easily cancel your documents.
Steps to cancel a document:
- Checkout the cancel document endpoint in the API playground. For
doc_hash_id
, use thehash_id
received from creating the document. - If your API key is valid, this API endpoint returns a 200 response with document details in a specified JSON format.
Cancel a Document
Try Cancelling an active document - Checkout the cancel document endpoint in the API playground. For
-
List of Documents: Retrieve a complete list of all documents in your system based on the payment status, enabling seamless tracking and management.
Steps to get list of documents created:
- Checkout the list document endpoint in the API playground.
- If your API key is valid, this API endpoint returns a 200 response with a list of all the documents with basic details in JSON format.
List of Documents
Fetch List of all documentsYou can keep track of all documents on Swipe Dashboard -
Edit Document: Seamlessly edit and update your documents to ensure accuracy and consistency.
Steps to create a document:
- Checkout the edit document endpoint in the API playground and use your API key to test the endpoint.
- If your API key is valid, this API endpoint returns a 200 response with updated document details in a specified JSON format.
Things to keep in mind:
- In the request URL, provide the unique
doc_hash_id
of the document that needs to be updated. - In the request body, include all the keys with their respective updated values.
Edit Document
Try Editing a document