docs.jsonld
type: ApiDocumentation
title: e-Tax Landed API
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Bank
supported class: Exemption
supported class: Taxing
supported class: Wording
supported class: Expiry
supported class: Batch
supported class: Note
supported class: NoteItem
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.
subclass 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
subclass 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

Bank
type: Class
title: Bank
supported property: SupportedProperty
  property: Bank/company
  title: company
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/bank
  title: bank
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Bank/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Bank resource.
  method: GET
  returns: Bank
  title: getBank
supported operation: Operation
  description: Updates the Bank resource.
  expects: Bank
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Bank
  title: patchBank

Bank/company
type: Property
domain: Bank
the hydra core vocabulary: company
range: string

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

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

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

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

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

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

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

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

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

Exemption
type: Class
title: Exemption
supported property: SupportedProperty
  property: Exemption/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/taxation
  title: taxation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/openedAt
  title: openedAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/closedAt
  title: closedAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/document
  title: document
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/documentUri
  title: documentUri
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Exemption/documentFile
  title: documentFile
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Exemption/immovable
  title: immovable
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/township
  title: township
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Exemption/region
  title: region
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Exemption resource.
  method: GET
  returns: Exemption
  title: getExemption
supported operation: Operation
  description: Updates the Exemption resource.
  expects: Exemption
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Exemption
  title: patchExemption

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

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

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

Exemption/rate
type: Property
domain: Exemption
the hydra core vocabulary: rate
range: string

Exemption/openedAt
type: Property
domain: Exemption
the hydra core vocabulary: openedAt
range: dateTime

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

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

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

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

Exemption/immovable
type: Property
domain: Exemption
the hydra core vocabulary: immovable

Exemption/payer
type: Property
domain: Exemption
the hydra core vocabulary: payer

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

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

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

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

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

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

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

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

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

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

Exemption/city
type: Property
domain: Exemption
the hydra core vocabulary: city
range: string

Exemption/township
type: Property
domain: Exemption
the hydra core vocabulary: township
range: string

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

Exemption/country
type: Property
domain: Exemption
the hydra core vocabulary: country
range: string

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

Taxing
type: Class
title: Taxing
supported property: SupportedProperty
  property: Taxing/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/minimum
  title: minimum
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/maximum
  title: maximum
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/wording
  title: wording
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Taxing/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Taxing resource.
  method: GET
  returns: Taxing
  title: getTaxing
supported operation: Operation
  description: Updates the Taxing resource.
  expects: Taxing
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Taxing
  title: patchTaxing

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

Taxing/minimum
type: Property
domain: Taxing
the hydra core vocabulary: minimum
range: integer

Taxing/maximum
type: Property
domain: Taxing
the hydra core vocabulary: maximum
range: integer

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

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

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

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

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

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

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

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

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

Wording
type: Class
title: Wording
supported property: SupportedProperty
  property: Wording/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/nature
  title: nature
  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/level
  title: level
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/itRangePrice
  title: itRangePrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/range
  title: range
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/usage
  title: usage
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/taxings
  title: taxings
  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 property: SupportedProperty
  property: Wording/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Wording/region
  title: region
  required: true
  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
  method: PATCH
  returns: Wording
  title: patchWording

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

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

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

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

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

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

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

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

Wording/taxings
type: Link
domain: Wording
the hydra core vocabulary: taxings
range: Taxing

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

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

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

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

Expiry
type: Class
title: Expiry
supported property: SupportedProperty
  property: Expiry/openAt
  title: openAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/closeAt
  title: closeAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/boostAt
  title: boostAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/fiscalYear
  title: fiscalYear
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Expiry/region
  title: region
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Expiry resource.
  method: GET
  returns: Expiry
  title: getExpiry
supported operation: Operation
  description: Updates the Expiry resource.
  expects: Expiry
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Expiry
  title: patchExpiry

Expiry/openAt
type: Property
domain: Expiry
the hydra core vocabulary: openAt
range: dateTime

Expiry/closeAt
type: Property
domain: Expiry
the hydra core vocabulary: closeAt
range: dateTime

Expiry/boostAt
type: Property
domain: Expiry
the hydra core vocabulary: boostAt
range: dateTime

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

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

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

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

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

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

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

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

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

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

Expiry/country
type: Property
domain: Expiry
the hydra core vocabulary: country
range: string

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

Batch
type: Class
title: Batch
supported property: SupportedProperty
  property: Batch/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/township
  title: township
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Batch/region
  title: region
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Batch resource.
  method: GET
  returns: Batch
  title: getBatch
supported operation: Operation
  description: Updates the Batch resource.
  expects: Batch
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: Batch
  title: patchBatch

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

Batch/notes
type: Link
domain: Batch
the hydra core vocabulary: notes
range: Note

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

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

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

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

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

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

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

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

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

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

Batch/city
type: Property
domain: Batch
the hydra core vocabulary: city
range: string

Batch/township
type: Property
domain: Batch
the hydra core vocabulary: township
range: string

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

Batch/country
type: Property
domain: Batch
the hydra core vocabulary: country
range: string

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

Note
type: Class
title: Note
supported property: SupportedProperty
  property: Note/reference
  title: reference
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/category
  title: category
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/nature
  title: nature
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/unbuiltArea
  title: unbuiltArea
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/exchange
  title: exchange
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/exoneration
  title: exoneration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/itExempt
  title: itExempt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/itExonerate
  title: itExonerate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/fiscalYear
  title: fiscalYear
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/range
  title: range
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/usage
  title: usage
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/currency
  title: currency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/immovable
  title: immovable
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/profile
  title: profile
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/batch
  title: batch
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/items
  title: items
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/itLocked
  title: itLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/itHidden
  title: itHidden
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/createdBy
  title: createdBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/updatedBy
  title: updatedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/regie
  title: regie
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/center
  title: center
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/city
  title: city
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/township
  title: township
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/realm
  title: realm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Note/region
  title: region
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Note resource.
  method: GET
  returns: Note
  title: getNote

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

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

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

Note/unbuiltArea
type: Property
domain: Note
the hydra core vocabulary: unbuiltArea
range: string

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

Note/exoneration
type: Property
domain: Note
the hydra core vocabulary: exoneration
range: string

Note/itExempt
type: Property
domain: Note
the hydra core vocabulary: itExempt
range: boolean

Note/itExonerate
type: Property
domain: Note
the hydra core vocabulary: itExonerate
range: boolean

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

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

Note/usage
type: Property
domain: Note
the hydra core vocabulary: usage
range: string

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

Note/immovable
type: Property
domain: Note
the hydra core vocabulary: immovable
range: string

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

Note/profile
type: Property
domain: Note
the hydra core vocabulary: profile
range: string

Note/batch
type: Link
domain: Note
the hydra core vocabulary: batch
max cardinality: 1
range: Batch

Note/items
type: Link
domain: Note
the hydra core vocabulary: items
range: NoteItem

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

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

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

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

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

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

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

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

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

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

Note/city
type: Property
domain: Note
the hydra core vocabulary: city
range: string

Note/township
type: Property
domain: Note
the hydra core vocabulary: township
range: string

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

Note/country
type: Property
domain: Note
the hydra core vocabulary: country
range: string

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

NoteItem
type: Class
title: NoteItem
supported property: SupportedProperty
  property: NoteItem/level
  title: level
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/taxation
  title: taxation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/rate
  title: rate
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/area
  title: area
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/building
  title: building
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/immovable
  title: immovable
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/payer
  title: payer
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: NoteItem/note
  title: note
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a NoteItem resource.
  method: GET
  returns: NoteItem
  title: getNoteItem

NoteItem/level
type: Property
domain: NoteItem
the hydra core vocabulary: level
range: string

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

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

NoteItem/area
type: Property
domain: NoteItem
the hydra core vocabulary: area
range: string

NoteItem/building
type: Property
domain: NoteItem
the hydra core vocabulary: building
range: string

NoteItem/immovable
type: Property
domain: NoteItem
the hydra core vocabulary: immovable
range: string

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

NoteItem/note
type: Link
domain: NoteItem
the hydra core vocabulary: note
max cardinality: 1
range: Note

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/bank
  title: getBankCollection
  description: The collection of Bank resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/exemption
  title: getExemptionCollection
  description: The collection of Exemption resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/taxing
  title: getTaxingCollection
  description: The collection of Taxing 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/expiry
  title: getExpiryCollection
  description: The collection of Expiry resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/batch
  title: getBatchCollection
  description: The collection of Batch resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/note
  title: getNoteCollection
  description: The collection of Note resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/noteItem
  title: getNoteItemCollection
  description: The collection of NoteItem resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

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

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

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

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: CreateAction
  description: Creates a Wording resource.
  expects: Wording
  method: POST
  returns: Wording
  title: postWording
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Wording resources.
  method: GET
  returns: Collection
  title: getWordingCollection

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

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

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

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

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

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string