|
Chilkat • HOME • .NET Core C# • Android™ • AutoIt • C • C# • C++ • Chilkat2-Python • CkPython • Classic ASP • DataFlex • Delphi ActiveX • Delphi DLL • Go • Java • Lianja • Mono C# • Node.js • Objective-C • PHP ActiveX • PHP Extension • Perl • PowerBuilder • PowerShell • PureBasic • Ruby • SQL Server • Swift 2 • Swift 3,4,5... • Tcl • Unicode C • Unicode C++ • VB.NET • VBScript • Visual Basic 6.0 • Visual FoxPro • Xojo Plugin
(PureBasic) Quickbooks Update an InvoiceDemonstrates how to update an invoice using the Quickbooks REST API. For more information, see https://www.developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/invoice#full-update-an-invoice
IncludeFile "CkStringBuilder.pb" IncludeFile "CkRest.pb" IncludeFile "CkJsonObject.pb" Procedure ChilkatExample() ; 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. jsonToken.i = CkJsonObject::ckCreate() If jsonToken.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success.i = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/qb-access-token.json") rest.i = CkRest::ckCreate() If rest.i = 0 Debug "Failed to create object." ProcedureReturn EndIf ; Connect to the REST server. bTls.i = 1 port.i = 443 bAutoReconnect.i = 1 success.i = CkRest::ckConnect(rest,"sandbox-quickbooks.api.intuit.com",port,bTls,bAutoReconnect) sbAuth.i = CkStringBuilder::ckCreate() If sbAuth.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkStringBuilder::ckAppend(sbAuth,"Bearer ") CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token")) CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth)) ; -------------------------------------------------------------------------- ; 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. ; -------------------------------------------------------------------------- ; Create the following JSON: ; { ; "DocNumber": "1070", ; "SyncToken": "0", ; "domain": "QBO", ; "Balance": 150.0, ; "BillAddr": { ; "City": "Bayshore", ; "Line1": "4581 Finch St.", ; "PostalCode": "94326", ; "Lat": "INVALID", ; "Long": "INVALID", ; "CountrySubDivisionCode": "CA", ; "Id": "2" ; }, ; "TxnDate": "2015-07-24", ; "TotalAmt": 150.0, ; "CustomerRef": { ; "name": "Amy's Bird Sanctuary", ; "value": "1" ; }, ; "CustomerMemo": { ; "value": "Added customer memo." ; }, ; "ShipAddr": { ; "City": "Bayshore", ; "Line1": "4581 Finch St.", ; "PostalCode": "94326", ; "Lat": "INVALID", ; "Long": "INVALID", ; "CountrySubDivisionCode": "CA", ; "Id": "109" ; }, ; "LinkedTxn": [ ; ], ; "DueDate": "2015-08-23", ; "PrintStatus": "NeedToPrint", ; "EmailStatus": "NotSet", ; "sparse": false, ; "Line": [ ; { ; "LineNum": 1, ; "Amount": 150.0, ; "SalesItemLineDetail": { ; "TaxCodeRef": { ; "value": "NON" ; }, ; "ItemRef": { ; "name": "Services", ; "value": "1" ; } ; }, ; "Id": "1", ; "DetailType": "SalesItemLineDetail" ; }, ; { ; "DetailType": "SubTotalLineDetail", ; "Amount": 150.0, ; "SubTotalLineDetail": {} ; } ; ], ; "ApplyTaxAfterDiscount": false, ; "CustomField": [ ; { ; "DefinitionId": "1", ; "Type": "StringType", ; "Name": "Crew #" ; } ; ], ; "Id": "239", ; "TxnTaxDetail": { ; "TotalTax": 0 ; }, ; "MetaData": { ; "CreateTime": "2015-07-24T10:35:08-07:00", ; "LastUpdatedTime": "2015-07-24T10:35:08-07:00" ; } ; } ; ; Use the this online tool to generate the code from sample JSON: ; Generate Code to Create JSON jsonReq.i = CkJsonObject::ckCreate() If jsonReq.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::ckUpdateString(jsonReq,"DocNumber","1070") CkJsonObject::ckUpdateString(jsonReq,"SyncToken","0") CkJsonObject::ckUpdateString(jsonReq,"domain","QBO") CkJsonObject::ckUpdateNumber(jsonReq,"Balance","150.0") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.City","Bayshore") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.Line1","4581 Finch St.") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.PostalCode","94326") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.Lat","INVALID") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.Long","INVALID") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.CountrySubDivisionCode","CA") CkJsonObject::ckUpdateString(jsonReq,"BillAddr.Id","2") CkJsonObject::ckUpdateString(jsonReq,"TxnDate","2015-07-24") CkJsonObject::ckUpdateNumber(jsonReq,"TotalAmt","150.0") CkJsonObject::ckUpdateString(jsonReq,"CustomerRef.name","Amy's Bird Sanctuary") CkJsonObject::ckUpdateString(jsonReq,"CustomerRef.value","1") CkJsonObject::ckUpdateString(jsonReq,"CustomerMemo.value","Added customer memo.") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.City","Bayshore") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.Line1","4581 Finch St.") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.PostalCode","94326") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.Lat","INVALID") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.Long","INVALID") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.CountrySubDivisionCode","CA") CkJsonObject::ckUpdateString(jsonReq,"ShipAddr.Id","109") CkJsonObject::ckUpdateNewArray(jsonReq,"LinkedTxn") CkJsonObject::ckUpdateString(jsonReq,"DueDate","2015-08-23") CkJsonObject::ckUpdateString(jsonReq,"PrintStatus","NeedToPrint") CkJsonObject::ckUpdateString(jsonReq,"EmailStatus","NotSet") CkJsonObject::ckUpdateBool(jsonReq,"sparse",0) CkJsonObject::ckUpdateInt(jsonReq,"Line[0].LineNum",1) CkJsonObject::ckUpdateNumber(jsonReq,"Line[0].Amount","150.0") CkJsonObject::ckUpdateString(jsonReq,"Line[0].SalesItemLineDetail.TaxCodeRef.value","NON") CkJsonObject::ckUpdateString(jsonReq,"Line[0].SalesItemLineDetail.ItemRef.name","Services") CkJsonObject::ckUpdateString(jsonReq,"Line[0].SalesItemLineDetail.ItemRef.value","1") CkJsonObject::ckUpdateString(jsonReq,"Line[0].Id","1") CkJsonObject::ckUpdateString(jsonReq,"Line[0].DetailType","SalesItemLineDetail") CkJsonObject::ckUpdateString(jsonReq,"Line[1].DetailType","SubTotalLineDetail") CkJsonObject::ckUpdateNumber(jsonReq,"Line[1].Amount","150.0") CkJsonObject::ckUpdateNewObject(jsonReq,"Line[1].SubTotalLineDetail") CkJsonObject::ckUpdateBool(jsonReq,"ApplyTaxAfterDiscount",0) CkJsonObject::ckUpdateString(jsonReq,"CustomField[0].DefinitionId","1") CkJsonObject::ckUpdateString(jsonReq,"CustomField[0].Type","StringType") CkJsonObject::ckUpdateString(jsonReq,"CustomField[0].Name","Crew #") CkJsonObject::ckUpdateString(jsonReq,"Id","239") CkJsonObject::ckUpdateInt(jsonReq,"TxnTaxDetail.TotalTax",0) CkJsonObject::ckUpdateString(jsonReq,"MetaData.CreateTime","2015-07-24T10:35:08-07:00") CkJsonObject::ckUpdateString(jsonReq,"MetaData.LastUpdatedTime","2015-07-24T10:35:08-07:00") sbRequestBody.i = CkStringBuilder::ckCreate() If sbRequestBody.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::ckEmitSb(jsonReq,sbRequestBody) CkRest::ckAddHeader(rest,"Content-Type","application/json") CkRest::ckAddHeader(rest,"Accept","application/json") CkRest::setCkAllowHeaderFolding(rest, 0) sbResponseBody.i = CkStringBuilder::ckCreate() If sbResponseBody.i = 0 Debug "Failed to create object." ProcedureReturn EndIf success = CkRest::ckFullRequestSb(rest,"POST","/v3/company/<realmID>/invoice",sbRequestBody,sbResponseBody) If success <> 1 Debug CkRest::ckLastErrorText(rest) CkJsonObject::ckDispose(jsonToken) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbAuth) CkJsonObject::ckDispose(jsonReq) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) ProcedureReturn EndIf respStatusCode.i = CkRest::ckResponseStatusCode(rest) ; Success is indicated by a 200 response status code. Debug "response status code = " + Str(respStatusCode) jsonResponse.i = CkJsonObject::ckCreate() If jsonResponse.i = 0 Debug "Failed to create object." ProcedureReturn EndIf CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody) CkJsonObject::setCkEmitCompact(jsonResponse, 0) Debug CkJsonObject::ckEmit(jsonResponse) If CkRest::ckResponseStatusCode(rest) <> 200 Debug "Failed." CkJsonObject::ckDispose(jsonToken) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbAuth) CkJsonObject::ckDispose(jsonReq) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) CkJsonObject::ckDispose(jsonResponse) ProcedureReturn EndIf ; 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": "2015-07-24", ; "domain": "QBO", ; "PrintStatus": "NeedToPrint", ; "TotalAmt": 150.0, ; "Line": [ ; { ; "LineNum": 1, ; "Amount": 150.0, ; "SalesItemLineDetail": { ; "TaxCodeRef": { ; "value": "NON" ; }, ; "ItemRef": { ; "name": "Services", ; "value": "1" ; } ; }, ; "Id": "1", ; "DetailType": "SalesItemLineDetail" ; }, ; { ; "DetailType": "SubTotalLineDetail", ; "Amount": 150.0, ; "SubTotalLineDetail": {} ; } ; ], ; "DueDate": "2015-08-23", ; "ApplyTaxAfterDiscount": false, ; "DocNumber": "1070", ; "sparse": false, ; "CustomerMemo": { ; "value": "Added customer memo." ; }, ; "Deposit": 0, ; "Balance": 150.0, ; "CustomerRef": { ; "name": "Amy's Bird Sanctuary", ; "value": "1" ; }, ; "TxnTaxDetail": { ; "TotalTax": 0 ; }, ; "SyncToken": "1", ; "LinkedTxn": [ ; ], ; "ShipAddr": { ; "CountrySubDivisionCode": "CA", ; "City": "Bayshore", ; "PostalCode": "94326", ; "Id": "118", ; "Line1": "4581 Finch St." ; }, ; "EmailStatus": "NotSet", ; "BillAddr": { ; "CountrySubDivisionCode": "CA", ; "City": "Bayshore", ; "PostalCode": "94326", ; "Id": "117", ; "Line1": "4581 Finch St." ; }, ; "MetaData": { ; "CreateTime": "2015-07-24T10:35:08-07:00", ; "LastUpdatedTime": "2015-07-24T10:53:39-07:00" ; }, ; "CustomField": [ ; { ; "DefinitionId": "1", ; "Type": "StringType", ; "Name": "Crew #" ; } ; ], ; "Id": "239" ; }, ; "time": "2015-07-24T10:53:39.287-07:00" ; } ; LineNum.i Amount.s SalesItemLineDetailTaxCodeRefValue.s SalesItemLineDetailItemRefName.s SalesItemLineDetailItemRefValue.s Id.s DetailType.s DefinitionId.s invType.s Name.s InvoiceTxnDate.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.TxnDate") InvoiceDomain.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.domain") InvoicePrintStatus.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.PrintStatus") InvoiceTotalAmt.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.TotalAmt") InvoiceDueDate.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.DueDate") InvoiceApplyTaxAfterDiscount.i = CkJsonObject::ckBoolOf(jsonResponse,"Invoice.ApplyTaxAfterDiscount") InvoiceDocNumber.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.DocNumber") InvoiceSparse.i = CkJsonObject::ckBoolOf(jsonResponse,"Invoice.sparse") InvoiceCustomerMemoValue.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomerMemo.value") InvoiceDeposit.i = CkJsonObject::ckIntOf(jsonResponse,"Invoice.Deposit") InvoiceBalance.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Balance") InvoiceCustomerRefName.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomerRef.name") InvoiceCustomerRefValue.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomerRef.value") InvoiceTxnTaxDetailTotalTax.i = CkJsonObject::ckIntOf(jsonResponse,"Invoice.TxnTaxDetail.TotalTax") InvoiceSyncToken.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.SyncToken") InvoiceShipAddrCountrySubDivisionCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.CountrySubDivisionCode") InvoiceShipAddrCity.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.City") InvoiceShipAddrPostalCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.PostalCode") InvoiceShipAddrId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Id") InvoiceShipAddrLine1.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.ShipAddr.Line1") InvoiceEmailStatus.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.EmailStatus") InvoiceBillAddrCountrySubDivisionCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.CountrySubDivisionCode") InvoiceBillAddrCity.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.City") InvoiceBillAddrPostalCode.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.PostalCode") InvoiceBillAddrId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Id") InvoiceBillAddrLine1.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.BillAddr.Line1") InvoiceMetaDataCreateTime.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.MetaData.CreateTime") InvoiceMetaDataLastUpdatedTime.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.MetaData.LastUpdatedTime") InvoiceId.s = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Id") time.s = CkJsonObject::ckStringOf(jsonResponse,"time") i.i = 0 count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.Line") While i < count_i CkJsonObject::setCkI(jsonResponse, i) LineNum = CkJsonObject::ckIntOf(jsonResponse,"Invoice.Line[i].LineNum") Amount = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].Amount") SalesItemLineDetailTaxCodeRefValue = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.TaxCodeRef.value") SalesItemLineDetailItemRefName = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.name") SalesItemLineDetailItemRefValue = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].SalesItemLineDetail.ItemRef.value") Id = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].Id") DetailType = CkJsonObject::ckStringOf(jsonResponse,"Invoice.Line[i].DetailType") i = i + 1 Wend i = 0 count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.LinkedTxn") While i < count_i CkJsonObject::setCkI(jsonResponse, i) i = i + 1 Wend i = 0 count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Invoice.CustomField") While i < count_i CkJsonObject::setCkI(jsonResponse, i) DefinitionId = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].DefinitionId") invType = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].Type") Name = CkJsonObject::ckStringOf(jsonResponse,"Invoice.CustomField[i].Name") i = i + 1 Wend CkJsonObject::ckDispose(jsonToken) CkRest::ckDispose(rest) CkStringBuilder::ckDispose(sbAuth) CkJsonObject::ckDispose(jsonReq) CkStringBuilder::ckDispose(sbRequestBody) CkStringBuilder::ckDispose(sbResponseBody) CkJsonObject::ckDispose(jsonResponse) ProcedureReturn EndProcedure |
||||
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.