docs.jsonld
type: ApiDocumentation
title: Kroonz Rest API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: DashboardApiResource
supported class: OAuthApiResource
supported class: BankMetaData
supported class: Budget
supported class: CategorizationRule
supported class: Category
supported class: Connector
supported class: Group
supported class: GroupMember
supported class: positions
supported class: Transaction
supported class: TransactionCategory
supported class: User
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
sub class of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
sub class of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

DashboardApiResource
type: Class
title: DashboardApiResource
supported property: SupportedProperty
  property: DashboardApiResource/total inbound
  title: total_inbound
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: DashboardApiResource/total outbound
  title: total_outbound
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: DashboardApiResource/net total
  title: net_total
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: DashboardApiResource/transactions
  title: transactions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: DashboardApiResource/current position value
  title: current_position_value
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a DashboardApiResource resource.
  method: GET
  returns: owl:Nothing
  title: getDashboardApiResource

DashboardApiResource/total inbound
type: Property
domain: DashboardApiResource
the hydra core vocabulary: total_inbound
range: integer

DashboardApiResource/total outbound
type: Property
domain: DashboardApiResource
the hydra core vocabulary: total_outbound
range: integer

DashboardApiResource/net total
type: Property
domain: DashboardApiResource
the hydra core vocabulary: net_total
range: string

DashboardApiResource/transactions
type: Property
domain: DashboardApiResource
the hydra core vocabulary: transactions
range: Transaction

DashboardApiResource/current position value
type: Property
domain: DashboardApiResource
the hydra core vocabulary: current_position_value
range: integer

OAuthApiResource
type: Class
title: OAuthApiResource
supported operation: Operation
  type: FindAction
  description: Retrieves a OAuthApiResource resource.
  method: GET
  returns: owl:Nothing
  title: getOAuthApiResource

BankMetaData
type: Class
title: BankMetaData
supported property: SupportedProperty
  property: BankMetaData/bank enum
  title: bank_enum
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BankMetaData/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BankMetaData/logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BankMetaData/bankEnum
  title: bankEnum
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a BankMetaData resource.
  method: GET
  returns: BankMetaData
  title: getBankMetaData

BankMetaData/bank enum
type: Property
domain: BankMetaData
the hydra core vocabulary: bank_enum

BankMetaData/name
type: Property
domain: BankMetaData
the hydra core vocabulary: name
range: string

BankMetaData/logo
type: Property
domain: BankMetaData
the hydra core vocabulary: logo
range: string

BankMetaData/bankEnum
type: Property
domain: BankMetaData
the hydra core vocabulary: bankEnum

Budget
type: Class
title: Budget
supported property: SupportedProperty
  property: Budget/amount
  title: amount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/period
  title: period
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/category
  title: category
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/begin at
  title: begin_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/end at
  title: end_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Budget/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Budget/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  description: Updates the Budget resource.
  expects: Budget
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Budget
  title: patchBudget
supported operation: Operation
  type: FindAction
  description: Retrieves a Budget resource.
  method: GET
  returns: Budget
  title: getBudget

Budget/amount
type: Property
domain: Budget
the hydra core vocabulary: amount
range: integer

Budget/period
type: Property
domain: Budget
the hydra core vocabulary: period

Budget/category
type: Link
domain: Budget
the hydra core vocabulary: category
max cardinality: 1
range: Category

Budget/begin at
type: Property
domain: Budget
the hydra core vocabulary: begin_at
range: dateTime

Budget/end at
type: Property
domain: Budget
the hydra core vocabulary: end_at
range: dateTime

Budget/name
type: Property
domain: Budget
the hydra core vocabulary: name
range: string

Budget/created at
type: Property
domain: Budget
the hydra core vocabulary: created_at
range: dateTime

Budget/updated at
type: Property
domain: Budget
the hydra core vocabulary: updated_at
range: dateTime

CategorizationRule
type: Class
title: CategorizationRule
supported property: SupportedProperty
  property: CategorizationRule/category
  title: category
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CategorizationRule/pattern
  title: pattern
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CategorizationRule/matchType
  title: matchType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CategorizationRule/is active
  title: is_active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: CategorizationRule/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: CategorizationRule/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a CategorizationRule resource.
  method: GET
  returns: owl:Nothing
  title: getCategorizationRule
supported operation: Operation
  type: DeleteAction
  description: Deletes the CategorizationRule resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCategorizationRule

CategorizationRule/category
type: Link
domain: CategorizationRule
the hydra core vocabulary: category
max cardinality: 1
range: Category

CategorizationRule/pattern
type: Property
domain: CategorizationRule
the hydra core vocabulary: pattern
range: string

CategorizationRule/matchType
type: Property
domain: CategorizationRule
the hydra core vocabulary: matchType

CategorizationRule/is active
type: Property
domain: CategorizationRule
the hydra core vocabulary: is_active
range: boolean

CategorizationRule/created at
type: Property
domain: CategorizationRule
the hydra core vocabulary: created_at
range: dateTime

CategorizationRule/updated at
type: Property
domain: CategorizationRule
the hydra core vocabulary: updated_at
range: dateTime

Category
type: Class
title: Category
supported property: SupportedProperty
  property: Category/group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/color
  title: color
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Category/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Category resource.
  method: GET
  returns: Category
  title: getCategory
supported operation: Operation
  type: DeleteAction
  description: Deletes the Category resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteCategory
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Category resource.
  expects: owl:Nothing
  method: PUT
  returns: Category
  title: putCategory

Category/group
type: Link
domain: Category
the hydra core vocabulary: group
max cardinality: 1
range: Group

Category/description
type: Property
domain: Category
the hydra core vocabulary: description
range: string

Category/type
type: Property
domain: Category
the hydra core vocabulary: type

Category/color
type: Property
domain: Category
the hydra core vocabulary: color
range: string

Category/name
type: Property
domain: Category
the hydra core vocabulary: name
range: string

Category/created at
type: Property
domain: Category
the hydra core vocabulary: created_at
range: dateTime

Category/updated at
type: Property
domain: Category
the hydra core vocabulary: updated_at
range: dateTime

Connector
type: Class
title: Connector
supported property: SupportedProperty
  property: Connector/account id
  title: account_id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/last sync at
  title: last_sync_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/created at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/updated at
  title: updated_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/created by
  title: created_by
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/account id
  title: account_id
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/last sync at
  title: last_sync_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/requisition id
  title: requisition_id
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/owner name
  title: owner_name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/bank meta data
  title: bank_meta_data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/iban
  title: iban
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/created at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Connector/updated at
  title: updated_at
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Connector resource.
  method: GET
  returns: Connector
  title: getConnector
supported operation: Operation
  type: DeleteAction
  description: Deletes the Connector resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteConnector
supported property: SupportedProperty
  property: Connector/requisition id
  title: requisition_id
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/owner name
  title: owner_name
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/bank meta data
  title: bank_meta_data
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/iban
  title: iban
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/account id
  title: account_id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/last sync at
  title: last_sync_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Connector/created by
  title: created_by
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Connector resource.
  method: GET
  returns: owl:Nothing
  title: getConnector
supported operation: Operation
  type: FindAction
  description: Retrieves a Connector resource.
  method: GET
  returns: owl:Nothing
  title: getConnector

Connector/account id
type: Property
domain: Connector
the hydra core vocabulary: account_id
range: string

Connector/last sync at
type: Property
domain: Connector
the hydra core vocabulary: last_sync_at
range: dateTime

Connector/created at
type: Property
domain: Connector
the hydra core vocabulary: created_at
range: dateTime

Connector/updated at
type: Property
domain: Connector
the hydra core vocabulary: updated_at
range: dateTime

Connector/created by
type: Link
domain: Connector
the hydra core vocabulary: created_by
max cardinality: 1
range: User

Connector/requisition id
type: Property
domain: Connector
the hydra core vocabulary: requisition_id
range: string

Connector/owner name
type: Property
domain: Connector
the hydra core vocabulary: owner_name
range: string

Connector/bank meta data
type: Property
domain: Connector
the hydra core vocabulary: bank_meta_data
max cardinality: 1
range: BankMetaData

Connector/iban
type: Property
domain: Connector
the hydra core vocabulary: iban
range: string

Connector/id
type: Property
domain: Connector
the hydra core vocabulary: id
range: integer

Connector/type
type: Property
domain: Connector
the hydra core vocabulary: type
range: string

Group
type: Class
title: Group
supported property: SupportedProperty
  property: Group/subscription
  title: subscription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Group/name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Group/created by
  title: created_by
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Group/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Group/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Group resource.
  method: GET
  returns: Group
  title: getGroup
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Group resource.
  expects: owl:Nothing
  method: PUT
  returns: Group
  title: putGroup
supported operation: Operation
  type: DeleteAction
  description: Deletes the Group resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteGroup

Group/subscription
type: Property
domain: Group
the hydra core vocabulary: subscription

Group/name
type: Property
domain: Group
the hydra core vocabulary: name
range: string

Group/created by
type: Link
domain: Group
the hydra core vocabulary: created_by
max cardinality: 1
range: User

Group/created at
type: Property
domain: Group
the hydra core vocabulary: created_at
range: dateTime

Group/updated at
type: Property
domain: Group
the hydra core vocabulary: updated_at
range: dateTime

GroupMember
type: Class
title: GroupMember
supported property: SupportedProperty
  property: GroupMember/group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GroupMember/user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GroupMember/role
  title: role
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: GroupMember/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: GroupMember/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a GroupMember resource.
  method: GET
  returns: owl:Nothing
  title: getGroupMember

GroupMember/group
type: Link
domain: GroupMember
the hydra core vocabulary: group
max cardinality: 1
range: Group

GroupMember/user
type: Link
domain: GroupMember
the hydra core vocabulary: user
max cardinality: 1
range: User

GroupMember/role
type: Property
domain: GroupMember
the hydra core vocabulary: role

GroupMember/created at
type: Property
domain: GroupMember
the hydra core vocabulary: created_at
range: dateTime

GroupMember/updated at
type: Property
domain: GroupMember
the hydra core vocabulary: updated_at
range: dateTime

positions
type: Class
title: positions
supported property: SupportedProperty
  property: positions/connector
  title: connector
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/ticker
  title: ticker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/position currency
  title: position_currency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/current price
  title: current_price
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/average price paid
  title: average_price_paid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/wallet currency
  title: wallet_currency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/total cost
  title: total_cost
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/current value
  title: current_value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/unrealized profit loss
  title: unrealized_profit_loss
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/created at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: positions/name
  title: name
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a positions resource.
  method: GET
  returns: owl:Nothing
  title: getpositions
supported operation: Operation
  type: ReplaceAction
  description: Replaces the positions resource.
  expects: owl:Nothing
  method: PUT
  returns: positions
  title: putpositions

positions/connector
type: Link
domain: positions
the hydra core vocabulary: connector
max cardinality: 1
range: Connector

positions/ticker
type: Property
domain: positions
the hydra core vocabulary: ticker
range: string

positions/position currency
type: Property
domain: positions
the hydra core vocabulary: position_currency
range: string

positions/quantity
type: Property
domain: positions
the hydra core vocabulary: quantity
range: decimal

positions/current price
type: Property
domain: positions
the hydra core vocabulary: current_price
range: decimal

positions/average price paid
type: Property
domain: positions
the hydra core vocabulary: average_price_paid
range: decimal

positions/wallet currency
type: Property
domain: positions
the hydra core vocabulary: wallet_currency
range: string

positions/total cost
type: Property
domain: positions
the hydra core vocabulary: total_cost
range: decimal

positions/current value
type: Property
domain: positions
the hydra core vocabulary: current_value
range: decimal

positions/unrealized profit loss
type: Property
domain: positions
the hydra core vocabulary: unrealized_profit_loss
range: decimal

positions/created at
type: Property
domain: positions
the hydra core vocabulary: created_at
range: dateTime

positions/name
type: Property
domain: positions
the hydra core vocabulary: name
range: string

Transaction
type: Class
title: Transaction
supported property: SupportedProperty
  property: Transaction/connector
  title: connector
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/direction
  title: direction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/status
  title: status
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/date time
  title: date_time
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/created at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Transaction/updated at
  title: updated_at
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Transaction resource.
  method: GET
  returns: Transaction
  title: getTransaction
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Transaction resource.
  expects: owl:Nothing
  method: PUT
  returns: Transaction
  title: putTransaction

Transaction/connector
type: Link
domain: Transaction
the hydra core vocabulary: connector
max cardinality: 1
range: Connector

Transaction/name
type: Property
domain: Transaction
the hydra core vocabulary: name
range: string

Transaction/description
type: Property
domain: Transaction
the hydra core vocabulary: description
range: string

Transaction/currency
type: Property
domain: Transaction
the hydra core vocabulary: currency
range: string

Transaction/amount
type: Property
domain: Transaction
the hydra core vocabulary: amount
range: integer

Transaction/direction
type: Property
domain: Transaction
the hydra core vocabulary: direction

Transaction/status
type: Property
domain: Transaction
the hydra core vocabulary: status

Transaction/date time
type: Property
domain: Transaction
the hydra core vocabulary: date_time
range: dateTime

Transaction/created at
type: Property
domain: Transaction
the hydra core vocabulary: created_at
range: dateTime

Transaction/updated at
type: Property
domain: Transaction
the hydra core vocabulary: updated_at
range: dateTime

TransactionCategory
type: Class
title: TransactionCategory
supported property: SupportedProperty
  property: TransactionCategory/transaction
  title: transaction
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransactionCategory/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TransactionCategory/is auto categorized
  title: is_auto_categorized
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a TransactionCategory resource.
  method: GET
  returns: owl:Nothing
  title: getTransactionCategory
supported operation: Operation
  type: ReplaceAction
  description: Replaces the TransactionCategory resource.
  expects: owl:Nothing
  method: PUT
  returns: TransactionCategory
  title: putTransactionCategory

TransactionCategory/transaction
type: Property
domain: TransactionCategory
the hydra core vocabulary: transaction
max cardinality: 1
range: Transaction

TransactionCategory/category
type: Property
domain: TransactionCategory
the hydra core vocabulary: category
max cardinality: 1
range: Category

TransactionCategory/is auto categorized
type: Property
domain: TransactionCategory
the hydra core vocabulary: is_auto_categorized
range: boolean

User
type: Class
title: User
supported property: SupportedProperty
  property: User/email
  title: email
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/roles
  title: roles
  required: false
  readable: true
  writeable: false
  description: The user roles
supported property: SupportedProperty
  property: User/first name
  title: first_name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/full name
  title: full_name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/avatar url
  title: avatar_url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/created at
  title: created_at
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: User/updated at
  title: updated_at
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
supported operation: Operation
  type: FindAction
  description: Retrieves a User resource.
  method: GET
  returns: User
  title: getUser
supported operation: Operation
  type: DeleteAction
  description: Deletes the User resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteUser

User/email
type: Property
domain: User
the hydra core vocabulary: email
range: string

User/roles
type: Property
domain: User
the hydra core vocabulary: roles
range: string

User/first name
type: Property
domain: User
the hydra core vocabulary: first_name
range: string

User/full name
type: Property
domain: User
the hydra core vocabulary: full_name
range: string

User/avatar url
type: Property
domain: User
the hydra core vocabulary: avatar_url
range: string

User/created at
type: Property
domain: User
the hydra core vocabulary: created_at
range: dateTime

User/updated at
type: Property
domain: User
the hydra core vocabulary: updated_at
range: dateTime

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/dashboardApiResource
  title: getDashboardApiResourceCollection
  description: The collection of DashboardApiResource resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/oAuthApiResource
  title: getOAuthApiResourceCollection
  description: The collection of OAuthApiResource resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/bankMetaData
  title: getBankMetaDataCollection
  description: The collection of BankMetaData resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/budget
  title: getBudgetCollection
  description: The collection of Budget resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/categorizationRule
  title: getCategorizationRuleCollection
  description: The collection of CategorizationRule resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/category
  title: getCategoryCollection
  description: The collection of Category resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/connector
  title: getConnectorCollection
  description: The collection of Connector resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/connector
  title: getConnectorCollection
  description: The collection of Connector resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/group
  title: getGroupCollection
  description: The collection of Group resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/groupMember
  title: getGroupMemberCollection
  description: The collection of GroupMember resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/positions
  title: getpositionsCollection
  description: The collection of positions resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/connector
  title: getConnectorCollection
  description: The collection of Connector resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/transaction
  title: getTransactionCollection
  description: The collection of Transaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/transactionCategory
  title: getTransactionCategoryCollection
  description: The collection of TransactionCategory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/user
  title: getUserCollection
  description: The collection of User resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/dashboardApiResource
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DashboardApiResource
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of DashboardApiResource resources.
  method: GET
  returns: Collection
  title: getDashboardApiResourceCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of DashboardApiResource resources.
  method: GET
  returns: Collection
  title: getDashboardApiResourceCollection

Entrypoint/oAuthApiResource
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OAuthApiResource
supported operation: Operation
  type: CreateAction
  description: Creates a OAuthApiResource resource.
  expects: OAuthApiResource
  method: POST
  returns: OAuthApiResource
  title: postOAuthApiResource

Entrypoint/bankMetaData
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BankMetaData
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of BankMetaData resources.
  method: GET
  returns: Collection
  title: getBankMetaDataCollection

Entrypoint/budget
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Budget
supported operation: Operation
  type: CreateAction
  description: Creates a Budget resource.
  expects: Budget
  method: POST
  returns: Budget
  title: postBudget
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Budget resources.
  method: GET
  returns: Collection
  title: getBudgetCollection

Entrypoint/categorizationRule
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CategorizationRule
supported operation: Operation
  type: CreateAction
  description: Creates a CategorizationRule resource.
  expects: CategorizationRule
  method: POST
  returns: CategorizationRule
  title: postCategorizationRule
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of CategorizationRule resources.
  method: GET
  returns: Collection
  title: getCategorizationRuleCollection

Entrypoint/category
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Category
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Category resources.
  method: GET
  returns: Collection
  title: getCategoryCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Category resource.
  expects: Category
  method: POST
  returns: Category
  title: postCategory

Entrypoint/connector
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Connector
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Connector resources.
  method: GET
  returns: Collection
  title: getConnectorCollection
range:
  equivalent class:
    on property: member
    all values from: Connector
supported operation: Operation
  type: CreateAction
  description: Creates a Connector resource.
  expects: Connector
  method: POST
  returns: Connector
  title: postConnector
supported operation: Operation
  type: CreateAction
  description: Creates a Connector resource.
  expects: Connector
  method: POST
  returns: Connector
  title: postConnector
range:
  equivalent class:
    on property: member
    all values from: Connector
supported operation: Operation
  type: CreateAction
  description: Creates a Connector resource.
  expects: Connector
  method: POST
  returns: Connector
  title: postConnector

Entrypoint/group
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Group
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Group resources.
  method: GET
  returns: Collection
  title: getGroupCollection

Entrypoint/groupMember
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GroupMember
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of GroupMember resources.
  method: GET
  returns: Collection
  title: getGroupMemberCollection

Entrypoint/positions
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: positions
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of positions resources.
  method: GET
  returns: Collection
  title: getpositionsCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of positions resources.
  method: GET
  returns: Collection
  title: getpositionsCollection

Entrypoint/transaction
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Transaction
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Transaction resources.
  method: GET
  returns: Collection
  title: getTransactionCollection
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Transaction resources.
  method: GET
  returns: Collection
  title: getTransactionCollection

Entrypoint/transactionCategory
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TransactionCategory
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of TransactionCategory resources.
  method: GET
  returns: Collection
  title: getTransactionCategoryCollection
supported operation: Operation
  type: CreateAction
  description: Creates a TransactionCategory resource.
  expects: TransactionCategory
  method: POST
  returns: TransactionCategory
  title: postTransactionCategory

Entrypoint/user
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of User resources.
  method: GET
  returns: Collection
  title: getUserCollection

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: ConstraintViolationList/propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolationList/message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

ConstraintViolationList/propertyPath
type: Property
label: propertyPath
domain: ConstraintViolationList
range: string

ConstraintViolationList/message
type: Property
label: message
domain: ConstraintViolationList
range: string