Package net.amcintosh.freshbooks.models

Class Invoice.InvoicePresentation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

net.amcintosh.freshbooks.models.Invoice.InvoicePresentation

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Invoice

public static class Invoice.InvoicePresentation
extends com.google.api.client.json.GenericJson

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
InvoicePresentation()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getContent()
String	getDateFormat()	Override business date format for this invoice.
String	getImageBannerSrc()	The invoice banner image for "modern" invoices.
String	getImageLogoSrc()	The invoice logo image.
String	getThemeFontName()	Which invoice font is in use.
String	getThemeLayout()	Which invoice template is in use.
String	getThemePrimaryColor()	Primary highlight colour for the invoice.
void	setDateFormat(String dateFormat)	Override business date format for this invoice.
void	setImageBannerSrc(String imageBannerSrc)	The invoice banner image for "modern" invoices.
void	setImageLogoSrc(String imageLogoSrc)	The invoice logo image.
void	setThemeFontName(String themeFontName)	Which invoice font to use.
void	setThemeLayout(String themeLayout)	Which invoice template to use.
void	setThemePrimaryColor(String themePrimaryColor)	Primary highlight colour for the invoice.

Methods inherited from class com.google.api.client.json.GenericJson

clone, getFactory, set, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

InvoicePresentation

public InvoicePresentation()

Method Details

getDateFormat

public String getDateFormat()

Override business date format for this invoice.

Returns:

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

setDateFormat

public void setDateFormat(String dateFormat)

Override business date format for this invoice.

Parameters:

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

getImageBannerSrc

public String getImageBannerSrc()

The invoice banner image for "modern" invoices.

Returns:

“/uploads/images/JWT_TOKEN_FROM_IMAGE_UPLOAD”

setImageBannerSrc

public void setImageBannerSrc(String imageBannerSrc)

The invoice banner image for "modern" invoices.

Parameters:

imageBannerSrc - “/uploads/images/JWT_TOKEN_FROM_IMAGE_UPLOAD”

getImageLogoSrc

public String getImageLogoSrc()

The invoice logo image.

Returns:

“/uploads/images/JWT_TOKEN_FROM_IMAGE_UPLOAD”

setImageLogoSrc

public void setImageLogoSrc(String imageLogoSrc)

The invoice logo image.

Parameters:

imageLogoSrc - “/uploads/images/JWT_TOKEN_FROM_IMAGE_UPLOAD”

getThemeFontName

public String getThemeFontName()

Which invoice font is in use.

Returns:

“modern” or “classic”

setThemeFontName

public void setThemeFontName(String themeFontName)

Which invoice font to use.

Parameters:

themeFontName - “modern” or “classic”

getThemeLayout

public String getThemeLayout()

Which invoice template is in use.

Returns:

“simple, “modern”, or “classic”

setThemeLayout

public void setThemeLayout(String themeLayout)

Which invoice template to use.

Parameters:

themeLayout - “simple, “modern”, or “classic”

getThemePrimaryColor

public String getThemePrimaryColor()

Primary highlight colour for the invoice.

Returns:

eg. “#345beb”

setThemePrimaryColor

public void setThemePrimaryColor(String themePrimaryColor)

Primary highlight colour for the invoice.

Parameters:

themePrimaryColor - eg. “#345beb”

getContent

public Map<String,Object> getContent()