Global API
Request
Invoice
13min
when processing an invoice, use the requestjson to pass the invoice data the returned response will contain a responsejson section with the invoice response returned by breadwinner for quickbooks the invoice object has the following parameters invoice field name data type description balance decimal the balance reflects any payments made against the transaction read only billaddr common data types docid\ goasztqi8wczgotekytek identifies the e mail address where the invoice is sent billemail billemailclass identifies the e mail address where the invoice is sent classref common data types docid\ goasztqi8wczgotekytek reference to the class associated with the transaction currencyref common data types docid\ goasztqi8wczgotekytek reference to the currency in which all amounts on the associated transaction are expressed customermemo invoice docid\ gee1fj42amxfapeumyyqi user entered message to the customer; this message is visible to end user on their transactions customerref common data types docid\ goasztqi8wczgotekytek the id (unique quickbooks online id) for the referenced customer/vendor customfield invoice docid\ gee1fj42amxfapeumyyqi one of, up to three custom fields for the transaction available for custom fields so configured for the company departmentref common data types docid\ goasztqi8wczgotekytek a reference to a department object specifying the location of the transaction deposit decimal enter the deposit amount deposittoaccountref common data types docid\ goasztqi8wczgotekytek account to which money is deposited discountlinedetail invoice docid\ gee1fj42amxfapeumyyqi discount detail type for the entire transaction docnumber string invoice number duedate string date when the payment of the transaction is due (add by converting date to string) emailstatus string email status of the invoice valid values notset, needtosend, emailsent exchangerate decimal the number of home currency units it takes to equal one unit of currency specified by currencyref globaltaxcalculation string fixed values (notapplicable, taxinclusive) homebalance decimal read only line invoice docid\ gee1fj42amxfapeumyyqi individual line items of a transaction id string unique identifier for this object and readonly field metadata common data types docid\ goasztqi8wczgotekytek descriptive information about the object the metadata values are set by data services and are read only mobile common data types docid\ goasztqi8wczgotekytek mobile phone number mobilenumber string mobile number of contact/vendor privatenote string user entered, organization private note about the transaction salesforce account id string to map invoice with salesforce account salesforce opportunity id string to map invoice with salesforce opportunity shipaddr common data types docid\ goasztqi8wczgotekytek identifies the address where the goods must be shipped shipdate string date for delivery of goods or services shipmethodref common data types docid\ goasztqi8wczgotekytek reference to the shipmethod associated with the transaction salestermref common data types docid\ goasztqi8wczgotekytek reference to a salesterm associated with this customer object sparse boolean allows updating only specified properties of an object while leaving unspecified properties unchanged synctoken string version number of the object it is used to lock an object for use by one app at a time read only totalamt decimal indicates the total amount of the transaction this includes the total of all the charges, allowances, and taxes read only trackingnum string shipping provider’s tracking number for the delivery of the goods associated with the transaction txndate string the date entered by the user when this transaction occurred (add by converting date to string in yyyy mm dd format) txntaxdetail this data type provides information for taxes charged on the transaction as a whole sendinvoice boolean to email the invoice with its creation, set the parameter to true createandsendinvoice billemailclass field name data type description address string customfielddetails field name data type description definitionid string name string type string stringvalue string discountdetails field name data type description discountaccountref common data types docid\ goasztqi8wczgotekytek discountpercent decimal percentbased boolean lineitem field name data type description accountbasedexpenselinedetail invoice docid\ gee1fj42amxfapeumyyqi amount decimal description string detailtype string provide the detailtype as salesitemdetail, discountlinedetail, etc for shipping charge apply the detailtype as 'salesitemlinedetail' discountlinedetail invoice docid\ gee1fj42amxfapeumyyqi grouplinedetail invoice docid\ gee1fj42amxfapeumyyqi id string itembasedexpenselinedetail invoice docid\ gee1fj42amxfapeumyyqi linenum integer salesitemlinedetail invoice docid\ gee1fj42amxfapeumyyqi taxinclusiveamt decimal accountbasedexpenselinedetail field name data type description accountref common data types docid\ goasztqi8wczgotekytek billablestatus string classref common data types docid\ goasztqi8wczgotekytek customerref common data types docid\ goasztqi8wczgotekytek itemref common data types docid\ goasztqi8wczgotekytek markupinfo invoice docid\ gee1fj42amxfapeumyyqi qty decimal servicedate string taxamount decimal taxinclusiveamt decimal unitprice decimal markinformation field name data type description percent decimal discountlinedetail field name data type description discountaccountref common data types docid\ goasztqi8wczgotekytek discountpercent decimal percentbased boolean grouplinedetail field name data type description amount decimal line list< invoice docid\ gee1fj42amxfapeumyyqi > quantity integer groupitemref common data types docid\ goasztqi8wczgotekytek itembasedexpenselinedetail field name data type description billablestatus string classref common data types docid\ goasztqi8wczgotekytek customerref common data types docid\ goasztqi8wczgotekytek itemref common data types docid\ goasztqi8wczgotekytek markupinfo invoice docid\ gee1fj42amxfapeumyyqi qty decimal receivedquantity decimal servicedate string taxamount decimal taxinclusiveamt decimal unitprice decimal salesitemlinedetail field name data type description classref common data types docid\ goasztqi8wczgotekytek itemref common data types docid\ goasztqi8wczgotekytek the id (unique quickbooks online id) for the referenced item to apply the shipping charge use the static value of the shipping item shipping item id qty decimal servicedate string taxcoderef common data types docid\ goasztqi8wczgotekytek unitprice decimal txntaxdetail field name data type description taxline taxline\[] totaltax decimal txntaxcoderef common data types docid\ goasztqi8wczgotekytek customermemo field name data type description value string user entered message to the customer; this message is visible to the end user on their transactions