Chilkat Online Tools

DataFlex / New FreshBooks / Create Credit Note

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    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": "0000064",
    //     "currency_code": "CAD",
    //     "create_date": "2020-07-31",
    //     "notes": "Free $150 voucher",
    //     "credit_type": "goodwill",
    //     "terms": "Will be applied to future invoice",
    //     "language": "en",
    //     "lines": [
    //       {
    //         "name": "Credit",
    //         "description": "Goodwill Credit",
    //         "taxName1": null,
    //         "taxAmount1": null,
    //         "taxName2": null,
    //         "taxAmount2": null,
    //         "compounded_tax": false,
    //         "qty": 1,
    //         "unit_cost": {
    //           "amount": "150",
    //           "code": "CAD"
    //         },
    //         "credit_note": null
    //       }
    //     ],
    //     "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" "0000064" 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" "Free $150 voucher" To iSuccess
    Get ComUpdateString Of hoJson "credit_note.credit_type" "goodwill" 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].name" "Credit" To iSuccess
    Get ComUpdateString Of hoJson "credit_note.lines[0].description" "Goodwill Credit" To iSuccess
    Get ComUpdateNull Of hoJson "credit_note.lines[0].taxName1" To iSuccess
    Get ComUpdateNull Of hoJson "credit_note.lines[0].taxAmount1" To iSuccess
    Get ComUpdateNull Of hoJson "credit_note.lines[0].taxName2" To iSuccess
    Get ComUpdateNull Of hoJson "credit_note.lines[0].taxAmount2" 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 ComUpdateNull Of hoJson "credit_note.lines[0].credit_note" To iSuccess
    Get ComUpdateInt Of hoJson "credit_note.clientid" 123 To iSuccess

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes" "application/json" vJson 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 POST
	-d '{
    "credit_note": {
        "credit_number": "0000064",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "Free $150 voucher",
        "credit_type": "goodwill",
        "terms": "Will be applied to future invoice",
        "language": "en",
        "lines": [
            {
                "name": "Credit",
                "description": "Goodwill Credit",
                "taxName1": null,
                "taxAmount1": null,
                "taxName2": null,
                "taxAmount2": null,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "150",
                    "code": "CAD"
                },
                "credit_note": null
            }
        ],
        "clientid": {{clientid}}
    }
}'
https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes

Postman Collection Item JSON

{
  "name": "Create Credit Note",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000064\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"Free $150 voucher\",\n        \"credit_type\": \"goodwill\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"language\": \"en\",\n        \"lines\": [\n            {\n                \"name\": \"Credit\",\n                \"description\": \"Goodwill Credit\",\n                \"taxName1\": null,\n                \"taxAmount1\": null,\n                \"taxName2\": null,\n                \"taxAmount2\": null,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"150\",\n                    \"code\": \"CAD\"\n                },\n                \"credit_note\": null\n            }\n        ],\n        \"clientid\": {{clientid}}\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountid}}/credit_notes/credit_notes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountid}}",
        "credit_notes",
        "credit_notes"
      ]
    }
  },
  "response": [
  ]
}