API Documentation

    DocumentsEdit Document

    Method: /documents/[id].[format]
    Document Fields:
    Name:Data Type:Description:
    customer_idStringCustomer ID
    context_idStringDetermines if it’s an estimate, invoice, or PO
    total_costStringTotal cost of all items added to the document
    total_taxStringTotal amount of tax (tax1) to be added to subtotal
    total_tax2StringTotal amount of tax (tax2) to be added to subtotal
    total_priceStringThe subtotal of all items without taxes added
    issue_dateStringThe date this document was issued (in YYYY-MM-DD format)
    shipping_addressStringThis is used when the shipping address is different than the mailing address
    Document Item Fields:
    NameData TypeDescription
    item_idStringItem ID
    descriptionStringUsed for overriding the items actual description
    quantityStringThe number of items added to this document
    taxStringTax 1 rate for this item
    tax2StringTax 2 rate for this item
    costStringThe cost per unit
    priceStringThe price you’re selling each unit for
    Permissions Required:
    • Billing Management
    • Modify Invoices and/or Modify Estimates
    HTTP Request Type: PUT
    Example JSON Data to Submit
    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   }
    Example XML Data to Submit
    1<?xml version="1.0" encoding="UTF-8" ?>
    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>

    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

    Network Status:
    100% Global Availability