docs.jsonld
type: ApiDocumentation
title: e-Tax API Payment
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Account
supported class: History
supported class: Clearance
supported class: Statement
supported class: Currency
supported class: Exchange
supported class: Payout
supported class: Timetable
supported class: Category
supported class: Overlay
supported class: Penalty
supported class: Wording
supported class: Claim
supported class: Echelon
supported class: Payment
supported class: Inquire
supported class: Payoff
supported class: Pricing
supported class: Slice
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

Account
type: Class
title: Account
supported property: SupportedProperty
  property: Account/prepaidBalance
  title: prepaidBalance
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/rfBalance
  title: rfBalance
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/rnfBalance
  title: rnfBalance
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Account/histories
  title: histories
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Account resource.
  method: GET
  returns: Account
  title: getAccount

Account/prepaidBalance
type: Property
domain: Account
the hydra core vocabulary: prepaidBalance
range: string

Account/rfBalance
type: Property
domain: Account
the hydra core vocabulary: rfBalance
range: string

Account/rnfBalance
type: Property
domain: Account
the hydra core vocabulary: rnfBalance
range: string

Account/createdAt
type: Property
domain: Account
the hydra core vocabulary: createdAt
range: dateTime

Account/realm
type: Property
domain: Account
the hydra core vocabulary: realm
range: string

Account/payer
type: Property
domain: Account
the hydra core vocabulary: payer
range: string

Account/histories
type: Link
domain: Account
the hydra core vocabulary: histories
range: History

History
type: Class
title: History
supported property: SupportedProperty
  property: History/debit
  title: debit
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/credit
  title: credit
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/sold
  title: sold
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/exchange
  title: exchange
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/nature
  title: nature
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/typeOperation
  title: typeOperation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/operation
  title: operation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/documentUri
  title: documentUri
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/documentFile
  title: documentFile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/fiscalYear
  title: fiscalYear
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/account
  title: account
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/echelon
  title: echelon
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: History/paymentDetails
  title: paymentDetails
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: History/convertedAmounts
  title: convertedAmounts
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a History resource.
  method: GET
  returns: History
  title: getHistory

History/debit
type: Property
domain: History
the hydra core vocabulary: debit
range: string

History/credit
type: Property
domain: History
the hydra core vocabulary: credit
range: string

History/sold
type: Property
domain: History
the hydra core vocabulary: sold
range: string

History/exchange
type: Property
domain: History
the hydra core vocabulary: exchange
range: string

History/nature
type: Property
domain: History
the hydra core vocabulary: nature
range: string

History/typeOperation
type: Property
domain: History
the hydra core vocabulary: typeOperation
range: string

History/operation
type: Property
domain: History
the hydra core vocabulary: operation
range: string

History/document
type: Property
domain: History
the hydra core vocabulary: document
range: string

History/documentUri
type: Property
domain: History
the hydra core vocabulary: documentUri
range: string

History/documentFile
type: Property
domain: History
the hydra core vocabulary: documentFile

History/fiscalYear
type: Property
domain: History
the hydra core vocabulary: fiscalYear
range: string

History/realm
type: Property
domain: History
the hydra core vocabulary: realm
range: string

History/payer
type: Property
domain: History
the hydra core vocabulary: payer
range: string

History/account
type: Link
domain: History
the hydra core vocabulary: account
max cardinality: 1
range: Account

History/echelon
type: Link
domain: History
the hydra core vocabulary: echelon
max cardinality: 1
range: Echelon

History/payment
type: Link
domain: History
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

History/itLocked
type: Property
domain: History
the hydra core vocabulary: itLocked
range: boolean

History/itHidden
type: Property
domain: History
the hydra core vocabulary: itHidden
range: boolean

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

History/details
type: Property
domain: History
the hydra core vocabulary: details

History/createdAt
type: Property
domain: History
the hydra core vocabulary: createdAt
range: dateTime

History/updatedAt
type: Property
domain: History
the hydra core vocabulary: updatedAt
range: dateTime

History/createdBy
type: Property
domain: History
the hydra core vocabulary: createdBy
range: string

History/updatedBy
type: Property
domain: History
the hydra core vocabulary: updatedBy
range: string

History/paymentDetails
type: Property
domain: History
the hydra core vocabulary: paymentDetails

History/convertedAmounts
type: Property
domain: History
the hydra core vocabulary: convertedAmounts

Clearance
type: Class
title: Clearance
supported property: SupportedProperty
  property: Clearance/statement
  title: statement
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/echelon
  title: echelon
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Clearance/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  description: Updates the Clearance resource.
  expects: Clearance
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Clearance
  title: patchClearance
supported operation: Operation
  type: FindAction
  description: Retrieves a Clearance resource.
  method: GET
  returns: Clearance
  title: getClearance

Clearance/statement
type: Link
domain: Clearance
the hydra core vocabulary: statement
max cardinality: 1
range: Statement

Clearance/echelon
type: Link
domain: Clearance
the hydra core vocabulary: echelon
max cardinality: 1
range: Echelon

Clearance/payment
type: Link
domain: Clearance
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Clearance/itLocked
type: Property
domain: Clearance
the hydra core vocabulary: itLocked
range: boolean

Clearance/itHidden
type: Property
domain: Clearance
the hydra core vocabulary: itHidden
range: boolean

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

Clearance/details
type: Property
domain: Clearance
the hydra core vocabulary: details

Clearance/createdAt
type: Property
domain: Clearance
the hydra core vocabulary: createdAt
range: dateTime

Clearance/updatedAt
type: Property
domain: Clearance
the hydra core vocabulary: updatedAt
range: dateTime

Clearance/createdBy
type: Property
domain: Clearance
the hydra core vocabulary: createdBy
range: string

Clearance/updatedBy
type: Property
domain: Clearance
the hydra core vocabulary: updatedBy
range: string

Statement
type: Class
title: Statement
supported property: SupportedProperty
  property: Statement/statement
  title: statement
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/statementDate
  title: statementDate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/documentUri
  title: documentUri
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/documentFile
  title: documentFile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/fiscalYear
  title: fiscalYear
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/region
  title: region
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/clearances
  title: clearances
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Statement/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  description: Updates the Statement resource.
  expects: Statement
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Statement
  title: patchStatement
supported operation: Operation
  type: FindAction
  description: Retrieves a Statement resource.
  method: GET
  returns: Statement
  title: getStatement

Statement/statement
type: Property
domain: Statement
the hydra core vocabulary: statement
range: string

Statement/statementDate
type: Property
domain: Statement
the hydra core vocabulary: statementDate
range: dateTime

Statement/document
type: Property
domain: Statement
the hydra core vocabulary: document
range: string

Statement/documentUri
type: Property
domain: Statement
the hydra core vocabulary: documentUri
range: string

Statement/documentFile
type: Property
domain: Statement
the hydra core vocabulary: documentFile

Statement/fiscalYear
type: Property
domain: Statement
the hydra core vocabulary: fiscalYear
range: string

Statement/region
type: Property
domain: Statement
the hydra core vocabulary: region
range: string

Statement/realm
type: Property
domain: Statement
the hydra core vocabulary: realm
range: string

Statement/regie
type: Property
domain: Statement
the hydra core vocabulary: regie
range: string

Statement/clearances
type: Link
domain: Statement
the hydra core vocabulary: clearances
range: Clearance

Statement/itLocked
type: Property
domain: Statement
the hydra core vocabulary: itLocked
range: boolean

Statement/itHidden
type: Property
domain: Statement
the hydra core vocabulary: itHidden
range: boolean

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

Statement/details
type: Property
domain: Statement
the hydra core vocabulary: details

Statement/createdAt
type: Property
domain: Statement
the hydra core vocabulary: createdAt
range: dateTime

Statement/updatedAt
type: Property
domain: Statement
the hydra core vocabulary: updatedAt
range: dateTime

Statement/createdBy
type: Property
domain: Statement
the hydra core vocabulary: createdBy
range: string

Statement/updatedBy
type: Property
domain: Statement
the hydra core vocabulary: updatedBy
range: string

Currency
type: Class
title: Currency
supported property: SupportedProperty
  property: Currency/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/shortHead
  title: shortHead
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/symbol
  title: symbol
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/itSource
  title: itSource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Currency/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Currency resource.
  method: GET
  returns: Currency
  title: getCurrency
supported operation: Operation
  description: Updates the Currency resource.
  expects: Currency
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Currency
  title: patchCurrency

Currency/headLine
type: Property
domain: Currency
the hydra core vocabulary: headLine
range: string

Currency/shortHead
type: Property
domain: Currency
the hydra core vocabulary: shortHead
range: string

Currency/symbol
type: Property
domain: Currency
the hydra core vocabulary: symbol
range: string

Currency/itSource
type: Property
domain: Currency
the hydra core vocabulary: itSource
range: boolean

Currency/itLocked
type: Property
domain: Currency
the hydra core vocabulary: itLocked
range: boolean

Currency/itHidden
type: Property
domain: Currency
the hydra core vocabulary: itHidden
range: boolean

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

Currency/details
type: Property
domain: Currency
the hydra core vocabulary: details

Currency/createdAt
type: Property
domain: Currency
the hydra core vocabulary: createdAt
range: dateTime

Currency/updatedAt
type: Property
domain: Currency
the hydra core vocabulary: updatedAt
range: dateTime

Currency/createdBy
type: Property
domain: Currency
the hydra core vocabulary: createdBy
range: string

Currency/updatedBy
type: Property
domain: Currency
the hydra core vocabulary: updatedBy
range: string

Exchange
type: Class
title: Exchange
supported property: SupportedProperty
  property: Exchange/value
  title: value
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/source
  title: source
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/target
  title: target
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exchange/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Exchange resource.
  method: GET
  returns: Exchange
  title: getExchange
supported operation: Operation
  description: Updates the Exchange resource.
  expects: Exchange
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Exchange
  title: patchExchange

Exchange/value
type: Property
domain: Exchange
the hydra core vocabulary: value
range: string

Exchange/realm
type: Property
domain: Exchange
the hydra core vocabulary: realm
range: string

Exchange/source
type: Link
domain: Exchange
the hydra core vocabulary: source
max cardinality: 1
range: Currency

Exchange/target
type: Link
domain: Exchange
the hydra core vocabulary: target
max cardinality: 1
range: Currency

Exchange/itLocked
type: Property
domain: Exchange
the hydra core vocabulary: itLocked
range: boolean

Exchange/itHidden
type: Property
domain: Exchange
the hydra core vocabulary: itHidden
range: boolean

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

Exchange/details
type: Property
domain: Exchange
the hydra core vocabulary: details

Exchange/createdAt
type: Property
domain: Exchange
the hydra core vocabulary: createdAt
range: dateTime

Exchange/updatedAt
type: Property
domain: Exchange
the hydra core vocabulary: updatedAt
range: dateTime

Exchange/createdBy
type: Property
domain: Exchange
the hydra core vocabulary: createdBy
range: string

Exchange/updatedBy
type: Property
domain: Exchange
the hydra core vocabulary: updatedBy
range: string

Payout
type: Class
title: Payout
supported property: SupportedProperty
  property: Payout/paycode
  title: paycode
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/jwt
  title: jwt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/echelon
  title: echelon
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payout/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Payout resource.
  method: GET
  returns: owl:Nothing
  title: getPayout

Payout/paycode
type: Property
domain: Payout
the hydra core vocabulary: paycode
range: string

Payout/jwt
type: Property
domain: Payout
the hydra core vocabulary: jwt
range: string

Payout/createdAt
type: Property
domain: Payout
the hydra core vocabulary: createdAt
range: dateTime

Payout/payer
type: Property
domain: Payout
the hydra core vocabulary: payer
range: string

Payout/realm
type: Property
domain: Payout
the hydra core vocabulary: realm
range: string

Payout/echelon
type: Link
domain: Payout
the hydra core vocabulary: echelon
max cardinality: 1
range: Echelon

Payout/payment
type: Link
domain: Payout
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Timetable
type: Class
title: Timetable
supported property: SupportedProperty
  property: Timetable/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/codeName
  title: codeName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/days
  title: days
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Timetable/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Timetable resource.
  method: GET
  returns: Timetable
  title: getTimetable
supported operation: Operation
  description: Updates the Timetable resource.
  expects: Timetable
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Timetable
  title: patchTimetable

Timetable/headLine
type: Property
domain: Timetable
the hydra core vocabulary: headLine
range: string

Timetable/codeName
type: Property
domain: Timetable
the hydra core vocabulary: codeName
range: string

Timetable/days
type: Property
domain: Timetable
the hydra core vocabulary: days
range: integer

Timetable/realm
type: Property
domain: Timetable
the hydra core vocabulary: realm
range: string

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

Timetable/itLocked
type: Property
domain: Timetable
the hydra core vocabulary: itLocked
range: boolean

Timetable/itHidden
type: Property
domain: Timetable
the hydra core vocabulary: itHidden
range: boolean

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

Timetable/details
type: Property
domain: Timetable
the hydra core vocabulary: details

Timetable/createdAt
type: Property
domain: Timetable
the hydra core vocabulary: createdAt
range: dateTime

Timetable/updatedAt
type: Property
domain: Timetable
the hydra core vocabulary: updatedAt
range: dateTime

Timetable/createdBy
type: Property
domain: Timetable
the hydra core vocabulary: createdBy
range: string

Timetable/updatedBy
type: Property
domain: Timetable
the hydra core vocabulary: updatedBy
range: string

Category
type: Class
title: Category
supported property: SupportedProperty
  property: Category/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/wordings
  title: wordings
  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/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Category/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Category resource.
  method: GET
  returns: Category
  title: getCategory
supported operation: Operation
  description: Updates the Category resource.
  expects: Category
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Category
  title: patchCategory

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

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

Category/wordings
type: Link
domain: Category
the hydra core vocabulary: wordings
range: Wording

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

Category/itLocked
type: Property
domain: Category
the hydra core vocabulary: itLocked
range: boolean

Category/itHidden
type: Property
domain: Category
the hydra core vocabulary: itHidden
range: boolean

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

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

Category/createdAt
type: Property
domain: Category
the hydra core vocabulary: createdAt
range: dateTime

Category/updatedAt
type: Property
domain: Category
the hydra core vocabulary: updatedAt
range: dateTime

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

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

Overlay
type: Class
title: Overlay
supported property: SupportedProperty
  property: Overlay/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/process
  title: process
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/principal
  title: principal
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/itClosed
  title: itClosed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/handRaised
  title: handRaised
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/closedAt
  title: closedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/handRaisedAt
  title: handRaisedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/handRaisedBy
  title: handRaisedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/closedBy
  title: closedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/echelon
  title: echelon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/penalties
  title: penalties
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Overlay/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Overlay resource.
  method: GET
  returns: Overlay
  title: getOverlay
supported operation: Operation
  description: Updates the Overlay resource.
  expects: Overlay
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Overlay
  title: patchOverlay

Overlay/reference
type: Property
domain: Overlay
the hydra core vocabulary: reference
range: string

Overlay/process
type: Property
domain: Overlay
the hydra core vocabulary: process
range: string

Overlay/principal
type: Property
domain: Overlay
the hydra core vocabulary: principal
range: decimal

Overlay/itClosed
type: Property
domain: Overlay
the hydra core vocabulary: itClosed
range: boolean

Overlay/handRaised
type: Property
domain: Overlay
the hydra core vocabulary: handRaised
range: boolean

Overlay/closedAt
type: Property
domain: Overlay
the hydra core vocabulary: closedAt
range: dateTime

Overlay/handRaisedAt
type: Property
domain: Overlay
the hydra core vocabulary: handRaisedAt
range: dateTime

Overlay/handRaisedBy
type: Property
domain: Overlay
the hydra core vocabulary: handRaisedBy
range: string

Overlay/closedBy
type: Property
domain: Overlay
the hydra core vocabulary: closedBy
range: string

Overlay/realm
type: Property
domain: Overlay
the hydra core vocabulary: realm
range: string

Overlay/echelon
type: Link
domain: Overlay
the hydra core vocabulary: echelon
max cardinality: 1
range: Echelon

Overlay/payment
type: Link
domain: Overlay
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Overlay/penalties
type: Link
domain: Overlay
the hydra core vocabulary: penalties
range: Penalty

Overlay/itLocked
type: Property
domain: Overlay
the hydra core vocabulary: itLocked
range: boolean

Overlay/itHidden
type: Property
domain: Overlay
the hydra core vocabulary: itHidden
range: boolean

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

Overlay/details
type: Property
domain: Overlay
the hydra core vocabulary: details

Overlay/createdAt
type: Property
domain: Overlay
the hydra core vocabulary: createdAt
range: dateTime

Overlay/updatedAt
type: Property
domain: Overlay
the hydra core vocabulary: updatedAt
range: dateTime

Overlay/createdBy
type: Property
domain: Overlay
the hydra core vocabulary: createdBy
range: string

Overlay/updatedBy
type: Property
domain: Overlay
the hydra core vocabulary: updatedBy
range: string

Penalty
type: Class
title: Penalty
supported property: SupportedProperty
  property: Penalty/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/operation
  title: operation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/periodicity
  title: periodicity
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/wording
  title: wording
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/overlay
  title: overlay
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Penalty/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Penalty resource.
  method: GET
  returns: Penalty
  title: getPenalty
supported operation: Operation
  description: Updates the Penalty resource.
  expects: Penalty
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Penalty
  title: patchPenalty

Penalty/rate
type: Property
domain: Penalty
the hydra core vocabulary: rate
range: decimal

Penalty/operation
type: Property
domain: Penalty
the hydra core vocabulary: operation
range: string

Penalty/periodicity
type: Property
domain: Penalty
the hydra core vocabulary: periodicity
range: string

Penalty/wording
type: Link
domain: Penalty
the hydra core vocabulary: wording
max cardinality: 1
range: Wording

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

Penalty/overlay
type: Link
domain: Penalty
the hydra core vocabulary: overlay
max cardinality: 1
range: Overlay

Penalty/itLocked
type: Property
domain: Penalty
the hydra core vocabulary: itLocked
range: boolean

Penalty/itHidden
type: Property
domain: Penalty
the hydra core vocabulary: itHidden
range: boolean

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

Penalty/details
type: Property
domain: Penalty
the hydra core vocabulary: details

Penalty/createdAt
type: Property
domain: Penalty
the hydra core vocabulary: createdAt
range: dateTime

Penalty/updatedAt
type: Property
domain: Penalty
the hydra core vocabulary: updatedAt
range: dateTime

Penalty/createdBy
type: Property
domain: Penalty
the hydra core vocabulary: createdBy
range: string

Penalty/updatedBy
type: Property
domain: Penalty
the hydra core vocabulary: updatedBy
range: string

Wording
type: Class
title: Wording
supported property: SupportedProperty
  property: Wording/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/operation
  title: operation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/taxation
  title: taxation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/periodicity
  title: periodicity
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/forTaxes
  title: forTaxes
  required: false
  readable: true
  writeable: true
  description: true : La pénalité s'applique uniquement qu'aux taxes
supported property: SupportedProperty
  property: Wording/forImposts
  title: forImposts
  required: false
  readable: true
  writeable: true
  description: true : La pénalité s'applique uniquement qu'aux impôts
supported property: SupportedProperty
  property: Wording/autoExecutable
  title: autoExecutable
  required: false
  readable: true
  writeable: true
  description: true : La pénalité s'applique automatiquement
supported property: SupportedProperty
  property: Wording/timetable
  title: timetable
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Wording resource.
  method: GET
  returns: Wording
  title: getWording
supported operation: Operation
  description: Updates the Wording resource.
  expects: Wording
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Wording
  title: patchWording

Wording/headLine
type: Property
domain: Wording
the hydra core vocabulary: headLine
range: string

Wording/realm
type: Property
domain: Wording
the hydra core vocabulary: realm
range: string

Wording/operation
type: Property
domain: Wording
the hydra core vocabulary: operation
range: string

Wording/taxation
type: Property
domain: Wording
the hydra core vocabulary: taxation
range: string

Wording/periodicity
type: Property
domain: Wording
the hydra core vocabulary: periodicity
range: string

Wording/rate
type: Property
domain: Wording
the hydra core vocabulary: rate
range: decimal

Wording/forTaxes
type: Property
domain: Wording
the hydra core vocabulary: forTaxes
range: boolean

Wording/forImposts
type: Property
domain: Wording
the hydra core vocabulary: forImposts
range: boolean

Wording/autoExecutable
type: Property
domain: Wording
the hydra core vocabulary: autoExecutable
range: boolean

Wording/timetable
type: Link
domain: Wording
the hydra core vocabulary: timetable
max cardinality: 1
range: Timetable

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

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

Wording/itLocked
type: Property
domain: Wording
the hydra core vocabulary: itLocked
range: boolean

Wording/itHidden
type: Property
domain: Wording
the hydra core vocabulary: itHidden
range: boolean

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

Wording/details
type: Property
domain: Wording
the hydra core vocabulary: details

Wording/createdAt
type: Property
domain: Wording
the hydra core vocabulary: createdAt
range: dateTime

Wording/updatedAt
type: Property
domain: Wording
the hydra core vocabulary: updatedAt
range: dateTime

Wording/createdBy
type: Property
domain: Wording
the hydra core vocabulary: createdBy
range: string

Wording/updatedBy
type: Property
domain: Wording
the hydra core vocabulary: updatedBy
range: string

Claim
type: Class
title: Claim
supported property: SupportedProperty
  property: Claim/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/nature
  title: nature
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/exchange
  title: exchange
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/echelon
  title: echelon
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Claim/paymentData
  title: paymentData
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Claim/echelonData
  title: echelonData
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Claim resource.
  method: GET
  returns: Claim
  title: getClaim
supported operation: Operation
  description: Updates the Claim resource.
  expects: Claim
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Claim
  title: patchClaim

Claim/reference
type: Property
domain: Claim
the hydra core vocabulary: reference
range: string

Claim/nature
type: Property
domain: Claim
the hydra core vocabulary: nature
range: string

Claim/exchange
type: Property
domain: Claim
the hydra core vocabulary: exchange
range: decimal

Claim/amount
type: Property
domain: Claim
the hydra core vocabulary: amount
range: decimal

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

Claim/center
type: Property
domain: Claim
the hydra core vocabulary: center
range: string

Claim/regie
type: Property
domain: Claim
the hydra core vocabulary: regie
range: string

Claim/realm
type: Property
domain: Claim
the hydra core vocabulary: realm
range: string

Claim/currency
type: Link
domain: Claim
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Claim/echelon
type: Link
domain: Claim
the hydra core vocabulary: echelon
max cardinality: 1
range: Echelon

Claim/payment
type: Link
domain: Claim
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Claim/itLocked
type: Property
domain: Claim
the hydra core vocabulary: itLocked
range: boolean

Claim/itHidden
type: Property
domain: Claim
the hydra core vocabulary: itHidden
range: boolean

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

Claim/details
type: Property
domain: Claim
the hydra core vocabulary: details

Claim/createdAt
type: Property
domain: Claim
the hydra core vocabulary: createdAt
range: dateTime

Claim/updatedAt
type: Property
domain: Claim
the hydra core vocabulary: updatedAt
range: dateTime

Claim/createdBy
type: Property
domain: Claim
the hydra core vocabulary: createdBy
range: string

Claim/updatedBy
type: Property
domain: Claim
the hydra core vocabulary: updatedBy
range: string

Claim/paymentData
type: Property
domain: Claim
the hydra core vocabulary: paymentData

Claim/echelonData
type: Property
domain: Claim
the hydra core vocabulary: echelonData

Echelon
type: Class
title: Echelon
supported property: SupportedProperty
  property: Echelon/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/method
  title: method
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/exchange
  title: exchange
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itBankEncoded
  title: itBankEncoded
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itBankValidate
  title: itBankValidate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/normalClear
  title: normalClear
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/adminClear
  title: adminClear
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itImpot
  title: itImpot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itPaid
  title: itPaid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/payDate
  title: payDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/bank
  title: bank
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/overlay
  title: overlay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/clearance
  title: clearance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/claims
  title: claims
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Echelon/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Echelon resource.
  method: GET
  returns: Echelon
  title: getEchelon
supported operation: Operation
  description: Updates the Echelon resource.
  expects: Echelon
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Echelon
  title: patchEchelon
supported operation: Operation
  description: Updates the Echelon resource.
  expects: Echelon
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Echelon
  title: patchEchelon

Echelon/reference
type: Property
domain: Echelon
the hydra core vocabulary: reference
range: string

Echelon/method
type: Property
domain: Echelon
the hydra core vocabulary: method
range: string

Echelon/exchange
type: Property
domain: Echelon
the hydra core vocabulary: exchange
range: decimal

Echelon/amount
type: Property
domain: Echelon
the hydra core vocabulary: amount
range: decimal

Echelon/itBankEncoded
type: Property
domain: Echelon
the hydra core vocabulary: itBankEncoded
range: boolean

Echelon/itBankValidate
type: Property
domain: Echelon
the hydra core vocabulary: itBankValidate
range: boolean

Echelon/normalClear
type: Property
domain: Echelon
the hydra core vocabulary: normalClear
range: boolean

Echelon/adminClear
type: Property
domain: Echelon
the hydra core vocabulary: adminClear
range: boolean

Echelon/itImpot
type: Property
domain: Echelon
the hydra core vocabulary: itImpot
range: boolean

Echelon/itPaid
type: Property
domain: Echelon
the hydra core vocabulary: itPaid
range: boolean

Echelon/payDate
type: Property
domain: Echelon
the hydra core vocabulary: payDate
range: dateTime

Echelon/payer
type: Property
domain: Echelon
the hydra core vocabulary: payer
range: string

Echelon/bank
type: Property
domain: Echelon
the hydra core vocabulary: bank
range: string

Echelon/center
type: Property
domain: Echelon
the hydra core vocabulary: center
range: string

Echelon/regie
type: Property
domain: Echelon
the hydra core vocabulary: regie
range: string

Echelon/realm
type: Property
domain: Echelon
the hydra core vocabulary: realm
range: string

Echelon/overlay
type: Link
domain: Echelon
the hydra core vocabulary: overlay
max cardinality: 1
range: Overlay

Echelon/currency
type: Link
domain: Echelon
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Echelon/payment
type: Link
domain: Echelon
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Echelon/clearance
type: Link
domain: Echelon
the hydra core vocabulary: clearance
max cardinality: 1
range: Clearance

Echelon/claims
type: Link
domain: Echelon
the hydra core vocabulary: claims
range: Claim

Echelon/itLocked
type: Property
domain: Echelon
the hydra core vocabulary: itLocked
range: boolean

Echelon/itHidden
type: Property
domain: Echelon
the hydra core vocabulary: itHidden
range: boolean

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

Echelon/details
type: Property
domain: Echelon
the hydra core vocabulary: details

Echelon/createdAt
type: Property
domain: Echelon
the hydra core vocabulary: createdAt
range: dateTime

Echelon/updatedAt
type: Property
domain: Echelon
the hydra core vocabulary: updatedAt
range: dateTime

Echelon/createdBy
type: Property
domain: Echelon
the hydra core vocabulary: createdBy
range: string

Echelon/updatedBy
type: Property
domain: Echelon
the hydra core vocabulary: updatedBy
range: string

Payment
type: Class
title: Payment
supported property: SupportedProperty
  property: Payment/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/headLine
  title: headLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/nature
  title: nature
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/process
  title: process
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itValuePrintable
  title: itValuePrintable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itRegulation
  title: itRegulation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itProvision
  title: itProvision
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itEchelon
  title: itEchelon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itImpot
  title: itImpot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itPaid
  title: itPaid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/resource
  title: resource
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/note
  title: note
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/fiscalYear
  title: fiscalYear
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/spare
  title: spare
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/echelons
  title: echelons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payment/echelonData
  title: echelonData
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Payment resource.
  method: GET
  returns: Payment
  title: getPayment

Payment/reference
type: Property
domain: Payment
the hydra core vocabulary: reference
range: string

Payment/headLine
type: Property
domain: Payment
the hydra core vocabulary: headLine
range: string

Payment/category
type: Property
domain: Payment
the hydra core vocabulary: category
range: string

Payment/nature
type: Property
domain: Payment
the hydra core vocabulary: nature
range: string

Payment/process
type: Property
domain: Payment
the hydra core vocabulary: process
range: string

Payment/amount
type: Property
domain: Payment
the hydra core vocabulary: amount
range: decimal

Payment/itValuePrintable
type: Property
domain: Payment
the hydra core vocabulary: itValuePrintable
range: boolean

Payment/itRegulation
type: Property
domain: Payment
the hydra core vocabulary: itRegulation
range: boolean

Payment/itProvision
type: Property
domain: Payment
the hydra core vocabulary: itProvision
range: boolean

Payment/itEchelon
type: Property
domain: Payment
the hydra core vocabulary: itEchelon
range: boolean

Payment/itImpot
type: Property
domain: Payment
the hydra core vocabulary: itImpot
range: boolean

Payment/itPaid
type: Property
domain: Payment
the hydra core vocabulary: itPaid
range: boolean

Payment/payer
type: Property
domain: Payment
the hydra core vocabulary: payer
range: string

Payment/resource
type: Property
domain: Payment
the hydra core vocabulary: resource
range: string

Payment/note
type: Property
domain: Payment
the hydra core vocabulary: note
range: string

Payment/fiscalYear
type: Property
domain: Payment
the hydra core vocabulary: fiscalYear
range: string

Payment/spare
type: Property
domain: Payment
the hydra core vocabulary: spare
range: string

Payment/realm
type: Property
domain: Payment
the hydra core vocabulary: realm
range: string

Payment/currency
type: Link
domain: Payment
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Payment/echelons
type: Link
domain: Payment
the hydra core vocabulary: echelons
range: Echelon

Payment/itLocked
type: Property
domain: Payment
the hydra core vocabulary: itLocked
range: boolean

Payment/itHidden
type: Property
domain: Payment
the hydra core vocabulary: itHidden
range: boolean

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

Payment/details
type: Property
domain: Payment
the hydra core vocabulary: details

Payment/createdAt
type: Property
domain: Payment
the hydra core vocabulary: createdAt
range: dateTime

Payment/updatedAt
type: Property
domain: Payment
the hydra core vocabulary: updatedAt
range: dateTime

Payment/createdBy
type: Property
domain: Payment
the hydra core vocabulary: createdBy
range: string

Payment/updatedBy
type: Property
domain: Payment
the hydra core vocabulary: updatedBy
range: string

Payment/echelonData
type: Property
domain: Payment
the hydra core vocabulary: echelonData

Inquire
type: Class
title: Inquire
supported property: SupportedProperty
  property: Inquire/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/firstDeposit
  title: firstDeposit
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/itAllowed
  title: itAllowed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/itAborted
  title: itAborted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/itDisallowed
  title: itDisallowed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/allowedAt
  title: allowedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/disallowedAt
  title: disallowedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/allowedBy
  title: allowedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/disallowedBy
  title: disallowedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/pricing
  title: pricing
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Inquire/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Inquire resource.
  method: GET
  returns: Inquire
  title: getInquire
supported operation: Operation
  description: Updates the Inquire resource.
  expects: Inquire
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Inquire
  title: patchInquire

Inquire/reference
type: Property
domain: Inquire
the hydra core vocabulary: reference
range: string

Inquire/category
type: Property
domain: Inquire
the hydra core vocabulary: category
range: string

Inquire/amount
type: Property
domain: Inquire
the hydra core vocabulary: amount
range: decimal

Inquire/firstDeposit
type: Property
domain: Inquire
the hydra core vocabulary: firstDeposit
range: decimal

Inquire/rate
type: Property
domain: Inquire
the hydra core vocabulary: rate
range: decimal

Inquire/itAllowed
type: Property
domain: Inquire
the hydra core vocabulary: itAllowed
range: boolean

Inquire/itAborted
type: Property
domain: Inquire
the hydra core vocabulary: itAborted
range: boolean

Inquire/itDisallowed
type: Property
domain: Inquire
the hydra core vocabulary: itDisallowed
range: boolean

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

Inquire/allowedAt
type: Property
domain: Inquire
the hydra core vocabulary: allowedAt
range: dateTime

Inquire/disallowedAt
type: Property
domain: Inquire
the hydra core vocabulary: disallowedAt
range: dateTime

Inquire/allowedBy
type: Property
domain: Inquire
the hydra core vocabulary: allowedBy
range: string

Inquire/disallowedBy
type: Property
domain: Inquire
the hydra core vocabulary: disallowedBy
range: string

Inquire/pricing
type: Link
domain: Inquire
the hydra core vocabulary: pricing
max cardinality: 1
range: Pricing

Inquire/payment
type: Link
domain: Inquire
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Inquire/currency
type: Link
domain: Inquire
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Inquire/itLocked
type: Property
domain: Inquire
the hydra core vocabulary: itLocked
range: boolean

Inquire/itHidden
type: Property
domain: Inquire
the hydra core vocabulary: itHidden
range: boolean

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

Inquire/details
type: Property
domain: Inquire
the hydra core vocabulary: details

Inquire/createdAt
type: Property
domain: Inquire
the hydra core vocabulary: createdAt
range: dateTime

Inquire/updatedAt
type: Property
domain: Inquire
the hydra core vocabulary: updatedAt
range: dateTime

Inquire/createdBy
type: Property
domain: Inquire
the hydra core vocabulary: createdBy
range: string

Inquire/updatedBy
type: Property
domain: Inquire
the hydra core vocabulary: updatedBy
range: string

Payoff
type: Class
title: Payoff
supported property: SupportedProperty
  property: Payoff/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/remaining
  title: remaining
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/itFirstDeposit
  title: itFirstDeposit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/itPaid
  title: itPaid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/slice
  title: slice
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Payoff/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Payoff resource.
  method: GET
  returns: Payoff
  title: getPayoff
supported operation: Operation
  description: Updates the Payoff resource.
  expects: Payoff
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Payoff
  title: patchPayoff

Payoff/reference
type: Property
domain: Payoff
the hydra core vocabulary: reference
range: string

Payoff/amount
type: Property
domain: Payoff
the hydra core vocabulary: amount
range: decimal

Payoff/remaining
type: Property
domain: Payoff
the hydra core vocabulary: remaining
range: decimal

Payoff/itFirstDeposit
type: Property
domain: Payoff
the hydra core vocabulary: itFirstDeposit
range: boolean

Payoff/itPaid
type: Property
domain: Payoff
the hydra core vocabulary: itPaid
range: boolean

Payoff/currency
type: Link
domain: Payoff
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Payoff/slice
type: Link
domain: Payoff
the hydra core vocabulary: slice
max cardinality: 1
range: Slice

Payoff/itLocked
type: Property
domain: Payoff
the hydra core vocabulary: itLocked
range: boolean

Payoff/itHidden
type: Property
domain: Payoff
the hydra core vocabulary: itHidden
range: boolean

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

Payoff/details
type: Property
domain: Payoff
the hydra core vocabulary: details

Payoff/createdAt
type: Property
domain: Payoff
the hydra core vocabulary: createdAt
range: dateTime

Payoff/updatedAt
type: Property
domain: Payoff
the hydra core vocabulary: updatedAt
range: dateTime

Payoff/createdBy
type: Property
domain: Payoff
the hydra core vocabulary: createdBy
range: string

Payoff/updatedBy
type: Property
domain: Payoff
the hydra core vocabulary: updatedBy
range: string

Pricing
type: Class
title: Pricing
supported property: SupportedProperty
  property: Pricing/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/taxation
  title: taxation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/minimum
  title: minimum
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/maximum
  title: maximum
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/rate
  title: rate
  required: true
  readable: true
  writeable: true
  description: Taux d'intérêt exprimé : 1. Soit en montant fixe (TAXATION_FIXED), Ex. : 450 2. Soit en pourcentage (TAXATION_VARYING), Ex. : 10
supported property: SupportedProperty
  property: Pricing/firstDeposit
  title: firstDeposit
  required: true
  readable: true
  writeable: true
  description: Le taux de premier versement est exprimé en pourcentage si le taux d'intérêt est exprimé en pourcentage.
supported property: SupportedProperty
  property: Pricing/slices
  title: slices
  required: true
  readable: true
  writeable: true
  description: Durée en JOURS pour l'approvisionnement fiscal (CATEGORY_PROVISION) Nombre des tranches pour l'échelonnement (CATEGORY_ECHELON), une tranche correspondant à un mois
supported property: SupportedProperty
  property: Pricing/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Pricing/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Pricing resource.
  method: GET
  returns: Pricing
  title: getPricing
supported operation: Operation
  description: Updates the Pricing resource.
  expects: Pricing
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Pricing
  title: patchPricing

Pricing/category
type: Property
domain: Pricing
the hydra core vocabulary: category
range: string

Pricing/taxation
type: Property
domain: Pricing
the hydra core vocabulary: taxation
range: string

Pricing/minimum
type: Property
domain: Pricing
the hydra core vocabulary: minimum
range: decimal

Pricing/maximum
type: Property
domain: Pricing
the hydra core vocabulary: maximum
range: decimal

Pricing/rate
type: Property
domain: Pricing
the hydra core vocabulary: rate
range: decimal

Pricing/firstDeposit
type: Property
domain: Pricing
the hydra core vocabulary: firstDeposit
range: decimal

Pricing/slices
type: Property
domain: Pricing
the hydra core vocabulary: slices
range: integer

Pricing/currency
type: Link
domain: Pricing
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Pricing/itLocked
type: Property
domain: Pricing
the hydra core vocabulary: itLocked
range: boolean

Pricing/itHidden
type: Property
domain: Pricing
the hydra core vocabulary: itHidden
range: boolean

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

Pricing/details
type: Property
domain: Pricing
the hydra core vocabulary: details

Pricing/createdAt
type: Property
domain: Pricing
the hydra core vocabulary: createdAt
range: dateTime

Pricing/updatedAt
type: Property
domain: Pricing
the hydra core vocabulary: updatedAt
range: dateTime

Pricing/createdBy
type: Property
domain: Pricing
the hydra core vocabulary: createdBy
range: string

Pricing/updatedBy
type: Property
domain: Pricing
the hydra core vocabulary: updatedBy
range: string

Slice
type: Class
title: Slice
supported property: SupportedProperty
  property: Slice/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/amount
  title: amount
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/remaining
  title: remaining
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/itClosed
  title: itClosed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/itAborted
  title: itAborted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/closedAt
  title: closedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/abortedAt
  title: abortedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/abortedBy
  title: abortedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/payment
  title: payment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/payments
  title: payments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Slice/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Slice resource.
  method: GET
  returns: Slice
  title: getSlice
supported operation: Operation
  description: Updates the Slice resource.
  expects: Slice
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
    possible value: application/vnd.api+json
  method: PATCH
  returns: Slice
  title: patchSlice

Slice/reference
type: Property
domain: Slice
the hydra core vocabulary: reference
range: string

Slice/category
type: Property
domain: Slice
the hydra core vocabulary: category
range: string

Slice/amount
type: Property
domain: Slice
the hydra core vocabulary: amount
range: decimal

Slice/rate
type: Property
domain: Slice
the hydra core vocabulary: rate
range: decimal

Slice/remaining
type: Property
domain: Slice
the hydra core vocabulary: remaining
range: decimal

Slice/itClosed
type: Property
domain: Slice
the hydra core vocabulary: itClosed
range: boolean

Slice/itAborted
type: Property
domain: Slice
the hydra core vocabulary: itAborted
range: boolean

Slice/closedAt
type: Property
domain: Slice
the hydra core vocabulary: closedAt
range: dateTime

Slice/abortedAt
type: Property
domain: Slice
the hydra core vocabulary: abortedAt
range: dateTime

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

Slice/abortedBy
type: Property
domain: Slice
the hydra core vocabulary: abortedBy
range: string

Slice/payment
type: Link
domain: Slice
the hydra core vocabulary: payment
max cardinality: 1
range: Payment

Slice/currency
type: Link
domain: Slice
the hydra core vocabulary: currency
max cardinality: 1
range: Currency

Slice/payments
type: Link
domain: Slice
the hydra core vocabulary: payments
range: Payoff

Slice/itLocked
type: Property
domain: Slice
the hydra core vocabulary: itLocked
range: boolean

Slice/itHidden
type: Property
domain: Slice
the hydra core vocabulary: itHidden
range: boolean

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

Slice/details
type: Property
domain: Slice
the hydra core vocabulary: details

Slice/createdAt
type: Property
domain: Slice
the hydra core vocabulary: createdAt
range: dateTime

Slice/updatedAt
type: Property
domain: Slice
the hydra core vocabulary: updatedAt
range: dateTime

Slice/createdBy
type: Property
domain: Slice
the hydra core vocabulary: createdBy
range: string

Slice/updatedBy
type: Property
domain: Slice
the hydra core vocabulary: updatedBy
range: string

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/account
  title: getAccountCollection
  description: The collection of Account resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/history
  title: getHistoryCollection
  description: The collection of History resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/clearance
  title: getClearanceCollection
  description: The collection of Clearance resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/statement
  title: getStatementCollection
  description: The collection of Statement resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/currency
  title: getCurrencyCollection
  description: The collection of Currency resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/exchange
  title: getExchangeCollection
  description: The collection of Exchange resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/payout
  title: getPayoutCollection
  description: The collection of Payout resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/timetable
  title: getTimetableCollection
  description: The collection of Timetable 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/overlay
  title: getOverlayCollection
  description: The collection of Overlay resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/penalty
  title: getPenaltyCollection
  description: The collection of Penalty resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/wording
  title: getWordingCollection
  description: The collection of Wording resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/claim
  title: getClaimCollection
  description: The collection of Claim resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/echelon
  title: getEchelonCollection
  description: The collection of Echelon resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/payment
  title: getPaymentCollection
  description: The collection of Payment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/inquire
  title: getInquireCollection
  description: The collection of Inquire resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/payoff
  title: getPayoffCollection
  description: The collection of Payoff resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/pricing
  title: getPricingCollection
  description: The collection of Pricing resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/slice
  title: getSliceCollection
  description: The collection of Slice resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

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

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

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

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

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

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

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

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

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/overlay
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Overlay
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Overlay resources.
  method: GET
  returns: Collection
  title: getOverlayCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Overlay resource.
  expects: Overlay
  method: POST
  returns: Overlay
  title: postOverlay

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

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

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

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

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

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

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

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

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

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

Operation
description: Updates the Echelon resource.
expects: Echelon
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
  possible value: application/vnd.api+json
method: PATCH
returns: Echelon
title: patchEchelon