# Objects / Customer Displays

# Customer Displays

**Object**
## CustomerDisplayColumn

| Fields | Type | Description |
| --- | --- | --- |
| enabled | *Boolean* | Whether the columns should be displayed |
| name | *String* | The name of the column |



**Object**
## CustomerDisplayComponentPosition

| Fields | Type | Description |
| --- | --- | --- |
| top | *Int* | The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| left | *Int* | The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| width | *Int* | The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |
| height | *Int* | The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. |



**Object**
## CustomerDisplayComponent

| Fields | Type | Description |
| --- | --- | --- |
| type | *String* | The type of the component |
| position | [CustomerDisplayComponentPosition](/documentation/Objects/Customer-Displays#CustomerDisplayComponentPosition) | The position of the component on the grid |
| settings | [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface) | The settings of the component |



**Object**
## CustomerDisplayImageSettings

### Implements
*List of interfaces this object implements*

- [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface)

| Fields | Type | Description |
| --- | --- | --- |
| background | *String* | The background color of the component |
| color | *String* | The foreground color of the component |
| image | *String* | The URL of the image to display |
| constrainWidth | *Boolean* | Whether the image should be constrained to the left and right of the component |
| constrainHeight | *Boolean* | Whether the image should be constrained to the top and bottom of the component |
| fill | *Boolean* | Whether the image should fill the entire component |



**Object**
## CustomerDisplaySaleColumn

| Fields | Type | Description |
| --- | --- | --- |
| enabled | *Boolean* | Whether the columns should be displayed |
| name | *String* | The name of the column |
| alignment | *String* | The text alignment of the column |



**Object**
## CustomerDisplaySaleColumnsSettings

| Fields | Type | Description |
| --- | --- | --- |
| item | [CustomerDisplaySaleColumn](/documentation/Objects/Customer-Displays#CustomerDisplaySaleColumn) |  |
| quantity | [CustomerDisplaySaleColumn](/documentation/Objects/Customer-Displays#CustomerDisplaySaleColumn) |  |
| price | [CustomerDisplaySaleColumn](/documentation/Objects/Customer-Displays#CustomerDisplaySaleColumn) |  |
| totalPrice | [CustomerDisplaySaleColumn](/documentation/Objects/Customer-Displays#CustomerDisplaySaleColumn) |  |



**Object**
## CustomerDisplaySaleSettings

### Implements
*List of interfaces this object implements*

- [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface)

| Fields | Type | Description |
| --- | --- | --- |
| background | *String* | The background color of the component |
| color | *String* | The foreground color of the component |
| gridLines | *Boolean* | Whether the grid lines for the table is shown |
| gridColor | *String* | The color of the grid lines |
| order | *[String]* | The order the columns are shown |
| columns | [CustomerDisplaySaleColumnsSettings](/documentation/Objects/Customer-Displays#CustomerDisplaySaleColumnsSettings) | The settings for the columns |
| promotionColor | *String* | The color of the promotion lines |
| footerBackground | *String* | The background color of the footer |
| footerColor | *String* | The foreground color of the footer |
| fontSize | *Int* | The font size of the totals table |



**Object**
## CustomerDisplaySlideshowSettingsSlide

| Fields | Type | Description |
| --- | --- | --- |
| type | [CustomerDisplaySlideshowSlideTypeEnum](/documentation/Enums/Customer-Display-Slideshow-Slide-Type-Enum#CustomerDisplaySlideshowSlideTypeEnum) | The type of the media for the slide |
| url | *String* | The URL of the media for the slide |
| name | *String* | The name of the media for the slide |
| duration | *Float* | The duration of the slide |
| startDate | [DateTime](/documentation/Types/Date-Time#DateTime) | The timestamp of when this slide should start being shown in the slideshow. |
| endDate | [DateTime](/documentation/Types/Date-Time#DateTime) | The timestamp of when this slide should be removed from the slideshow. |



**Object**
## CustomerDisplaySlideshowSettings

### Implements
*List of interfaces this object implements*

- [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface)

| Fields | Type | Description |
| --- | --- | --- |
| background | *String* | The background color of the component |
| color | *String* | The foreground color of the component |
| fill | *Boolean* | Whether the slides are stretched to fill the entire component |
| cover | *Boolean* | Whether the slides cover the entire component without losing their aspect ratio |
| slides | [[CustomerDisplaySlideshowSettingsSlide]](/documentation/Objects/Customer-Displays#CustomerDisplaySlideshowSettingsSlide) | The slides of the slideshow |



**Object**
## CustomerDisplayTextSettings

### Implements
*List of interfaces this object implements*

- [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface)

| Fields | Type | Description |
| --- | --- | --- |
| background | *String* | The background color of the component |
| color | *String* | The foreground color of the component |
| text | *String* | The text that would display for the component |
| align | *String* | The horizontal alignment of the text component |
| justify | *String* | The vertical alignment of the text component |
| fontSize | *Int* | The font size of the text |
| bold | *Boolean* | Whether the text should be bold or not |
| italic | *Boolean* | Whether the text should be italic or not |
| underline | *Boolean* | Whether the text should be underlined or not |



**Object**
## CustomerDisplayTotalsColumnsSettings

| Fields | Type | Description |
| --- | --- | --- |
| total | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| savings | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| change | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| approved | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| thanks | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| paid | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |
| remaining | [CustomerDisplayColumn](/documentation/Objects/Customer-Displays#CustomerDisplayColumn) |  |



**Object**
## CustomerDisplayTotalsSettings

### Implements
*List of interfaces this object implements*

- [CustomerDisplayComponentSettingsInterface](/documentation/Interfaces/Customer-Display-Component-Settings-Interface#CustomerDisplayComponentSettingsInterface)

| Fields | Type | Description |
| --- | --- | --- |
| background | *String* | The background color of the component |
| color | *String* | The foreground color of the component |
| order | *[String]* | The order the columns are shown |
| rows | [CustomerDisplayTotalsColumnsSettings](/documentation/Objects/Customer-Displays#CustomerDisplayTotalsColumnsSettings) | The settings for the columns |
| promotion | *String* | The color of the promotion lines |
| fontSize | *Int* | The font size of the totals table |
| bold | *Boolean* | Whether the text should be bold or not |
| italic | *Boolean* | Whether the text should be italic or not |
| underline | *Boolean* | Whether the text should be underlined or not |



**Object**
## CustomerDisplay

| Fields | Type | Description |
| --- | --- | --- |
| id | [ID!](/documentation/Types/UUID#UUID) | The unique ID of the customer display |
| name | *String!* | The name of the customer display |
| idle | [[CustomerDisplayComponent]](/documentation/Objects/Customer-Displays#CustomerDisplayComponent) | The components to use when the customer display is on idle (no sale in progress) |
| sale | [[CustomerDisplayComponent]](/documentation/Objects/Customer-Displays#CustomerDisplayComponent) | The components to use on the customer display when there is a sale in progress |
| mainColour | *String* | The default main colour to use for components |
| textColour | *String* | The default text colour to use for components |