Objective-C / New FreshBooks / Single Invoice w/ Payment Gateway
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoDtObj.h>
#import <NSString.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": 123,
// "create_date": "2019-04-20",
// "lines": [
// {
// "type": 0,
// "description": "",
// "taxName1": "",
// "taxAmount1": 0,
// "name": "Climbing Helmet",
// "qty": 1,
// "taxName2": "",
// "taxAmount2": 0,
// "unit_cost": {
// "amount": "80.00",
// "code": "USD"
// }
// },
// {
// "type": 0,
// "description": "",
// "taxName1": "",
// "taxAmount1": 0,
// "name": "Belay Device",
// "qty": 1,
// "taxName2": "",
// "taxAmount2": 0,
// "unit_cost": {
// "amount": "100.00",
// "code": "USD"
// }
// }
// ],
// "presentation": {
// "image_logo_src": "{{image_logo_src}}",
// "theme_primary_color": "{{theme_primary_color}}"
// }
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"invoice.customerid" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"invoice.create_date" value: @"2019-04-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: @"Climbing Helmet"];
[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: @"80.00"];
[json UpdateString: @"invoice.lines[0].unit_cost.code" value: @"USD"];
[json UpdateInt: @"invoice.lines[1].type" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[1].description" value: @""];
[json UpdateString: @"invoice.lines[1].taxName1" value: @""];
[json UpdateInt: @"invoice.lines[1].taxAmount1" value: [NSNumber numberWithInt: 0]];
[json UpdateString: @"invoice.lines[1].name" value: @"Belay Device"];
[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: @"100.00"];
[json UpdateString: @"invoice.lines[1].unit_cost.code" value: @"USD"];
[json UpdateString: @"invoice.presentation.image_logo_src" value: @"{{image_logo_src}}"];
[json UpdateString: @"invoice.presentation.theme_primary_color" value: @"{{theme_primary_color}}"];
// 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/{{invoiceid}}?include%5B%5D=allowed_gateways" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "invoice": {
// "accountid": "wkMd2g",
// "accounting_systemid": "wkMd2g",
// "address": "",
// "allowed_gateways": [
// ],
// "amount": {
// "amount": "180.00",
// "code": "USD"
// },
// "auto_bill": false,
// "autobill_status": null,
// "basecampid": 0,
// "city": "Toronto",
// "code": "M6P 3T1",
// "country": "",
// "create_date": "2019-04-20",
// "created_at": "2019-05-09 16:02:40",
// "currency_code": "USD",
// "current_organization": "Space Is Only Noise",
// "customerid": 92402,
// "date_paid": null,
// "deposit_amount": null,
// "deposit_percentage": null,
// "deposit_status": "none",
// "description": "",
// "discount_description": null,
// "discount_total": {
// "amount": "0.00",
// "code": "USD"
// },
// "discount_value": "0",
// "display_status": "draft",
// "dispute_status": null,
// "due_date": "2019-04-20",
// "due_offset_days": 0,
// "estimateid": 0,
// "ext_archive": 0,
// "fname": "Nicholas",
// "fulfillment_date": null,
// "generation_date": null,
// "gmail": false,
// "id": 74888,
// "invoice_number": "0000029",
// "invoiceid": 74888,
// "language": "en",
// "last_order_status": null,
// "lname": "Jaar",
// "notes": "",
// "organization": "Space Is Only Noise",
// "outstanding": {
// "amount": "180.00",
// "code": "USD"
// },
// "ownerid": 1,
// "paid": {
// "amount": "0.00",
// "code": "USD"
// },
// "parent": 0,
// "payment_details": "",
// "payment_status": "unpaid",
// "po_number": null,
// "province": "Ontario",
// "return_uri": null,
// "sentid": 1,
// "show_attachments": true,
// "status": 1,
// "street": "1655 Dupont St. W.",
// "street2": "",
// "template": "clean-grouped",
// "terms": "",
// "updated": "2019-05-09 16:02:41",
// "v3_status": "draft",
// "vat_name": "",
// "vat_number": "",
// "vis_state": 0
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
CkoDtObj *Date_paid = [[CkoDtObj alloc] init];
NSString *Accountid = [jResp StringOf: @"response.result.invoice.accountid"];
NSString *Accounting_systemid = [jResp StringOf: @"response.result.invoice.accounting_systemid"];
NSString *Address = [jResp StringOf: @"response.result.invoice.address"];
NSString *Amount = [jResp StringOf: @"response.result.invoice.amount.amount"];
NSString *Code = [jResp StringOf: @"response.result.invoice.amount.code"];
BOOL Auto_bill = [jResp BoolOf: @"response.result.invoice.auto_bill"];
NSString *Autobill_status = [jResp StringOf: @"response.result.invoice.autobill_status"];
int Basecampid = [[jResp IntOf: @"response.result.invoice.basecampid"] intValue];
NSString *City = [jResp StringOf: @"response.result.invoice.city"];
NSString *InvoiceCode = [jResp StringOf: @"response.result.invoice.code"];
NSString *Country = [jResp StringOf: @"response.result.invoice.country"];
NSString *Create_date = [jResp StringOf: @"response.result.invoice.create_date"];
NSString *Created_at = [jResp StringOf: @"response.result.invoice.created_at"];
NSString *Currency_code = [jResp StringOf: @"response.result.invoice.currency_code"];
NSString *Current_organization = [jResp StringOf: @"response.result.invoice.current_organization"];
int Customerid = [[jResp IntOf: @"response.result.invoice.customerid"] intValue];
[jResp DtOf: @"response.result.invoice.date_paid" bLocal: NO dt: Date_paid];
NSString *Deposit_amount = [jResp StringOf: @"response.result.invoice.deposit_amount"];
NSString *Deposit_percentage = [jResp StringOf: @"response.result.invoice.deposit_percentage"];
NSString *Deposit_status = [jResp StringOf: @"response.result.invoice.deposit_status"];
NSString *Description = [jResp StringOf: @"response.result.invoice.description"];
NSString *Discount_description = [jResp StringOf: @"response.result.invoice.discount_description"];
NSString *Discount_totalAmount = [jResp StringOf: @"response.result.invoice.discount_total.amount"];
NSString *Discount_totalCode = [jResp StringOf: @"response.result.invoice.discount_total.code"];
NSString *Discount_value = [jResp StringOf: @"response.result.invoice.discount_value"];
NSString *Display_status = [jResp StringOf: @"response.result.invoice.display_status"];
NSString *Dispute_status = [jResp StringOf: @"response.result.invoice.dispute_status"];
NSString *Due_date = [jResp StringOf: @"response.result.invoice.due_date"];
int Due_offset_days = [[jResp IntOf: @"response.result.invoice.due_offset_days"] intValue];
int Estimateid = [[jResp IntOf: @"response.result.invoice.estimateid"] intValue];
int Ext_archive = [[jResp IntOf: @"response.result.invoice.ext_archive"] intValue];
NSString *Fname = [jResp StringOf: @"response.result.invoice.fname"];
NSString *Fulfillment_date = [jResp StringOf: @"response.result.invoice.fulfillment_date"];
NSString *Generation_date = [jResp StringOf: @"response.result.invoice.generation_date"];
BOOL Gmail = [jResp BoolOf: @"response.result.invoice.gmail"];
int Id = [[jResp IntOf: @"response.result.invoice.id"] intValue];
NSString *Invoice_number = [jResp StringOf: @"response.result.invoice.invoice_number"];
int Invoiceid = [[jResp IntOf: @"response.result.invoice.invoiceid"] intValue];
NSString *Language = [jResp StringOf: @"response.result.invoice.language"];
NSString *Last_order_status = [jResp StringOf: @"response.result.invoice.last_order_status"];
NSString *Lname = [jResp StringOf: @"response.result.invoice.lname"];
NSString *Notes = [jResp StringOf: @"response.result.invoice.notes"];
NSString *Organization = [jResp StringOf: @"response.result.invoice.organization"];
NSString *OutstandingAmount = [jResp StringOf: @"response.result.invoice.outstanding.amount"];
NSString *OutstandingCode = [jResp StringOf: @"response.result.invoice.outstanding.code"];
int Ownerid = [[jResp IntOf: @"response.result.invoice.ownerid"] intValue];
NSString *PaidAmount = [jResp StringOf: @"response.result.invoice.paid.amount"];
NSString *PaidCode = [jResp StringOf: @"response.result.invoice.paid.code"];
int Parent = [[jResp IntOf: @"response.result.invoice.parent"] intValue];
NSString *Payment_details = [jResp StringOf: @"response.result.invoice.payment_details"];
NSString *Payment_status = [jResp StringOf: @"response.result.invoice.payment_status"];
NSString *Po_number = [jResp StringOf: @"response.result.invoice.po_number"];
NSString *Province = [jResp StringOf: @"response.result.invoice.province"];
NSString *Return_uri = [jResp StringOf: @"response.result.invoice.return_uri"];
int Sentid = [[jResp IntOf: @"response.result.invoice.sentid"] intValue];
BOOL Show_attachments = [jResp BoolOf: @"response.result.invoice.show_attachments"];
int Status = [[jResp IntOf: @"response.result.invoice.status"] intValue];
NSString *Street = [jResp StringOf: @"response.result.invoice.street"];
NSString *Street2 = [jResp StringOf: @"response.result.invoice.street2"];
NSString *Template = [jResp StringOf: @"response.result.invoice.template"];
NSString *Terms = [jResp StringOf: @"response.result.invoice.terms"];
NSString *Updated = [jResp StringOf: @"response.result.invoice.updated"];
NSString *V3_status = [jResp StringOf: @"response.result.invoice.v3_status"];
NSString *Vat_name = [jResp StringOf: @"response.result.invoice.vat_name"];
NSString *Vat_number = [jResp StringOf: @"response.result.invoice.vat_number"];
int Vis_state = [[jResp IntOf: @"response.result.invoice.vis_state"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"response.result.invoice.allowed_gateways"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
i = i + 1;
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"invoice": {
"customerid": {{customerId}},
"create_date": "2019-04-20",
"lines": [
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Climbing Helmet",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "80.00",
"code": "USD"
}
},
{
"type": 0,
"description": "",
"taxName1": "",
"taxAmount1": 0,
"name": "Belay Device",
"qty": 1,
"taxName2": "",
"taxAmount2": 0,
"unit_cost": {
"amount": "100.00",
"code": "USD"
}
}
],
"presentation": {
"image_logo_src": {{imgSrc}},
"theme_primary_color": {{themeColor}}
}
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceid}}?include%5B%5D=allowed_gateways
Postman Collection Item JSON
{
"name": "Single Invoice w/ Payment Gateway",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"invoiceId\", jsonData.response.result.invoice.id)",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"customerid\": {{customerId}},\n\t\t\"create_date\": \"2019-04-20\",\n\t\t\"lines\": [\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Climbing Helmet\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"80.00\",\n\t \"code\": \"USD\"\n\t }\n\t },\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Belay Device\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"100.00\",\n\t \"code\": \"USD\"\n\t }\n\t }\n\t ],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}}\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices/{{invoiceid}}?include%5B%5D=allowed_gateways",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices",
"{{invoiceid}}"
],
"query": [
{
"key": "include%5B%5D",
"value": "allowed_gateways"
}
]
},
"description": "Call an invoice and display the enabled gateway on that invoice.\n\nStripe = id: 26 |\nFBpay = id: 30 |\nPayPal = id: 7"
},
"response": [
{
"name": "Single Invoice w/ Payment Gateway",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"invoice\": {\n\t\t\"customerid\": {{customerId}},\n\t\t\"create_date\": \"2019-04-20\",\n\t\t\"lines\": [\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Climbing Helmet\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"80.00\",\n\t \"code\": \"USD\"\n\t }\n\t },\n\t {\n\t \"type\": 0,\n\t \"description\": \"\",\n\t \"taxName1\": \"\",\n\t \"taxAmount1\": 0,\n\t \"name\": \"Belay Device\",\n\t \"qty\": 1,\n\t \"taxName2\": \"\",\n\t \"taxAmount2\": 0,\n\t \"unit_cost\": {\n\t \"amount\": \"100.00\",\n\t \"code\": \"USD\"\n\t }\n\t }\n\t ],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}}\n\t\t}\n\t}\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices?include%5B%5D=allowed_gateways",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"invoices",
"invoices"
],
"query": [
{
"key": "include%5B%5D",
"value": "allowed_gateways"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXQEcVUR1RHVBWDgRRUVQKAAldWFIFAgNSSAAEBldKQVoHUApVDglQUwcGCVJXBAJASFBWDRUGZQ=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557432219"
},
{
"key": "Retry-After",
"value": "57"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Wed, 09 May 2018 20:02:41 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Thu, 09 May 2019 20:02:41 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17357-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"invoice\": {\n \"accountid\": \"wkMd2g\",\n \"accounting_systemid\": \"wkMd2g\",\n \"address\": \"\",\n \"allowed_gateways\": [],\n \"amount\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"auto_bill\": false,\n \"autobill_status\": null,\n \"basecampid\": 0,\n \"city\": \"Toronto\",\n \"code\": \"M6P 3T1\",\n \"country\": \"\",\n \"create_date\": \"2019-04-20\",\n \"created_at\": \"2019-05-09 16:02:40\",\n \"currency_code\": \"USD\",\n \"current_organization\": \"Space Is Only Noise\",\n \"customerid\": 92402,\n \"date_paid\": null,\n \"deposit_amount\": null,\n \"deposit_percentage\": null,\n \"deposit_status\": \"none\",\n \"description\": \"\",\n \"discount_description\": null,\n \"discount_total\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"discount_value\": \"0\",\n \"display_status\": \"draft\",\n \"dispute_status\": null,\n \"due_date\": \"2019-04-20\",\n \"due_offset_days\": 0,\n \"estimateid\": 0,\n \"ext_archive\": 0,\n \"fname\": \"Nicholas\",\n \"fulfillment_date\": null,\n \"generation_date\": null,\n \"gmail\": false,\n \"id\": 74888,\n \"invoice_number\": \"0000029\",\n \"invoiceid\": 74888,\n \"language\": \"en\",\n \"last_order_status\": null,\n \"lname\": \"Jaar\",\n \"notes\": \"\",\n \"organization\": \"Space Is Only Noise\",\n \"outstanding\": {\n \"amount\": \"180.00\",\n \"code\": \"USD\"\n },\n \"ownerid\": 1,\n \"paid\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"parent\": 0,\n \"payment_details\": \"\",\n \"payment_status\": \"unpaid\",\n \"po_number\": null,\n \"province\": \"Ontario\",\n \"return_uri\": null,\n \"sentid\": 1,\n \"show_attachments\": true,\n \"status\": 1,\n \"street\": \"1655 Dupont St. W.\",\n \"street2\": \"\",\n \"template\": \"clean-grouped\",\n \"terms\": \"\",\n \"updated\": \"2019-05-09 16:02:41\",\n \"v3_status\": \"draft\",\n \"vat_name\": \"\",\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
