Chilkat Online Tools

PureBasic / New FreshBooks / Create Invoice with Expense

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.

    ; {
    ;   "invoice": {
    ;     "customerid": 485558,
    ;     "create_date": "2019-06-20",
    ;     "lines": [
    ;       {
    ;         "type": 0,
    ;         "description": "",
    ;         "taxName1": "",
    ;         "taxAmount1": 0,
    ;         "name": "Paperwork",
    ;         "qty": 1,
    ;         "taxName2": "",
    ;         "taxAmount2": 0,
    ;         "unit_cost": {
    ;           "amount": "5000.00",
    ;           "code": "USD"
    ;         }
    ;       },
    ;       {
    ;         "type": 1,
    ;         "description": "Gas",
    ;         "expenseid": 123,
    ;         "taxName1": "",
    ;         "taxAmount1": 0,
    ;         "name": "Shell Oil",
    ;         "qty": 1,
    ;         "taxName2": "",
    ;         "taxAmount2": 0,
    ;         "unit_cost": {
    ;           "amount": "120.00",
    ;           "code": "USD"
    ;         }
    ;       }
    ;     ]
    ;   }
    ; }

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

    CkJsonObject::ckUpdateInt(json,"invoice.customerid",485558)
    CkJsonObject::ckUpdateString(json,"invoice.create_date","2019-06-20")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[0].type",0)
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].description","")
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].taxName1","")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[0].taxAmount1",0)
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].name","Paperwork")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[0].qty",1)
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].taxName2","")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[0].taxAmount2",0)
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].unit_cost.amount","5000.00")
    CkJsonObject::ckUpdateString(json,"invoice.lines[0].unit_cost.code","USD")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[1].type",1)
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].description","Gas")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[1].expenseid",123)
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].taxName1","")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[1].taxAmount1",0)
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].name","Shell Oil")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[1].qty",1)
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].taxName2","")
    CkJsonObject::ckUpdateInt(json,"invoice.lines[1].taxAmount2",0)
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].unit_cost.amount","120.00")
    CkJsonObject::ckUpdateString(json,"invoice.lines[1].unit_cost.code","USD")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices","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 "Content-Type: application/json"
	-d '{
  "invoice": {
    "customerid": 485558,
    "create_date": "2019-06-20",
    "lines": [
      {
        "type": 0,
        "description": "",
        "taxName1": "",
        "taxAmount1": 0,
        "name": "Paperwork",
        "qty": 1,
        "taxName2": "",
        "taxAmount2": 0,
        "unit_cost": {
            "amount": "5000.00",
            "code": "USD"
        }
      },
      {
        "type": 1,
        "description": "Gas",
        "expenseid": {{expenseId}},
        "taxName1": "",
        "taxAmount1": 0,
        "name": "Shell Oil",
        "qty": 1,
        "taxName2": "",
        "taxAmount2": 0,
        "unit_cost": {
            "amount": "120.00",
            "code": "USD"
        }
      }
    ]
  }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices

Postman Collection Item JSON

{
  "name": "Create Invoice with Expense ",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"invoice\": {\n    \"customerid\": 485558,\n    \"create_date\": \"2019-06-20\",\n    \"lines\": [\n      {\n        \"type\": 0,\n        \"description\": \"\",\n        \"taxName1\": \"\",\n        \"taxAmount1\": 0,\n        \"name\": \"Paperwork\",\n        \"qty\": 1,\n        \"taxName2\": \"\",\n        \"taxAmount2\": 0,\n        \"unit_cost\": {\n            \"amount\": \"5000.00\",\n            \"code\": \"USD\"\n        }\n      },\n      {\n        \"type\": 1,\n        \"description\": \"Gas\",\n        \"expenseid\": {{expenseId}},\n        \"taxName1\": \"\",\n        \"taxAmount1\": 0,\n        \"name\": \"Shell Oil\",\n        \"qty\": 1,\n        \"taxName2\": \"\",\n        \"taxAmount2\": 0,\n        \"unit_cost\": {\n            \"amount\": \"120.00\",\n            \"code\": \"USD\"\n        }\n      }\n    ]\n  }\n}\n"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoices",
        "invoices"
      ]
    },
    "description": "Creating invoice with expense.\n\nFirst you will need to create an expense. Once that is created, save the expenseId and add it to the invoice. \n\nWhen adding an expense, make sure you add to the `markup_percent` parameter the amount you want to markup by and set `cogs` to `true` if it is an item you have paid for. "
  },
  "response": [
  ]
}