API Documentation

DocumentsEdit Document

Method: /documents/[id].[format]

Document Fields:

Name:	Data Type:	Description:
customer_id	String	Customer ID
context_id	String	Determines if it’s an estimate, invoice, or PO
total_cost	String	Total cost of all items added to the document
total_tax	String	Total amount of tax (tax1) to be added to subtotal
total_tax2	String	Total amount of tax (tax2) to be added to subtotal
total_price	String	The subtotal of all items without taxes added
issue_date	String	The date this document was issued (in YYYY-MM-DD format)
shipping_address	String	This is used when the shipping address is different than the mailing address

Document Item Fields:

Name	Data Type	Description
item_id	String	Item ID
description	String	Used for overriding the items actual description
quantity	String	The number of items added to this document
tax	String	Tax 1 rate for this item
tax2	String	Tax 2 rate for this item
cost	String	The cost per unit
price	String	The price you’re selling each unit for

Permissions Required:

Billing Management
Modify Invoices and/or Modify Estimates

Syntax:

https://[subdomain].salesbinder.com/api/2.0/documents/[id].json

HTTP Request Type: PUT

Example JSON Data to Submit

1{  
2   "document":{  
3      "context_id":5,
4      "customer_id":"549490bc-d15c-433c-8e48-03d8a2d10228",
5      "issue_date":"2017-02-08",
6      "document_items":[  
7         {  
8            "quantity":2,
9            "tax":8,
10            "price":134,
11            "weight":1,
12            "item_id":"58014db1-8dd8-4133-87ca-337f6882ca98"
13         }
14      ]
15   }
16}

Example XML Data to Submit

1<?xml version="1.0" encoding="UTF-8" ?>
2<document>
3  <context_id>5</context_id>
4  <customer_id>549490bc-d15c-433c-8e48-03d8a2d10228</customer_id>
5  <issue_date>2017-02-08</issue_date>
6  <document_items>
7    <quantity>2</quantity>
8    <tax>8</tax>
9    <price>134</price>
10    <weight>1</weight>
11    <item_id>58014db1-8dd8-4133-87ca-337f6882ca98</item_id>
12  </document_items>
13</document>

Success:

If you have been successful in updating a document, the response will return the updated data object along with a “message” value of “Saved” as seen below.

Updated on February 8th, 2022