diff --git a/docs/html/classes/amcintosh-FreshBooks-Model-Invoice.html b/docs/html/classes/amcintosh-FreshBooks-Model-Invoice.html index 4c8f6ab..6790cd6 100644 --- a/docs/html/classes/amcintosh-FreshBooks-Model-Invoice.html +++ b/docs/html/classes/amcintosh-FreshBooks-Model-Invoice.html @@ -175,7 +175,7 @@

@@ -535,6 +535,13 @@

 : string|null +
+ +
+ $presentation + +  : InvoicePresentation|null +
@@ -654,7 +661,7 @@

@@ -698,7 +705,7 @@

@@ -733,7 +740,7 @@

@@ -767,7 +774,7 @@

@@ -801,7 +808,7 @@

@@ -836,7 +843,7 @@

@@ -870,7 +877,7 @@

@@ -905,7 +912,7 @@

@@ -939,7 +946,7 @@

@@ -974,7 +981,7 @@

@@ -1008,7 +1015,7 @@

@@ -1042,7 +1049,7 @@

@@ -1077,7 +1084,7 @@

@@ -1112,7 +1119,7 @@

@@ -1146,7 +1153,7 @@

@@ -1182,7 +1189,7 @@

@@ -1217,7 +1224,7 @@

@@ -1252,7 +1259,7 @@

@@ -1286,7 +1293,7 @@

@@ -1322,7 +1329,7 @@

@@ -1356,7 +1363,7 @@

@@ -1390,7 +1397,7 @@

@@ -1425,7 +1432,7 @@

@@ -1459,7 +1466,7 @@

@@ -1493,7 +1500,7 @@

@@ -1529,7 +1536,7 @@

@@ -1563,7 +1570,7 @@

@@ -1597,7 +1604,7 @@

@@ -1631,7 +1638,7 @@

@@ -1666,7 +1673,7 @@

@@ -1700,7 +1707,7 @@

@@ -1734,7 +1741,7 @@

@@ -1768,7 +1775,7 @@

@@ -1802,7 +1809,7 @@

@@ -1836,7 +1843,7 @@

@@ -1870,7 +1877,7 @@

@@ -1905,7 +1912,7 @@

@@ -1941,7 +1948,7 @@

@@ -1975,7 +1982,7 @@

@@ -2011,7 +2018,7 @@

@@ -2046,7 +2053,7 @@

@@ -2080,7 +2087,7 @@

@@ -2115,7 +2122,7 @@

@@ -2149,7 +2156,7 @@

@@ -2184,7 +2191,7 @@

@@ -2201,6 +2208,45 @@

+ +
+

+ $presentation + + + +

+ + + + + public + InvoicePresentation|null + $presentation + + + +

Define invoice logo and styles.

+

By default, if no presentation specified in a new invoice request payload, +it will be assigned a default presentation. To override this default behaviour, +set useDefaultPresentation to false.

+

Note: The presentation details are only returned with a invoice call +using a "presentation" include.

+
+ + +
@@ -2252,7 +2298,7 @@

@@ -2286,7 +2332,7 @@

@@ -2320,7 +2366,7 @@

@@ -2402,7 +2448,7 @@

@@ -2436,7 +2482,7 @@

@@ -2470,7 +2516,7 @@

@@ -2504,7 +2550,7 @@

@@ -2538,7 +2584,7 @@

@@ -2575,7 +2621,7 @@

@@ -2660,7 +2706,7 @@

@@ -2694,7 +2740,7 @@

@@ -2728,7 +2774,7 @@

@@ -2767,7 +2813,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-Model-InvoicePresentation.html b/docs/html/classes/amcintosh-FreshBooks-Model-InvoicePresentation.html new file mode 100644 index 0000000..ad7ae6c --- /dev/null +++ b/docs/html/classes/amcintosh-FreshBooks-Model-InvoicePresentation.html @@ -0,0 +1,612 @@ + + + + + freshbooks-php-sdk + + + + + + + + + + + + + + + + + + + + +
+

freshbooks-php-sdk

+ + + + + +
+ +
+
+ + + + +
+ + +
+

+ InvoicePresentation + + + extends DataTransferObject + + +
+ in package + +
+ + +

+ + + +

Invoice Presentations are used to style an invoice including font, colors, and logos.

+ +

By default, when a new invoice is created, it automatically uses the presentation style +of the most recently created invoice (including logos, colors, and fonts). If you wish +to change the style of an invoice via the API, or if the user has not styled their +invoices (such as in a brand new account), then you can pass a presentation +object as part of the invoice call. Subsequent invoices will use this style until an +invoice is created with a new style. If you do not wish for an invoice to use any styles, +you can include use_default_presentation: false in the invoice call.

+
+ + +
+ Tags + +
+
+
+ link +
+
+ https://www.freshbooks.com/api/invoice_presentation_attachments + +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ $dateFormat + +  : string|null +
+
+ +
+ $imageBannerSrc + +  : string|null +
+
+ +
+ $imageLogoSrc + +  : string|null +
+
+ +
+ $invoiceId + +  : int|null +
+
+ +
+ $themeFontName + +  : string|null +
+
+ +
+ $themeLayout + +  : string|null +
+
+ +
+ $themePrimaryColor + +  : string|null +
+
+ +
+ + + + + + +
+

+ Properties + +

+
+

+ $dateFormat + + + +

+ + + + + public + string|null + $dateFormat + + + +

Override business date format for this invoice.

+

string format of: “mm/dd/yyyy”, “dd/mm/yyyy”, or “yyyy-mm-dd”

+
+ + + +
+
+

+ $imageBannerSrc + + + +

+ + + + + public + string|null + $imageBannerSrc + + + +

The invoice banner image for "modern" invoices.

+

“/uploads/images/<JWT_TOKEN_FROM_IMAGE_UPLOAD>”

+
+ + + +
+
+

+ $imageLogoSrc + + + +

+ + + + + public + string|null + $imageLogoSrc + + + +

The invoice logo image.

+

“/uploads/images/<JWT_TOKEN_FROM_IMAGE_UPLOAD>”

+
+ + + +
+
+

+ $invoiceId + + + +

+ + + + + public + int|null + $invoiceId + + + +

The unique identifier of the invoice this presentation applies to.

+
+ + + +
+
+

+ $themeFontName + + + +

+ + + + + public + string|null + $themeFontName + + + +

Which invoice font is in use.

+

“modern” or “classic”

+
+ + + +
+
+

+ $themeLayout + + + +

+ + + + + public + string|null + $themeLayout + + + +

Which invoice template is in use.

+

“simple, “modern”, or “classic”

+
+ + + +
+
+

+ $themePrimaryColor + + + +

+ + + + + public + string|null + $themePrimaryColor + + + +

Primary highlight colour for the invoice.

+

eg. “#345beb”

+
+ + + +
+
+ + + + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/html/files/src-model-invoicepresentation.html b/docs/html/files/src-model-invoicepresentation.html new file mode 100644 index 0000000..46d49ca --- /dev/null +++ b/docs/html/files/src-model-invoicepresentation.html @@ -0,0 +1,206 @@ + + + + + freshbooks-php-sdk + + + + + + + + + + + + + + + + + + + + +
    +

    freshbooks-php-sdk

    + + + + + +
    + +
    +
    + + + + +
    +
      +
    + +
    +

    InvoicePresentation.php

    + + +
    + + + + + + +

    + Interfaces, Classes, Traits and Enums + +

    + +
    + +
    InvoicePresentation
    +
    Invoice Presentations are used to style an invoice including font, colors, and logos.
    + + +
    + + + + + + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/docs/html/indices/files.html b/docs/html/indices/files.html index 9417598..88b8c5f 100644 --- a/docs/html/indices/files.html +++ b/docs/html/indices/files.html @@ -193,6 +193,7 @@

      I

    • IncludesBuilder.php
    • Invoice.php
    • InvoiceList.php
    • +
    • InvoicePresentation.php
    • InvoiceStatus.php
    • Item.php
    • ItemList.php
    • diff --git a/docs/html/js/searchIndex.js b/docs/html/js/searchIndex.js index bb84dac..d7b8540 100644 --- a/docs/html/js/searchIndex.js +++ b/docs/html/js/searchIndex.js @@ -1360,6 +1360,11 @@ Search.appendIndex( "name": "PONumber", "summary": "", "url": "classes/amcintosh-FreshBooks-Model-Invoice.html#property_PONumber" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\Invoice\u003A\u003A\u0024presentation", + "name": "presentation", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-Invoice.html#property_presentation" }, { "fqsen": "\\amcintosh\\FreshBooks\\Model\\Invoice\u003A\u003A\u0024province", "name": "province", @@ -1460,6 +1465,46 @@ Search.appendIndex( "name": "invoices", "summary": "", "url": "classes/amcintosh-FreshBooks-Model-InvoiceList.html#property_invoices" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation", + "name": "InvoicePresentation", + "summary": "Invoice\u0020Presentations\u0020are\u0020used\u0020to\u0020style\u0020an\u0020invoice\u0020including\u0020font,\u0020colors,\u0020and\u0020logos.", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024invoiceId", + "name": "invoiceId", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_invoiceId" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024dateFormat", + "name": "dateFormat", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_dateFormat" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024imageBannerSrc", + "name": "imageBannerSrc", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_imageBannerSrc" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024imageLogoSrc", + "name": "imageLogoSrc", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_imageLogoSrc" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themeFontName", + "name": "themeFontName", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themeFontName" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themeLayout", + "name": "themeLayout", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themeLayout" + }, { + "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoicePresentation\u003A\u003A\u0024themePrimaryColor", + "name": "themePrimaryColor", + "summary": "", + "url": "classes/amcintosh-FreshBooks-Model-InvoicePresentation.html#property_themePrimaryColor" }, { "fqsen": "\\amcintosh\\FreshBooks\\Model\\InvoiceStatus", "name": "InvoiceStatus", diff --git a/docs/html/namespaces/amcintosh-freshbooks-model.html b/docs/html/namespaces/amcintosh-freshbooks-model.html index 7c3a133..21a0262 100644 --- a/docs/html/namespaces/amcintosh-freshbooks-model.html +++ b/docs/html/namespaces/amcintosh-freshbooks-model.html @@ -203,6 +203,8 @@

      that Client owes to the Admin.
      InvoiceList
      Results of invoices list call containing list of invoices and pagination data.
      +
      InvoicePresentation
      +
      Invoice Presentations are used to style an invoice including font, colors, and logos.
      InvoiceStatus
      Status values for an invoice.
      Item
      diff --git a/docs/html/packages/amcintosh-FreshBooks-Model.html b/docs/html/packages/amcintosh-FreshBooks-Model.html index b18b6f8..2fa1a0d 100644 --- a/docs/html/packages/amcintosh-FreshBooks-Model.html +++ b/docs/html/packages/amcintosh-FreshBooks-Model.html @@ -193,6 +193,8 @@

      that Client owes to the Admin.
      InvoiceList
      Results of invoices list call containing list of invoices and pagination data.
      +
      InvoicePresentation
      +
      Invoice Presentations are used to style an invoice including font, colors, and logos.
      InvoiceStatus
      Status values for an invoice.
      Item
      diff --git a/docs/html/reports/markers.html b/docs/html/reports/markers.html index 5dcab07..30a7f28 100644 --- a/docs/html/reports/markers.html +++ b/docs/html/reports/markers.html @@ -151,32 +151,10 @@

      Fil