Chilkat Online Tools

Unicode C++ / New FreshBooks / Single Invoice w/ Logo and styles

Back to Collection Items

void ChilkatSample(void)
    {
    json.UpdateInt(L"invoice.customerid",123);    json.UpdateString(L"invoice.create_date",L"2019-04-20");    json.UpdateInt(L"invoice.lines[0].type",0);    json.UpdateString(L"invoice.lines[0].description",L"");    json.UpdateString(L"invoice.lines[0].taxName1",L"");    json.UpdateInt(L"invoice.lines[0].taxAmount1",0);    json.UpdateString(L"invoice.lines[0].name",L"Climbing Helmet");    json.UpdateInt(L"invoice.lines[0].qty",1);    json.UpdateString(L"invoice.lines[0].taxName2",L"");    json.UpdateInt(L"invoice.lines[0].taxAmount2",0);    json.UpdateString(L"invoice.lines[0].unit_cost.amount",L"80.00");    json.UpdateString(L"invoice.lines[0].unit_cost.code",L"USD");    json.UpdateInt(L"invoice.lines[1].type",0);    json.UpdateString(L"invoice.lines[1].description",L"");    json.UpdateString(L"invoice.lines[1].taxName1",L"");    json.UpdateInt(L"invoice.lines[1].taxAmount1",0);    json.UpdateString(L"invoice.lines[1].name",L"Belay Device");    json.UpdateInt(L"invoice.lines[1].qty",1);    json.UpdateString(L"invoice.lines[1].taxName2",L"");    json.UpdateInt(L"invoice.lines[1].taxAmount2",0);    json.UpdateString(L"invoice.lines[1].unit_cost.amount",L"100.00");    json.UpdateString(L"invoice.lines[1].unit_cost.code",L"USD");    json.UpdateString(L"invoice.presentation.image_logo_src",L"{{image_logo_src}}");    json.UpdateString(L"invoice.presentation.theme_primary_color",L"{{theme_primary_color}}");    json.UpdateString(L"invoice.presentation.theme_layout",L"simple");    json.UpdateString(L"invoice.presentation.theme_font_name",L"modern");    http.put_AuthToken(L"<access_token>");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.DtOf(L"response.result.invoice.date_paid",false,Date_paid);
    }

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}},
			 "theme_layout": "simple",
			 "theme_font_name": "modern"
		}
	}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices

Postman Collection Item JSON

{
  "name": "Single Invoice w/ Logo and styles",
  "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\t\t{\n\t\t\t\t\"type\": 0,\n\t\t\t\t\"description\": \"\",\n\t\t\t\t\"taxName1\": \"\",\n\t\t\t\t\"taxAmount1\": 0,\n\t\t\t\t\"name\": \"Climbing Helmet\",\n\t\t\t\t\"qty\": 1,\n\t\t\t\t\"taxName2\": \"\",\n\t\t\t\t\"taxAmount2\": 0,\n\t\t\t\t\"unit_cost\": {\n\t\t\t\t\t\"amount\": \"80.00\",\n\t\t\t\t\t\"code\": \"USD\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"type\": 0,\n\t\t\t\t\"description\": \"\",\n\t\t\t\t\"taxName1\": \"\",\n\t\t\t\t\"taxAmount1\": 0,\n\t\t\t\t\"name\": \"Belay Device\",\n\t\t\t\t\"qty\": 1,\n\t\t\t\t\"taxName2\": \"\",\n\t\t\t\t\"taxAmount2\": 0,\n\t\t\t\t\"unit_cost\": {\n\t\t\t\t\t\"amount\": \"100.00\",\n\t\t\t\t\t\"code\": \"USD\"\n\t\t\t\t}\n\t\t\t}\n\t\t],\n\t\t\"presentation\": {\n\t\t\t\"image_logo_src\": {{imgSrc}},\n\t\t\t \"theme_primary_color\": {{themeColor}},\n\t\t\t \"theme_layout\": \"simple\",\n\t\t\t \"theme_font_name\": \"modern\"\n\t\t}\n\t}\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "invoices",
        "invoices"
      ],
      "query": [
        {
          "key": "include%5B%5D",
          "value": "presentation",
          "disabled": true
        }
      ]
    },
    "description": "Define invoice logo and styles by passing in `presentation` object with the fields below:\n\n| Field name | Acceptable values |\n|------------|-------------------|\n| `image_logo_src`| Relative URL of a logo uploaded to FreshBooks - See Upload Logo |\n| `theme_primary_color`| Valid color code |\n| `theme_layout` | \"simple\" or \"modern\" |\n| `theme_font_name` | \"modern\" or \"classic\" |\n\nBy default, if no `presentation` specified in new invoice request payload, it will be assigned a default presentation.\nTo override this default behaviour, specify `\"use_default_presentation\": false`"
  },
  "response": [
    {
      "name": "Single Invoice w/ Logo and styles",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "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\t \"theme_layout\": \"simple\",\n\t\t\t \"theme_font_name\": \"modern\"\n\t\t}\n\t}\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/invoices/invoices",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "invoices",
            "invoices"
          ],
          "query": [
            {
              "key": "include%5B%5D",
              "value": "presentation",
              "disabled": true
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gNX0BcCwUGEQoLVhRXUVdXQEcVUR1RHVBWDw5WXlYOAgRUUFEBBgVKVQMDBk5EWlsJBwkDCwoGAAtQDwcCBBFOAldbEgM+"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557432079"
        },
        {
          "key": "Retry-After",
          "value": "47"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 09 May 2018 20:00:31 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:00:31 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                \"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:00:31\",\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\": 74880,\n                \"invoice_number\": \"0000028\",\n                \"invoiceid\": 74880,\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:00:31\",\n                \"v3_status\": \"draft\",\n                \"vat_name\": \"\",\n                \"vat_number\": \"\",\n                \"vis_state\": 0\n            }\n        }\n    }\n}"
    }
  ]
}