autoit / New FreshBooks / Edit Vendor Details
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "bill_vendor": {
; "vendor_name": "IKEA",
; "primary_contact_first_name": "Jimmy",
; "primary_contact_last_name": "McNamara",
; "primary_contact_email": "jimmym@ikea.com",
; "primary_contact": null,
; "street": "332 Carlton Ave.",
; "street2": null,
; "city": "San Francisco",
; "province": "California",
; "postal_code": null,
; "country": "United States",
; "account_number": "45454545",
; "phone": "4158859378",
; "website": "ikea.com",
; "currency_code": "USD",
; "language": "en",
; "is_1099": false,
; "tax_defaults": [
; ]
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("bill_vendor.vendor_name","IKEA")
$oJson.UpdateString("bill_vendor.primary_contact_first_name","Jimmy")
$oJson.UpdateString("bill_vendor.primary_contact_last_name","McNamara")
$oJson.UpdateString("bill_vendor.primary_contact_email","jimmym@ikea.com")
$oJson.UpdateNull("bill_vendor.primary_contact")
$oJson.UpdateString("bill_vendor.street","332 Carlton Ave.")
$oJson.UpdateNull("bill_vendor.street2")
$oJson.UpdateString("bill_vendor.city","San Francisco")
$oJson.UpdateString("bill_vendor.province","California")
$oJson.UpdateNull("bill_vendor.postal_code")
$oJson.UpdateString("bill_vendor.country","United States")
$oJson.UpdateString("bill_vendor.account_number","45454545")
$oJson.UpdateString("bill_vendor.phone","4158859378")
$oJson.UpdateString("bill_vendor.website","ikea.com")
$oJson.UpdateString("bill_vendor.currency_code","USD")
$oJson.UpdateString("bill_vendor.language","en")
$oJson.UpdateBool("bill_vendor.is_1099",False)
$oJson.UpdateNewArray("bill_vendor.tax_defaults")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "response": {
; "result": {
; "bill_vendor": {
; "account_number": "45454545",
; "city": "San Francisco",
; "country": "United States",
; "created_at": "2020-10-09 15:25:05",
; "currency_code": "USD",
; "is_1099": false,
; "language": "en",
; "outstanding_balance": [
; {
; "amount": {
; "amount": "450.00",
; "code": "USD"
; }
; }
; ],
; "overdue_balance": [
; ],
; "phone": "4158859378",
; "postal_code": null,
; "primary_contact_email": "jimmym@ikea.com",
; "primary_contact_first_name": "Jimmy",
; "primary_contact_last_name": "McNamara",
; "province": "California",
; "street": "332 Carlton Ave.",
; "street2": null,
; "tax_defaults": [
; ],
; "updated_at": "2020-10-09 15:39:10",
; "vendor_name": "IKEA",
; "vendorid": 5,
; "vis_state": 0,
; "website": "ikea.com"
; }
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sAmount
Local $sCode
Local $sAccount_number = $oJResp.StringOf("response.result.bill_vendor.account_number")
Local $sCity = $oJResp.StringOf("response.result.bill_vendor.city")
Local $sCountry = $oJResp.StringOf("response.result.bill_vendor.country")
Local $sCreated_at = $oJResp.StringOf("response.result.bill_vendor.created_at")
Local $sCurrency_code = $oJResp.StringOf("response.result.bill_vendor.currency_code")
Local $bIs_1099 = $oJResp.BoolOf("response.result.bill_vendor.is_1099")
Local $sLanguage = $oJResp.StringOf("response.result.bill_vendor.language")
Local $sPhone = $oJResp.StringOf("response.result.bill_vendor.phone")
Local $sPostal_code = $oJResp.StringOf("response.result.bill_vendor.postal_code")
Local $sPrimary_contact_email = $oJResp.StringOf("response.result.bill_vendor.primary_contact_email")
Local $sPrimary_contact_first_name = $oJResp.StringOf("response.result.bill_vendor.primary_contact_first_name")
Local $sPrimary_contact_last_name = $oJResp.StringOf("response.result.bill_vendor.primary_contact_last_name")
Local $sProvince = $oJResp.StringOf("response.result.bill_vendor.province")
Local $sStreet = $oJResp.StringOf("response.result.bill_vendor.street")
Local $sStreet2 = $oJResp.StringOf("response.result.bill_vendor.street2")
Local $sUpdated_at = $oJResp.StringOf("response.result.bill_vendor.updated_at")
Local $sVendor_name = $oJResp.StringOf("response.result.bill_vendor.vendor_name")
Local $iVendorid = $oJResp.IntOf("response.result.bill_vendor.vendorid")
Local $iVis_state = $oJResp.IntOf("response.result.bill_vendor.vis_state")
Local $sWebsite = $oJResp.StringOf("response.result.bill_vendor.website")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("response.result.bill_vendor.outstanding_balance")
While $i < $iCount_i
$oJResp.I = $i
$sAmount = $oJResp.StringOf("response.result.bill_vendor.outstanding_balance[i].amount.amount")
$sCode = $oJResp.StringOf("response.result.bill_vendor.outstanding_balance[i].amount.code")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("response.result.bill_vendor.overdue_balance")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("response.result.bill_vendor.tax_defaults")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"bill_vendor": {
"vendor_name": "IKEA",
"primary_contact_first_name": "Jimmy",
"primary_contact_last_name": "McNamara",
"primary_contact_email": "jimmym@ikea.com",
"primary_contact": null,
"street": "332 Carlton Ave.",
"street2": null,
"city": "San Francisco",
"province": "California",
"postal_code": null,
"country": "United States",
"account_number": "45454545",
"phone": "4158859378",
"website": "ikea.com",
"currency_code": "USD",
"language": "en",
"is_1099": false,
"tax_defaults": []
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}
Postman Collection Item JSON
{
"name": "Edit Vendor Details",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_vendor\": {\n \"vendor_name\": \"IKEA\",\n \"primary_contact_first_name\": \"Jimmy\",\n \"primary_contact_last_name\": \"McNamara\",\n \"primary_contact_email\": \"jimmym@ikea.com\",\n \"primary_contact\": null,\n \"street\": \"332 Carlton Ave.\",\n \"street2\": null,\n \"city\": \"San Francisco\",\n \"province\": \"California\",\n \"postal_code\": null,\n \"country\": \"United States\",\n \"account_number\": \"45454545\",\n \"phone\": \"4158859378\",\n \"website\": \"ikea.com\",\n \"currency_code\": \"USD\",\n \"language\": \"en\",\n \"is_1099\": false,\n \"tax_defaults\": []\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors",
"{{vendorId}}"
]
}
},
"response": [
{
"name": "Edit Vendor Details",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"bill_vendor\": {\n \"vendor_name\": \"IKEA\",\n \"primary_contact_first_name\": \"Jimmy\",\n \"primary_contact_last_name\": \"McNamara\",\n \"primary_contact_email\": \"jimmym@ikea.com\",\n \"primary_contact\": null,\n \"street\": \"332 Carlton Ave.\",\n \"street2\": null,\n \"city\": \"San Francisco\",\n \"province\": \"California\",\n \"postal_code\": null,\n \"country\": \"United States\",\n \"account_number\": \"45454545\",\n \"phone\": \"4158859378\",\n \"website\": \"ikea.com\",\n \"currency_code\": \"USD\",\n \"language\": \"en\",\n \"is_1099\": false,\n \"tax_defaults\": []\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_vendors/bill_vendors/{{vendorId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"bill_vendors",
"bill_vendors",
"{{vendorId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Date",
"value": "Fri, 09 Oct 2020 15:39:09 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gGWFpfPRAGDFQNShECWl1eXxNcD1UOQUBIBhtRSFUICgJcUFcECA5XUggPAVBKVVYIThpWD11XUAJXXAcHAFdQAFNRQ0oFWV9DATw="
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "X-Content-Security-Policy",
"value": "default-src 'self'"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31556926; includeSubDomains; preload"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "X-RateLimit-Limit",
"value": "600"
},
{
"key": "X-RateLimit-Remaining",
"value": "599"
},
{
"key": "X-RateLimit-Reset",
"value": "1602258010"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Alt-Svc",
"value": "h3-Q050=\":443\"; ma=2592000,h3-Q046=\":443\"; ma=2592000,h3-Q043=\":443\"; ma=2592000,quic=\":443\"; ma=2592000; v=\"46,43\""
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"bill_vendor\": {\n \"account_number\": \"45454545\",\n \"city\": \"San Francisco\",\n \"country\": \"United States\",\n \"created_at\": \"2020-10-09 15:25:05\",\n \"currency_code\": \"USD\",\n \"is_1099\": false,\n \"language\": \"en\",\n \"outstanding_balance\": [\n {\n \"amount\": {\n \"amount\": \"450.00\",\n \"code\": \"USD\"\n }\n }\n ],\n \"overdue_balance\": [],\n \"phone\": \"4158859378\",\n \"postal_code\": null,\n \"primary_contact_email\": \"jimmym@ikea.com\",\n \"primary_contact_first_name\": \"Jimmy\",\n \"primary_contact_last_name\": \"McNamara\",\n \"province\": \"California\",\n \"street\": \"332 Carlton Ave.\",\n \"street2\": null,\n \"tax_defaults\": [],\n \"updated_at\": \"2020-10-09 15:39:10\",\n \"vendor_name\": \"IKEA\",\n \"vendorid\": 5,\n \"vis_state\": 0,\n \"website\": \"ikea.com\"\n }\n }\n }\n}"
}
]
}
