Chilkat Online Tools

Objective-C / New FreshBooks / Create Invoice with Expense

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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"
//         }
//       }
//     ]
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"invoice.customerid" value: [NSNumber numberWithInt: 485558]];
[json UpdateString: @"invoice.create_date" value: @"2019-06-20"];
[json UpdateInt: @"invoice.lines[0].type" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[0].description" value: @""];
[json UpdateString: @"invoice.lines[0].taxName1" value: @""];
[json UpdateInt: @"invoice.lines[0].taxAmount1" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[0].name" value: @"Paperwork"];
[json UpdateInt: @"invoice.lines[0].qty" value: [NSNumber numberWithInt: 1]];
[json UpdateString: @"invoice.lines[0].taxName2" value: @""];
[json UpdateInt: @"invoice.lines[0].taxAmount2" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[0].unit_cost.amount" value: @"5000.00"];
[json UpdateString: @"invoice.lines[0].unit_cost.code" value: @"USD"];
[json UpdateInt: @"invoice.lines[1].type" value: [NSNumber numberWithInt: 1]];
[json UpdateString: @"invoice.lines[1].description" value: @"Gas"];
[json UpdateInt: @"invoice.lines[1].expenseid" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"invoice.lines[1].taxName1" value: @""];
[json UpdateInt: @"invoice.lines[1].taxAmount1" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[1].name" value: @"Shell Oil"];
[json UpdateInt: @"invoice.lines[1].qty" value: [NSNumber numberWithInt: 1]];
[json UpdateString: @"invoice.lines[1].taxName2" value: @""];
[json UpdateInt: @"invoice.lines[1].taxAmount2" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[1].unit_cost.amount" value: @"120.00"];
[json UpdateString: @"invoice.lines[1].unit_cost.code" value: @"USD"];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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