DataFlex / New FreshBooks / Update Prepayment Credit
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "credit_note": {
// "credit_number": "0000070",
// "currency_code": "CAD",
// "create_date": "2020-07-31",
// "notes": "PrePayment for work",
// "credit_type": "prepayment",
// "terms": "Will be applied to future invoice",
// "language": "en",
// "lines": [
// {
// "id": "20375-1",
// "name": "Credit",
// "description": "Current Credit Balance",
// "taxName1": null,
// "taxAmount1": 0,
// "taxName2": null,
// "taxAmount2": 0,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "150",
// "code": "CAD"
// }
// },
// {
// "name": "Credit",
// "description": "Current Credit Balance",
// "taxName1": null,
// "taxAmount1": 0,
// "taxName2": null,
// "taxAmount2": 0,
// "compounded_tax": false,
// "qty": 1,
// "unit_cost": {
// "amount": "100",
// "code": "CAD"
// }
// }
// ],
// "clientid": 123
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "credit_note.credit_number" "0000070" To iSuccess
Get ComUpdateString Of hoJson "credit_note.currency_code" "CAD" To iSuccess
Get ComUpdateString Of hoJson "credit_note.create_date" "2020-07-31" To iSuccess
Get ComUpdateString Of hoJson "credit_note.notes" "PrePayment for work" To iSuccess
Get ComUpdateString Of hoJson "credit_note.credit_type" "prepayment" To iSuccess
Get ComUpdateString Of hoJson "credit_note.terms" "Will be applied to future invoice" To iSuccess
Get ComUpdateString Of hoJson "credit_note.language" "en" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[0].id" "20375-1" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[0].name" "Credit" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[0].description" "Current Credit Balance" To iSuccess
Get ComUpdateNull Of hoJson "credit_note.lines[0].taxName1" To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[0].taxAmount1" 0 To iSuccess
Get ComUpdateNull Of hoJson "credit_note.lines[0].taxName2" To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[0].taxAmount2" 0 To iSuccess
Get ComUpdateBool Of hoJson "credit_note.lines[0].compounded_tax" False To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[0].qty" 1 To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[0].unit_cost.amount" "150" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[0].unit_cost.code" "CAD" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[1].name" "Credit" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[1].description" "Current Credit Balance" To iSuccess
Get ComUpdateNull Of hoJson "credit_note.lines[1].taxName1" To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[1].taxAmount1" 0 To iSuccess
Get ComUpdateNull Of hoJson "credit_note.lines[1].taxName2" To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[1].taxAmount2" 0 To iSuccess
Get ComUpdateBool Of hoJson "credit_note.lines[1].compounded_tax" False To iSuccess
Get ComUpdateInt Of hoJson "credit_note.lines[1].qty" 1 To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[1].unit_cost.amount" "100" To iSuccess
Get ComUpdateString Of hoJson "credit_note.lines[1].unit_cost.code" "CAD" To iSuccess
Get ComUpdateInt Of hoJson "credit_note.clientid" 123 To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X PUT
-d '{
"credit_note": {
"credit_number": "0000070",
"currency_code": "CAD",
"create_date": "2020-07-31",
"notes": "PrePayment for work",
"credit_type": "prepayment",
"terms": "Will be applied to future invoice",
"language": "en",
"lines": [
{
"id": "20375-1",
"name": "Credit",
"description": "Current Credit Balance",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "150",
"code": "CAD"
}
},
{
"name": "Credit",
"description": "Current Credit Balance",
"taxName1": null,
"taxAmount1": 0,
"taxName2": null,
"taxAmount2": 0,
"compounded_tax": false,
"qty": 1,
"unit_cost": {
"amount": "100",
"code": "CAD"
}
}
],
"clientid": {{clientId}}
}
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}
Postman Collection Item JSON
{
"name": "Update Prepayment Credit",
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"credit_note\": {\n \"credit_number\": \"0000070\",\n \"currency_code\": \"CAD\",\n \"create_date\": \"2020-07-31\",\n \"notes\": \"PrePayment for work\",\n \"credit_type\": \"prepayment\",\n \"terms\": \"Will be applied to future invoice\",\n \"language\": \"en\",\n \"lines\": [\n {\n \"id\": \"20375-1\",\n \"name\": \"Credit\",\n \"description\": \"Current Credit Balance\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"150\",\n \"code\": \"CAD\"\n }\n },\n {\n \"name\": \"Credit\",\n \"description\": \"Current Credit Balance\",\n \"taxName1\": null,\n \"taxAmount1\": 0,\n \"taxName2\": null,\n \"taxAmount2\": 0,\n \"compounded_tax\": false,\n \"qty\": 1,\n \"unit_cost\": {\n \"amount\": \"100\",\n \"code\": \"CAD\"\n }\n }\n ],\n \"clientid\": {{clientId}}\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes/{{creditnote}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountid}}",
"credit_notes",
"credit_notes",
"{{creditnote}}"
]
}
},
"response": [
]
}
