Java
Chilkat2 Java
Quickbooks Send an Invoice
See more QuickBooks Examples
Demonstrates how to send an invoice using the Quickbooks REST API.Chilkat Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// First get our previously obtained OAuth2 access token.
JsonObject jsonToken = new JsonObject();
jsonToken.loadFile("qa_data/tokens/qb-access-token.json");
Rest rest = new Rest();
// Connect to the REST server.
boolean bTls = true;
int port = 443;
boolean bAutoReconnect = true;
rest.connect("sandbox-quickbooks.api.intuit.com", port, bTls, bAutoReconnect);
StringBuilder sbAuth = new StringBuilder();
sbAuth.append("Bearer ");
sbAuth.append(jsonToken.stringOf("access_token"));
rest.setAuthorization(sbAuth.getAsString());
// --------------------------------------------------------------------------
// Note: The above code to setup the initial REST connection
// can be done once. After connecting, any number of REST calls can be made.
// If the connection is lost, the next REST method call will automatically
// reconnect if needed.
// --------------------------------------------------------------------------
// Technically, the POST has an empty request body, but the Quickbooks documentation indicates that
// the Content-Type header should be set to "application/octet-stream", which really makes no sense
// because there is not content. (How can no content have a type???)
rest.addHeader("Content-Type", "application/octet-stream");
rest.setAllowHeaderFolding(false);
StringBuilder sbResponseBody = new StringBuilder();
try {
rest.fullRequestNoBodySb("POST", "/v3/company/<realmID>/invoice/<invoiceId>/send?sendTo=<emailAddr>", sbResponseBody);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
int respStatusCode = rest.getResponseStatusCode();
// Success is indicated by a 200 response status code.
System.out.println("response status code = " + respStatusCode);
JsonObject jsonResponse = new JsonObject();
jsonResponse.loadSb(sbResponseBody);
jsonResponse.setEmitCompact(false);
System.out.println(jsonResponse.emit());
if (rest.getResponseStatusCode() != 200) {
System.out.println("Failed.");
return;
}
// Sample output...
// (See the parsing code below..)
//
// Use the this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
// {
// "Invoice": {
// "TxnDate": "2013-03-14",
// "domain": "QBO",
// "CurrencyRef": {
// "name": "United States Dollar",
// "value": "USD"
// },
// "ShipDate": "2013-03-01",
// "TrackingNum": "123456789",
// "ClassRef": {
// "name": "Class 1",
// "value": "200900000000000003901"
// },
// "PrintStatus": "NeedToPrint",
// "SalesTermRef": {
// "value": "4"
// },
// "DeliveryInfo": {
// "DeliveryType": "Email",
// "DeliveryTime": "2014-12-17T11:50:52-08:00"
// },
// "TotalAmt": 52.0,
// "Line": [
// {
// "Description": "Sample invoice create request",
// "DetailType": "SalesItemLineDetail",
// "SalesItemLineDetail": {
// "TaxCodeRef": {
// "value": "TAX"
// },
// "Qty": 1,
// "UnitPrice": 50,
// "ServiceDate": "2013-03-04",
// "ItemRef": {
// "name": "Hours",
// "value": "2"
// }
// },
// "LineNum": 1,
// "Amount": 50.0,
// "Id": "1"
// },
// {
// "DetailType": "SubTotalLineDetail",
// "Amount": 50.0,
// "SubTotalLineDetail": {}
// },
// {
// "DetailType": "DiscountLineDetail",
// "Amount": 5.0,
// "DiscountLineDetail": {
// "DiscountAccountRef": {
// "name": "Discounts given",
// "value": "30"
// },
// "PercentBased": true,
// "DiscountPercent": 10
// }
// },
// {
// "DetailType": "SalesItemLineDetail",
// "Amount": 2.0,
// "SalesItemLineDetail": {
// "ItemRef": {
// "value": "SHIPPING_ITEM_ID"
// }
// }
// }
// ],
// "DueDate": "2013-05-13",
// "MetaData": {
// "CreateTime": "2013-03-14T01:42:16-07:00",
// "LastUpdatedTime": "2014-12-17T11:50:58-08:00"
// },
// "DocNumber": "Sample_Inv#2",
// "PrivateNote": "Summary for sample invoice",
// "sparse": false,
// "DepositToAccountRef": {
// "name": "Undeposited Funds",
// "value": "4"
// },
// "CustomerMemo": {
// "value": "This is the customer message"
// },
// "EmailStatus": "EmailSent",
// "Deposit": 12.0,
// "Balance": 40.0,
// "CustomerRef": {
// "name": "Mr V3 Service Customer Jr2",
// "value": "15"
// },
// "TxnTaxDetail": {
// "TxnTaxCodeRef": {
// "value": "5"
// },
// "TotalTax": 5.0,
// "TaxLine": [
// {
// "DetailType": "TaxLineDetail",
// "Amount": 5.0,
// "TaxLineDetail": {
// "NetAmountTaxable": 50.0,
// "TaxPercent": 10,
// "TaxRateRef": {
// "value": "2"
// },
// "PercentBased": true
// }
// }
// ]
// },
// "SyncToken": "0",
// "BillEmail": {
// "Address": "test@intuit.com"
// },
// "ShipAddr": {
// "City": "San Jose",
// "Country": "USA",
// "Line5": "Cube 999",
// "Line4": "Dept 12",
// "Line3": "123 street",
// "Line2": "Building 1",
// "Line1": "Intuit",
// "PostalCode": "95123",
// "Lat": "37.2374847",
// "Long": "-121.8277925",
// "CountrySubDivisionCode": "CA",
// "Id": "36"
// },
// "DepartmentRef": {
// "name": "Mountain View",
// "value": "1"
// },
// "ShipMethodRef": {
// "name": "UPS",
// "value": "UPS"
// },
// "BillAddr": {
// "City": "Mountain View",
// "Country": "USA",
// "Line5": "Cube 999",
// "Line4": "Dept 12",
// "Line3": "123 street",
// "Line2": "Building 1",
// "Line1": "Google",
// "PostalCode": "95123",
// "Lat": "37.2374847",
// "Long": "-121.8277925",
// "CountrySubDivisionCode": "CA",
// "Id": "35"
// },
// "ApplyTaxAfterDiscount": false,
// "CustomField": [
// {
// "StringValue": "Custom1",
// "Type": "StringType",
// "Name": "Custom 1"
// },
// {
// "StringValue": "Custom2",
// "Type": "StringType",
// "Name": "Custom 2"
// },
// {
// "StringValue": "Custom3",
// "Type": "StringType",
// "Name": "Custom 3"
// }
// ],
// "Id": "96"
// },
// "time": "2013-03-14T13:32:04.895-07:00"
// }
//
String Description = "";
String DetailType = "";
String SalesItemLineDetailTaxCodeRefValue = "";
int SalesItemLineDetailQty = 0;
int SalesItemLineDetailUnitPrice = 0;
String SalesItemLineDetailServiceDate = "";
String SalesItemLineDetailItemRefName = "";
String SalesItemLineDetailItemRefValue = "";
int LineNum = 0;
String Amount = "";
String Id = "";
String DiscountLineDetailDiscountAccountRefName = "";
String DiscountLineDetailDiscountAccountRefValue = "";
boolean DiscountLineDetailPercentBased = false;
int DiscountLineDetailDiscountPercent = 0;
String TaxLineDetailNetAmountTaxable = "";
int TaxLineDetailTaxPercent = 0;
String TaxLineDetailTaxRateRefValue = "";
boolean TaxLineDetailPercentBased = false;
String StringValue = "";
String Type = "";
String Name = "";
String InvoiceTxnDate = jsonResponse.stringOf("Invoice.TxnDate");
String InvoiceDomain = jsonResponse.stringOf("Invoice.domain");
String InvoiceCurrencyRefName = jsonResponse.stringOf("Invoice.CurrencyRef.name");
String InvoiceCurrencyRefValue = jsonResponse.stringOf("Invoice.CurrencyRef.value");
String InvoiceShipDate = jsonResponse.stringOf("Invoice.ShipDate");
String InvoiceTrackingNum = jsonResponse.stringOf("Invoice.TrackingNum");
String InvoiceClassRefName = jsonResponse.stringOf("Invoice.ClassRef.name");
String InvoiceClassRefValue = jsonResponse.stringOf("Invoice.ClassRef.value");
String InvoicePrintStatus = jsonResponse.stringOf("Invoice.PrintStatus");
String InvoiceSalesTermRefValue = jsonResponse.stringOf("Invoice.SalesTermRef.value");
String InvoiceDeliveryInfoDeliveryType = jsonResponse.stringOf("Invoice.DeliveryInfo.DeliveryType");
String InvoiceDeliveryInfoDeliveryTime = jsonResponse.stringOf("Invoice.DeliveryInfo.DeliveryTime");
String InvoiceTotalAmt = jsonResponse.stringOf("Invoice.TotalAmt");
String InvoiceDueDate = jsonResponse.stringOf("Invoice.DueDate");
String InvoiceMetaDataCreateTime = jsonResponse.stringOf("Invoice.MetaData.CreateTime");
String InvoiceMetaDataLastUpdatedTime = jsonResponse.stringOf("Invoice.MetaData.LastUpdatedTime");
String InvoiceDocNumber = jsonResponse.stringOf("Invoice.DocNumber");
String InvoicePrivateNote = jsonResponse.stringOf("Invoice.PrivateNote");
boolean InvoiceSparse = jsonResponse.boolOf("Invoice.sparse");
String InvoiceDepositToAccountRefName = jsonResponse.stringOf("Invoice.DepositToAccountRef.name");
String InvoiceDepositToAccountRefValue = jsonResponse.stringOf("Invoice.DepositToAccountRef.value");
String InvoiceCustomerMemoValue = jsonResponse.stringOf("Invoice.CustomerMemo.value");
String InvoiceEmailStatus = jsonResponse.stringOf("Invoice.EmailStatus");
String InvoiceDeposit = jsonResponse.stringOf("Invoice.Deposit");
String InvoiceBalance = jsonResponse.stringOf("Invoice.Balance");
String InvoiceCustomerRefName = jsonResponse.stringOf("Invoice.CustomerRef.name");
String InvoiceCustomerRefValue = jsonResponse.stringOf("Invoice.CustomerRef.value");
String InvoiceTxnTaxDetailTxnTaxCodeRefValue = jsonResponse.stringOf("Invoice.TxnTaxDetail.TxnTaxCodeRef.value");
String InvoiceTxnTaxDetailTotalTax = jsonResponse.stringOf("Invoice.TxnTaxDetail.TotalTax");
String InvoiceSyncToken = jsonResponse.stringOf("Invoice.SyncToken");
String InvoiceBillEmailAddress = jsonResponse.stringOf("Invoice.BillEmail.Address");
String InvoiceShipAddrCity = jsonResponse.stringOf("Invoice.ShipAddr.City");
String InvoiceShipAddrCountry = jsonResponse.stringOf("Invoice.ShipAddr.Country");
String InvoiceShipAddrLine5 = jsonResponse.stringOf("Invoice.ShipAddr.Line5");
String InvoiceShipAddrLine4 = jsonResponse.stringOf("Invoice.ShipAddr.Line4");
String InvoiceShipAddrLine3 = jsonResponse.stringOf("Invoice.ShipAddr.Line3");
String InvoiceShipAddrLine2 = jsonResponse.stringOf("Invoice.ShipAddr.Line2");
String InvoiceShipAddrLine1 = jsonResponse.stringOf("Invoice.ShipAddr.Line1");
String InvoiceShipAddrPostalCode = jsonResponse.stringOf("Invoice.ShipAddr.PostalCode");
String InvoiceShipAddrLat = jsonResponse.stringOf("Invoice.ShipAddr.Lat");
String InvoiceShipAddrLong = jsonResponse.stringOf("Invoice.ShipAddr.Long");
String InvoiceShipAddrCountrySubDivisionCode = jsonResponse.stringOf("Invoice.ShipAddr.CountrySubDivisionCode");
String InvoiceShipAddrId = jsonResponse.stringOf("Invoice.ShipAddr.Id");
String InvoiceDepartmentRefName = jsonResponse.stringOf("Invoice.DepartmentRef.name");
String InvoiceDepartmentRefValue = jsonResponse.stringOf("Invoice.DepartmentRef.value");
String InvoiceShipMethodRefName = jsonResponse.stringOf("Invoice.ShipMethodRef.name");
String InvoiceShipMethodRefValue = jsonResponse.stringOf("Invoice.ShipMethodRef.value");
String InvoiceBillAddrCity = jsonResponse.stringOf("Invoice.BillAddr.City");
String InvoiceBillAddrCountry = jsonResponse.stringOf("Invoice.BillAddr.Country");
String InvoiceBillAddrLine5 = jsonResponse.stringOf("Invoice.BillAddr.Line5");
String InvoiceBillAddrLine4 = jsonResponse.stringOf("Invoice.BillAddr.Line4");
String InvoiceBillAddrLine3 = jsonResponse.stringOf("Invoice.BillAddr.Line3");
String InvoiceBillAddrLine2 = jsonResponse.stringOf("Invoice.BillAddr.Line2");
String InvoiceBillAddrLine1 = jsonResponse.stringOf("Invoice.BillAddr.Line1");
String InvoiceBillAddrPostalCode = jsonResponse.stringOf("Invoice.BillAddr.PostalCode");
String InvoiceBillAddrLat = jsonResponse.stringOf("Invoice.BillAddr.Lat");
String InvoiceBillAddrLong = jsonResponse.stringOf("Invoice.BillAddr.Long");
String InvoiceBillAddrCountrySubDivisionCode = jsonResponse.stringOf("Invoice.BillAddr.CountrySubDivisionCode");
String InvoiceBillAddrId = jsonResponse.stringOf("Invoice.BillAddr.Id");
boolean InvoiceApplyTaxAfterDiscount = jsonResponse.boolOf("Invoice.ApplyTaxAfterDiscount");
String InvoiceId = jsonResponse.stringOf("Invoice.Id");
String time = jsonResponse.stringOf("time");
int i = 0;
int count_i = jsonResponse.sizeOfArray("Invoice.Line");
while (i < count_i) {
jsonResponse.setI(i);
Description = jsonResponse.stringOf("Invoice.Line[i].Description");
DetailType = jsonResponse.stringOf("Invoice.Line[i].DetailType");
SalesItemLineDetailTaxCodeRefValue = jsonResponse.stringOf("Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value");
SalesItemLineDetailQty = jsonResponse.intOf("Invoice.Line[i].SalesItemLineDetail.Qty");
SalesItemLineDetailUnitPrice = jsonResponse.intOf("Invoice.Line[i].SalesItemLineDetail.UnitPrice");
SalesItemLineDetailServiceDate = jsonResponse.stringOf("Invoice.Line[i].SalesItemLineDetail.ServiceDate");
SalesItemLineDetailItemRefName = jsonResponse.stringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.name");
SalesItemLineDetailItemRefValue = jsonResponse.stringOf("Invoice.Line[i].SalesItemLineDetail.ItemRef.value");
LineNum = jsonResponse.intOf("Invoice.Line[i].LineNum");
Amount = jsonResponse.stringOf("Invoice.Line[i].Amount");
Id = jsonResponse.stringOf("Invoice.Line[i].Id");
DiscountLineDetailDiscountAccountRefName = jsonResponse.stringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.name");
DiscountLineDetailDiscountAccountRefValue = jsonResponse.stringOf("Invoice.Line[i].DiscountLineDetail.DiscountAccountRef.value");
DiscountLineDetailPercentBased = jsonResponse.boolOf("Invoice.Line[i].DiscountLineDetail.PercentBased");
DiscountLineDetailDiscountPercent = jsonResponse.intOf("Invoice.Line[i].DiscountLineDetail.DiscountPercent");
i = i + 1;
}
i = 0;
count_i = jsonResponse.sizeOfArray("Invoice.TxnTaxDetail.TaxLine");
while (i < count_i) {
jsonResponse.setI(i);
DetailType = jsonResponse.stringOf("Invoice.TxnTaxDetail.TaxLine[i].DetailType");
Amount = jsonResponse.stringOf("Invoice.TxnTaxDetail.TaxLine[i].Amount");
TaxLineDetailNetAmountTaxable = jsonResponse.stringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.NetAmountTaxable");
TaxLineDetailTaxPercent = jsonResponse.intOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxPercent");
TaxLineDetailTaxRateRefValue = jsonResponse.stringOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.TaxRateRef.value");
TaxLineDetailPercentBased = jsonResponse.boolOf("Invoice.TxnTaxDetail.TaxLine[i].TaxLineDetail.PercentBased");
i = i + 1;
}
i = 0;
count_i = jsonResponse.sizeOfArray("Invoice.CustomField");
while (i < count_i) {
jsonResponse.setI(i);
StringValue = jsonResponse.stringOf("Invoice.CustomField[i].StringValue");
Type = jsonResponse.stringOf("Invoice.CustomField[i].Type");
Name = jsonResponse.stringOf("Invoice.CustomField[i].Name");
i = i + 1;
}
}
}