Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StoreTransactionFolder

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:folder"

links

links: { fx:store: Backend.Rels.Store; self: StoreTransactionFolder }

Type declaration

props

props: { color: null | string; date_created: string; date_modified: string; is_default: 0 | 1; name: string; sort_order: number }

Type declaration

  • color: null | string

    Optional display color for this folder. API will accept any value, however our admin dashboard will recognize only the following: red, red_pale, green, green_pale, blue, blue_pale, orange, orange_pale, violet, violet_pale. Default: null.

  • date_created: string

    The date and time this folder was created in ISO 8601 format.

  • date_modified: string

    The date and time this folder was last modified in ISO 8601 format.

  • is_default: 0 | 1

    When set to 1, new transactions will be automatically assigned to this folder. Only one folder can be default at a time. If you update one folder to be the default one we will mark others as non default. Optional. Default: 0.

  • name: string

    Name of the folder. Required.

  • sort_order: number

    Optional display order for this folder. Our admin dashboard will sort folders by this value (ascending). Default: 0.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc