Chilkat Online Tools

PureBasic / New FreshBooks / Create Prepayment Credit

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"credit_note.credit_number","0000070")
    CkJsonObject::ckUpdateString(json,"credit_note.currency_code","CAD")
    CkJsonObject::ckUpdateString(json,"credit_note.create_date","2020-07-31")
    CkJsonObject::ckUpdateString(json,"credit_note.notes","Thank you for paying ahead of time")
    CkJsonObject::ckUpdateString(json,"credit_note.credit_type","prepayment")
    CkJsonObject::ckUpdateString(json,"credit_note.terms","Will be applied to future invoice")
    CkJsonObject::ckUpdateString(json,"credit_note.lines[0].name","Credit")
    CkJsonObject::ckUpdateString(json,"credit_note.lines[0].description","PrePayment for work")
    CkJsonObject::ckUpdateNull(json,"credit_note.lines[0].taxName1")
    CkJsonObject::ckUpdateNull(json,"credit_note.lines[0].taxAmount1")
    CkJsonObject::ckUpdateNull(json,"credit_note.lines[0].taxName2")
    CkJsonObject::ckUpdateNull(json,"credit_note.lines[0].taxAmount2")
    CkJsonObject::ckUpdateBool(json,"credit_note.lines[0].compounded_tax",0)
    CkJsonObject::ckUpdateInt(json,"credit_note.lines[0].qty",1)
    CkJsonObject::ckUpdateString(json,"credit_note.lines[0].unit_cost.amount","200")
    CkJsonObject::ckUpdateString(json,"credit_note.lines[0].unit_cost.code","CAD")
    CkJsonObject::ckUpdateNull(json,"credit_note.lines[0].credit_note")
    CkJsonObject::ckUpdateInt(json,"credit_note.clientid",123)

    CkHttp::ckSetRequestHeader(http,"Authorization","Bearer")

    resp.i = CkHttp::ckPostJson3(http,"https://api.freshbooks.com/accounting/account/E86Qp/credit_notes/credit_notes","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": [
  ]
}