Chilkat Online Tools

DataFlex / New FreshBooks / Create Prepayment Credit

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

    // 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": "Thank you for paying ahead of time",
    //     "credit_type": "prepayment",
    //     "terms": "Will be applied to future invoice",
    //     "lines": [
    //       {
    //         "name": "Credit",
    //         "description": "PrePayment for work",
    //         "taxName1": null,
    //         "taxAmount1": null,
    //         "taxName2": null,
    //         "taxAmount2": null,
    //         "compounded_tax": false,
    //         "qty": 1,
    //         "unit_cost": {
    //           "amount": "200",
    //           "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" "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" "Thank you for paying ahead of time" 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.lines[0].name" "Credit" To iSuccess
    Get ComUpdateString Of hoJson "credit_note.lines[0].description" "PrePayment for work" 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" "200" 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

    Send ComSetRequestHeader To hoHttp "Authorization" "Bearer"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes" vJson "application/json" vResp To iSuccess
    If (iSuccess = 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


End_Procedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Authorization: Bearer "
	-d '{
    "credit_note": {
        "credit_number": "0000070",
        "currency_code": "CAD",
        "create_date": "2020-07-31",
        "notes": "Thank you for paying ahead of time",
        "credit_type": "prepayment",
        "terms": "Will be applied to future invoice",
        "lines": [
            {
                "name": "Credit",
                "description": "PrePayment for work",
                "taxName1": null,
                "taxAmount1": null,
                "taxName2": null,
                "taxAmount2": null,
                "compounded_tax": false,
                "qty": 1,
                "unit_cost": {
                    "amount": "200",
                    "code": "CAD"
                },
                "credit_note": null
            }
        ],
        "clientid": {{clientId}}
    }
}'
https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes

Postman Collection Item JSON

{
  "name": "Create Prepayment Credit",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer ",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"credit_note\": {\n        \"credit_number\": \"0000070\",\n        \"currency_code\": \"CAD\",\n        \"create_date\": \"2020-07-31\",\n        \"notes\": \"Thank you for paying ahead of time\",\n        \"credit_type\": \"prepayment\",\n        \"terms\": \"Will be applied to future invoice\",\n        \"lines\": [\n            {\n                \"name\": \"Credit\",\n                \"description\": \"PrePayment for work\",\n                \"taxName1\": null,\n                \"taxAmount1\": null,\n                \"taxName2\": null,\n                \"taxAmount2\": null,\n                \"compounded_tax\": false,\n                \"qty\": 1,\n                \"unit_cost\": {\n                    \"amount\": \"200\",\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/E86Qp/credit_notes/credit_notes",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "E86Qp",
        "credit_notes",
        "credit_notes"
      ]
    }
  },
  "response": [
  ]
}