Introduction
- Overview
- Organization ID
- Multiple Data Centers
- API Call Limit
OAuth
HTTP Methods
Response
Errors
Pagination
Organizations
- Overview
- List Organizations
- Get an Organization
Contacts
- Overview
- Create a Contact
- List contacts
- Update a contact
- Get contact
- Delete a contact
- Mark as active
- Mark as Inactive
- Mark as Inactive
- Get Statement mail content
- Email contact
- List Comments
Contact Persons
- Overview
- Create a contact person
- Update a contact person
- Delete a contact person
- List contact persons
- Get a contact person
- Mark as primary contact person
Item Groups
- Overview
- Create an Item Group
- List all Item Groups
- Update an Item Group
- Retrieve an Item Group
- Delete an Item Group
- Mark as Active
- Mark as Inactive
Items
- Overview
- Create an item
- List all the items
- Update an item
- Retrieve an item
- Delete an item
- Delete an item image
- Mark as active
- Mark as inactive
Composite Items
- Overview
- Creating a Composite Item
- List All Composite Items
- Updating a composite item
- Retrieving a Composite Item
- Deleting a Composite Item
- Mark as active
- Mark as inactive
- Create Bundle
- Bundling History
- Retrieve Bundle
- Delete Bundle
Item Adjustments
- Overview
- Create an item adjustment
- List all the item adjustments
- Retrieve an item adjustment
- Delete an item adjustment
Transfer Orders
- Overview
- Create a transfer order
- List all the transfer orders
- Retrieve a transfer order
- Delete a transfer order
- Mark as Received
Sales Orders
- Overview
- Create a Sales Order
- List all Sales Orders
- Update a Sales Order
- Retrieve a Sales Order
- Delete a Sales Order
- Mark as Confirmed
- Mark as Void
Packages
- Overview
- Creating a package
- List all packages
- Updating a package
- Retrieving a package
- Deleting a package
- Bulk print packages
Shipment Orders
- Overview
- Create a Shipment Order
- Retrieve a Shipment Order
- Delete a Shipment Order
- Mark as Delivered
Invoices
- Overview
- Create an invoice
- List invoices
- Update an invoice
- Get an invoice
- Delete an invoice
- Mark an invoice as sent
- Void an invoice
- Mark as draft
- Email an invoice
- Get invoice email content
- Email invoices
- Get payment reminder mail content
- Bulk export Invoices
- Bulk print invoices
- Disable payment reminder
- Enable payment reminder
- Write off invoice
- Cancel write off
- Update billing address
- Update shipping address
- List invoice templates
- Update invoice template
- List invoice payments
- List credits applied
- Apply credits
- Delete a payment
- Delete applied credit
- Add attachment to an invoice
- Update attachment preference
- Get an invoice attachment
- Delete an attachment
- Add comment
- List invoice comments & history
- Update comment
- Delete a comment
Retainer Invoices
- Overview
- Create a retainerinvoice
- List a retainer invoices
- update a retainerinvoice
- Get a retainer invoice
- Delete a retainer invoice
- Mark a retainer invoice as sent
- Update retainer invoice template
- Void a retainer invoice
- Mark as draft
- Submit a retainer invoice for approval
- Approve a retainer invoice.
- Email a retainer invoice
- Get retainer invoice email content
- Update billing address
- List retainer invoice templates
- Add attachment to a retainer invoice
- Get a retainer invoice attachment
- Delete an attachment
- Add comment
- List retainer invoice comments & history
- Update comment
- Delete a comment
Customer Payments
- Overview
- Create a payment
- List Customer Payments
- Update a payment
- Retrieve a payment
- Delete a payment
Sales Returns
- Overview
- Create a Sales Return
- List all Sales Returns
- Update a Sales Return
- Retrieve a Sales Return
- Delete a Sales Return
- Create a Sales Return Receive
- Delete a Sales Return Receive
Credit Notes
- Overview
- Create a credit note
- List all Credit Notes
- Update a credit note
- Get a credit note
- Delete a credit note
- Email a credit note
- Get email content
- Void a Credit Note
- Convert Credit Note to Draft.
- Convert credit note to Open
- Submit a credit note for approval
- Approve a credit note.
- Email history
- Update billing address
- Update Shipping address
- List the credit note templates
- Update a credit note template
- Apply credits to invoices
- List invoices credited
- Delete credits applied to an invoice
- Add a comment
- List credit note comments & history
- Delete a Comment
- List credit note refunds
- Refund credit note
- List refunds of a credit note
- Update credit note refund
- Get credit note refund
- Delete credit note refund
Purchase Orders
- Overview
- Create a Purchase Order
- List all Purchase Orders
- Update a Purchase Order
- Retrieve a Purchase Order
- Delete a Purchase Order
- Mark as Issued
- Mark as Cancelled
Purchase Receives
- Overview
- Create a purchase receive
- Retrieve a Purchase Receive
- Delete a Purchase Receive
Bills
- Overview
- Create a Bill
- List all Bills.
- Update a Bill
- Retrieve a Bill
- Delete a Bill.
- Mark as Open
- Mark as Void
Vendor Credits
- Overview
- Create a vendor credit
- List vendor credits
- Update vendor credit
- Get vendor credit
- Delete vendor credit
- Convert to open
- Void vendor credit
- Submit a Vendor credit for approval
- Approve a Vendor credit
- Apply credits to a bill
- List bills credited
- Delete bills credited
- Refund a vendor credit
- List refunds of a vendor credit
- Update vendor credit refund
- Get vendor credit refund
- Delete vendor credit refund
- List vendor credit refunds
- Add a comment
- List vendor credit comments & history
- Delete a comment
Warehouse Settings
- Overview
- Enable Multi warehouse
- Create a Warehouse
- List all warehouses
- Update Warehouse
- Delete a Warehouse
- Mark as Active
- Mark as Inactive
- Mark as Primary
Price Lists
- Overview
- Create a pricebook
- List all pricebooks
- Update pricebook
- Delete the pricebook
- Mark as Active
- Mark as Inactive
Taxes
- Overview
- Create a tax
- List taxes
- Update a tax
- Get a tax
- Delete a tax
- Update a tax group
- Get a tax group
- Delete a tax group
- Create a tax group

Response

Responses will be in the JSON format.

Node Name	Description
code	Zakya error code. This will be zero for a success response and non-zero in case of an error.
message	Message for the invoked API.
resource name	Comprises the invoked API’s Data.

curl https://api.zakya.com/v1/invoices/7000000079426?authtoken=ba46xxxxxxxxxxxxxxxxxxxxxxxxoec5&organization_id=10234695
-H 'Accept: application/pdf'

curl https://api.zakya.com/v1/invoices/7000000079426?accept=pdf \
'&authtoken=ba46xxxxxxxxxxxxxxxxxxxxxxxxoec5' \
'&organization_id=10234695'

Other Formats

Certain APIs also support csv and pdf formats. The required response format needs to be specified in the respective request’s Accept header or accept query parameter.

The response structure for the Zakya API follows the below format.

{
    "code" : 0,
    "message" : "success",
    "invoice" : {
        "invoice_id" : "..."
    }
}

Date

All timestamps are returned in the ISO 8601 format - YYYY-MM-DDThh:mm:ssTZD.

Example: 2016-06-11T17:38:06-0700

HTTP/1.1 200 OK Content-Disposition: attachment; filename="INV-384.pdf" Content-Type: application/pdf;charset=UTF-8