docs.jsonld
type: ApiDocumentation
title: KIREZI API
entrypoint: /api
supported class: Error
supported class: ConstraintViolationList
supported class: BnrExchangeRate
supported class: Broker
supported class: Collaborator
supported class: Customer
supported class: Disbursement
supported class: DisbursementLine
supported class: DisbursementLineTemplate
supported class: Owner
supported class: Localization
supported class: Property
supported class: ProspectProjectAdminRead
supported class: Photo
supported class: Publication
supported class: PublicationAdminDetailRead
supported class: PublicationAdminListRead
supported class: PublicationDetailsRead
supported class: PublicationPublicListRead
supported class: Agreement
supported class: NotarySignature
supported class: Payment
supported class: Transaction
supported class: KireziTreasury
supported class: KireziTreasuryMovement
supported class: TreasuryLineTemplate
supported class: TreasuryRecord
supported class: Entrypoint
supported class: ConstraintViolation

Error
type: Class
title: Error
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:title
  title: hydra:title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:description
  title: hydra:description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error

title
type: Property
domain: Error
range: string

detail
type: Property
domain: Error
range: string

status
type: Property
domain: Error
range: integer

instance
type: Property
domain: Error
range: string

type
type: Property
domain: Error
range: string

trace
type: Property
domain: Error

message
type: Property
domain: Error
range: string

code
type: Property
domain: Error
range: integer

file
type: Property
domain: Error
range: string

line
type: Property
domain: Error
range: integer

hydra:title
type: Property
domain: Error
range: string

hydra:description
type: Property
domain: Error
range: string

description
type: Property
domain: Error
range: string

string
type: Property
domain: Error

previous
type: Property
domain: Error

traceAsString
type: Property
domain: Error
range: string

ConstraintViolationList
type: Class
title: ConstraintViolationList
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: errorTitle
  title: errorTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:title
  title: hydra:title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:description
  title: hydra:description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
description: Thrown when a validation error occurs.
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

status
type: Property
domain: ConstraintViolationList
range: integer

errorTitle
type: Property
domain: ConstraintViolationList
range: string

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

detail
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

code
type: Property
domain: ConstraintViolationList
range: string
range: integer

file
type: Property
domain: ConstraintViolationList
range: string

line
type: Property
domain: ConstraintViolationList
range: integer

hydra:title
type: Property
domain: ConstraintViolationList
range: string

hydra:description
type: Property
domain: ConstraintViolationList
range: string

type
type: Property
domain: ConstraintViolationList
range: string

title
type: Property
domain: ConstraintViolationList
range: string

instance
type: Property
domain: ConstraintViolationList
range: string

statusCode
type: Property
domain: ConstraintViolationList
range: integer

headers
type: Property
domain: ConstraintViolationList

string
type: Property
domain: ConstraintViolationList

trace
type: Property
domain: ConstraintViolationList

previous
type: Property
domain: ConstraintViolationList

traceAsString
type: Property
domain: ConstraintViolationList
range: string

BnrExchangeRate
type: Class
title: BnrExchangeRate
supported property: SupportedProperty
  property: bnrId
  title: bnrId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: currencyName
  title: currencyName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageRate
  title: averageRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buyingRate
  title: buyingRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sellingRate
  title: sellingRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: postDate
  title: postDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: displayRate
  title: displayRate
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a BnrExchangeRate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a BnrExchangeRate resource.
  returns: BnrExchangeRate

bnrId
type: Property
domain: BnrExchangeRate
range: string

currencyName
type: Property
domain: BnrExchangeRate
range: string

averageRate
type: Property
domain: BnrExchangeRate
range: string

buyingRate
type: Property
domain: BnrExchangeRate
range: string

sellingRate
type: Property
domain: BnrExchangeRate
range: string

postDate
type: Property
domain: BnrExchangeRate
range: dateTime

createdAt
type: Property
domain: BnrExchangeRate
range: dateTime

displayRate
type: Property
domain: BnrExchangeRate
range: string

Broker
type: Class
title: Broker
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nid
  title: nid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: commissionRate
  title: commissionRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Broker resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Broker resource.
  returns: Broker
supported operation: Updates the Broker resource.
  type: Operation
  expects: Broker
  method: PATCH
  title: Updates the Broker resource.
  returns: Broker
supported operation: Deletes the Broker resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Broker resource.
  returns: Nothing

id
type: Property
domain: Broker

firstname
type: Property
domain: Broker
range: string

lastname
type: Property
domain: Broker
range: string

email
type: Property
domain: Broker
range: string

phone
type: Property
domain: Broker
range: string

nid
type: Property
domain: Broker
range: string

commissionRate
type: Property
domain: Broker
range: decimal

isActive
type: Property
domain: Broker
range: boolean

notes
type: Property
domain: Broker
range: string

Collaborator
type: Class
title: Collaborator
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nid
  title: nid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activationToken
  title: activationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: forgotPasswordToken
  title: forgotPasswordToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: googleId
  title: googleId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activationEmailSentAt
  title: activationEmailSentAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: archivedAt
  title: archivedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
  description: A visual identifier that represents this user.
supported operation: Retrieves a Collaborator resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Collaborator resource.
  returns: Nothing
supported operation: Replaces the Collaborator resource.
  type: Operation
  type: ReplaceAction
  expects: Collaborator
  method: PUT
  title: Replaces the Collaborator resource.
  returns: Nothing
supported operation: Updates the Collaborator resource.
  type: Operation
  expects: Collaborator
  method: PATCH
  title: Updates the Collaborator resource.
  returns: Nothing
supported operation: Retrieves a Collaborator resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Collaborator resource.
  returns: Collaborator
supported operation: Updates the Collaborator resource.
  type: Operation
  expects: Collaborator
  method: PATCH
  title: Updates the Collaborator resource.
  returns: Collaborator
supported operation: Updates the Collaborator resource.
  type: Operation
  expects: Collaborator
  method: PATCH
  title: Updates the Collaborator resource.
  returns: Collaborator

email
type: Property
domain: Collaborator
range: string

roles
type: Property
domain: Collaborator
range: string

password
type: Property
domain: Collaborator
range: string

nid
type: Property
domain: Collaborator
range: string

firstname
type: Property
domain: Collaborator
range: string

lastname
type: Property
domain: Collaborator
range: string

phone
type: Property
domain: Collaborator
range: string

isActive
type: Property
domain: Collaborator
range: boolean

activationToken
type: Property
domain: Collaborator
range: string

forgotPasswordToken
type: Property
domain: Collaborator
range: string

googleId
type: Property
domain: Collaborator
range: string

createdAt
type: Property
domain: Collaborator
range: dateTime

activationEmailSentAt
type: Property
domain: Collaborator
range: dateTime

archivedAt
type: Property
domain: Collaborator
range: dateTime

avatar
type: Property
domain: Collaborator
range: string

userIdentifier
type: Property
domain: Collaborator
range: string

Customer
type: Class
title: Customer
supported property: SupportedProperty
  property: dateOfBirth
  title: dateOfBirth
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: residence
  title: residence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: idType
  title: idType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: idNumber
  title: idNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isRwandan
  title: isRwandan
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasProperty
  title: hasProperty
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactions
  title: transactions
  required: false
  readable: true
  writeable: false
  description: populated by CustomerTransactionsProvider, not persisted
supported property: SupportedProperty
  property: idDocument
  title: idDocument
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: prospectProfile
  title: prospectProfile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: prospectProjects
  title: prospectProjects
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: prospectProfileCompleted
  title: prospectProfileCompleted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: prospectProfileLastSubmittedAt
  title: prospectProfileLastSubmittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nid
  title: nid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activationToken
  title: activationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: forgotPasswordToken
  title: forgotPasswordToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: googleId
  title: googleId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activationEmailSentAt
  title: activationEmailSentAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: archivedAt
  title: archivedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
  description: A visual identifier that represents this user.
supported operation: Retrieves a Customer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Customer resource.
  returns: Customer
supported operation: Retrieves a Customer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Customer resource.
  returns: Customer
supported operation: Retrieves a Customer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Customer resource.
  returns: Customer
supported operation: Updates the Customer resource.
  type: Operation
  expects: Customer
  method: PATCH
  title: Updates the Customer resource.
  returns: Customer
supported operation: Updates the Customer resource.
  type: Operation
  expects: Customer
  method: PATCH
  title: Updates the Customer resource.
  returns: Customer
supported operation: Replaces the Customer resource.
supported operation: Deletes the Customer resource.

dateOfBirth
type: Property
domain: Customer
range: dateTime

residence
type: Property
domain: Customer
range: string

idType
type: Property
domain: Customer
range: string

idNumber
type: Property
domain: Customer
range: string

isRwandan
type: Property
domain: Customer
range: boolean

hasProperty
type: Property
domain: Customer
range: boolean

transactions
type: Property
domain: Customer

idDocument
type: Property
domain: Customer
range: string

prospectProfile
type: Property
domain: Customer

prospectProjects
type: Property
domain: Customer

prospectProfileCompleted
type: Property
domain: Customer
range: boolean

prospectProfileLastSubmittedAt
type: Property
domain: Customer
range: dateTime

email
type: Property
domain: Customer
range: string

roles
type: Property
domain: Customer
range: string

password
type: Property
domain: Customer
range: string

nid
type: Property
domain: Customer
range: string

firstname
type: Property
domain: Customer
range: string

lastname
type: Property
domain: Customer
range: string

phone
type: Property
domain: Customer
range: string

isActive
type: Property
domain: Customer
range: boolean

activationToken
type: Property
domain: Customer
range: string

forgotPasswordToken
type: Property
domain: Customer
range: string

googleId
type: Property
domain: Customer
range: string

createdAt
type: Property
domain: Customer
range: dateTime

activationEmailSentAt
type: Property
domain: Customer
range: dateTime

archivedAt
type: Property
domain: Customer
range: dateTime

avatar
type: Property
domain: Customer
range: string

userIdentifier
type: Property
domain: Customer
range: string

Disbursement
type: Class
title: Disbursement
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionId
  title: transactionId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionRefNumber
  title: transactionRefNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lines
  title: lines
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Disbursement resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Disbursement resource.
  returns: Disbursement
supported operation: Retrieves a Disbursement resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Disbursement resource.
  returns: Disbursement

id
type: Property
domain: Disbursement

transactionId
type: Property
domain: Disbursement

transactionRefNumber
type: Property
domain: Disbursement
range: string

status
type: Property
domain: Disbursement
range: string

createdAt
type: Property
domain: Disbursement
range: dateTime

updatedAt
type: Property
domain: Disbursement
range: dateTime

lines
type: Link
domain: Disbursement
range: DisbursementLine

DisbursementLine
type: Class
title: DisbursementLine
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: disbursement
  title: disbursement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: beneficiaryType
  title: beneficiaryType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: beneficiaryLabel
  title: beneficiaryLabel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rate
  title: rate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: amount
  title: amount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isManual
  title: isManual
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isKireziExpense
  title: isKireziExpense
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isCreditNote
  title: isCreditNote
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isInitial
  title: isInitial
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paymentProof
  title: paymentProof
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paidAt
  title: paidAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sortOrder
  title: sortOrder
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a DisbursementLine resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DisbursementLine resource.
  returns: Nothing
supported operation: Updates the DisbursementLine resource.
  type: Operation
  expects: DisbursementLine
  method: PATCH
  title: Updates the DisbursementLine resource.
  returns: Nothing
supported operation: Deletes the DisbursementLine resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the DisbursementLine resource.
  returns: Nothing

id
type: Property
domain: DisbursementLine

disbursement
type: Link
domain: DisbursementLine
max cardinality: 1
range: Disbursement

label
type: Property
domain: DisbursementLine
range: string

beneficiaryType
type: Property
domain: DisbursementLine
range: string

beneficiaryLabel
type: Property
domain: DisbursementLine
range: string

rate
type: Property
domain: DisbursementLine
range: decimal

amount
type: Property
domain: DisbursementLine
range: integer

status
type: Property
domain: DisbursementLine
range: string

isManual
type: Property
domain: DisbursementLine
range: boolean

isKireziExpense
type: Property
domain: DisbursementLine
range: boolean

isCreditNote
type: Property
domain: DisbursementLine
range: boolean

isInitial
type: Property
domain: DisbursementLine
range: boolean

paymentProof
type: Property
domain: DisbursementLine
range: string

paidAt
type: Property
domain: DisbursementLine
range: dateTime

notes
type: Property
domain: DisbursementLine
range: string

sortOrder
type: Property
domain: DisbursementLine
range: integer

DisbursementLineTemplate
type: Class
title: DisbursementLineTemplate
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: valueType
  title: valueType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: beneficiaryType
  title: beneficiaryType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: beneficiaryLabel
  title: beneficiaryLabel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owedBy
  title: owedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isAutoAdded
  title: isAutoAdded
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sortOrder
  title: sortOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a DisbursementLineTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DisbursementLineTemplate resource.
  returns: DisbursementLineTemplate
supported operation: Updates the DisbursementLineTemplate resource.
  type: Operation
  expects: DisbursementLineTemplate
  method: PATCH
  title: Updates the DisbursementLineTemplate resource.
  returns: DisbursementLineTemplate
supported operation: Deletes the DisbursementLineTemplate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the DisbursementLineTemplate resource.
  returns: Nothing

id
type: Property
domain: DisbursementLineTemplate

label
type: Property
domain: DisbursementLineTemplate
range: string

valueType
type: Property
domain: DisbursementLineTemplate
range: string

value
type: Property
domain: DisbursementLineTemplate
range: decimal

beneficiaryType
type: Property
domain: DisbursementLineTemplate
range: string

beneficiaryLabel
type: Property
domain: DisbursementLineTemplate
range: string

owedBy
type: Property
domain: DisbursementLineTemplate
range: string

isActive
type: Property
domain: DisbursementLineTemplate
range: boolean

isAutoAdded
type: Property
domain: DisbursementLineTemplate
range: boolean

sortOrder
type: Property
domain: DisbursementLineTemplate
range: integer

createdAt
type: Property
domain: DisbursementLineTemplate
range: dateTime

updatedAt
type: Property
domain: DisbursementLineTemplate
range: dateTime

Owner
type: Class
title: Owner
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nid
  title: nid
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: parts
  title: parts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Owner resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Owner resource.
  returns: Owner
supported operation: Updates the Owner resource.
  type: Operation
  expects: Owner
  method: PATCH
  title: Updates the Owner resource.
  returns: Owner
supported operation: Deletes the Owner resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Owner resource.
  returns: Nothing

firstname
type: Property
domain: Owner
range: string

lastname
type: Property
domain: Owner
range: string

nid
type: Property
domain: Owner
range: string

parts
type: Property
domain: Owner
range: decimal

phone
type: Property
domain: Owner
range: string

email
type: Property
domain: Owner
range: string

Localization
type: Class
title: Localization
supported property: SupportedProperty
  property: province
  title: province
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: district
  title: district
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sector
  title: sector
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cell
  title: cell
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: village
  title: village
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: properties
  title: properties
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Localization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Localization resource.
  returns: Localization
supported operation: Updates the Localization resource.
  type: Operation
  expects: Localization
  method: PATCH
  title: Updates the Localization resource.
  returns: Localization
supported operation: Deletes the Localization resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Localization resource.
  returns: Nothing

province
type: Property
domain: Localization
range: string

district
type: Property
domain: Localization
range: string

sector
type: Property
domain: Localization
range: string

cell
type: Property
domain: Localization
range: string

village
type: Property
domain: Localization
range: string

properties
type: Link
domain: Localization
range: Property

Property
type: Class
title: Property
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upi
  title: upi
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyTitle
  title: propertyTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localization
  title: localization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Property resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Property resource.
  returns: Property
supported operation: Updates the Property resource.
  type: Operation
  expects: Property
  method: PATCH
  title: Updates the Property resource.
  returns: Property
supported operation: Deletes the Property resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Property resource.
  returns: Nothing

type
type: Property
domain: Property
range: string

upi
type: Property
domain: Property
range: string

propertyTitle
type: Property
domain: Property
range: string

localization
type: Link
domain: Property
max cardinality: 1
range: Localization

status
type: Property
domain: Property
range: string

ProspectProjectAdminRead
type: Class
title: ProspectProjectAdminRead
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerId
  title: customerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerFirstName
  title: customerFirstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerLastName
  title: customerLastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerFullName
  title: customerFullName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerEmail
  title: customerEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerPhone
  title: customerPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerCountryOfResidence
  title: customerCountryOfResidence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countryOfResidence
  title: countryOfResidence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: projectType
  title: projectType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: actorType
  title: actorType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: preferredLocations
  title: preferredLocations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyTypes
  title: propertyTypes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: budgets
  title: budgets
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: financingMode
  title: financingMode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: details
  title: details
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdOnBehalfOfCustomer
  title: createdOnBehalfOfCustomer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: internalStatus
  title: internalStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorId
  title: assignedCollaboratorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorName
  title: assignedCollaboratorName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaborator
  title: assignedCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: internalNotes
  title: internalNotes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: internalNotesText
  title: internalNotesText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timeline
  title: timeline
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedAt
  title: submittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactedAt
  title: contactedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: archivedAt
  title: archivedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: version
  title: version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: streamVersion
  title: streamVersion
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProspectProjectAdminRead resource.
supported operation: Replaces the ProspectProjectAdminRead resource.
supported operation: Updates the ProspectProjectAdminRead resource.

id
type: Property
domain: ProspectProjectAdminRead

customerId
type: Property
domain: ProspectProjectAdminRead

customerFirstName
type: Property
domain: ProspectProjectAdminRead
range: string

customerLastName
type: Property
domain: ProspectProjectAdminRead
range: string

customerFullName
type: Property
domain: ProspectProjectAdminRead
range: string

customerEmail
type: Property
domain: ProspectProjectAdminRead
range: string

customerPhone
type: Property
domain: ProspectProjectAdminRead
range: string

customerCountryOfResidence
type: Property
domain: ProspectProjectAdminRead
range: string

countryOfResidence
type: Property
domain: ProspectProjectAdminRead
range: string

projectType
type: Property
domain: ProspectProjectAdminRead
range: string

actorType
type: Property
domain: ProspectProjectAdminRead
range: string

preferredLocations
type: Property
domain: ProspectProjectAdminRead
range: string

propertyTypes
type: Property
domain: ProspectProjectAdminRead

budgets
type: Property
domain: ProspectProjectAdminRead

financingMode
type: Property
domain: ProspectProjectAdminRead
range: string

notes
type: Property
domain: ProspectProjectAdminRead
range: string

details
type: Property
domain: ProspectProjectAdminRead

source
type: Property
domain: ProspectProjectAdminRead
range: string

createdOnBehalfOfCustomer
type: Property
domain: ProspectProjectAdminRead
range: boolean

internalStatus
type: Property
domain: ProspectProjectAdminRead
range: string

assignedCollaboratorId
type: Property
domain: ProspectProjectAdminRead

assignedCollaboratorName
type: Property
domain: ProspectProjectAdminRead
range: string

assignedCollaborator
type: Property
domain: ProspectProjectAdminRead

internalNotes
type: Property
domain: ProspectProjectAdminRead

internalNotesText
type: Property
domain: ProspectProjectAdminRead
range: string

timeline
type: Property
domain: ProspectProjectAdminRead

createdAt
type: Property
domain: ProspectProjectAdminRead
range: dateTime

updatedAt
type: Property
domain: ProspectProjectAdminRead
range: dateTime

submittedAt
type: Property
domain: ProspectProjectAdminRead
range: dateTime

contactedAt
type: Property
domain: ProspectProjectAdminRead
range: dateTime

archivedAt
type: Property
domain: ProspectProjectAdminRead
range: dateTime

version
type: Property
domain: ProspectProjectAdminRead
range: integer

streamVersion
type: Property
domain: ProspectProjectAdminRead
range: integer

minBudgetAmount
type: Property
domain: ProspectProjectAdminRead
range: decimal

maxBudgetAmount
type: Property
domain: ProspectProjectAdminRead
range: decimal

Photo
type: Class
title: Photo
supported property: SupportedProperty
  property: src
  title: src
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publication
  title: publication
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Photo resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Photo resource.
  returns: Nothing
supported operation: Deletes the Photo resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Photo resource.
  returns: Nothing

src
type: Property
domain: Photo
range: string

publication
type: Link
domain: Photo
max cardinality: 1
range: Publication

Publication
type: Class
title: Publication
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyId
  title: propertyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertySnapshot
  title: propertySnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: negotiator
  title: negotiator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorId
  title: assignedCollaboratorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorSnapshot
  title: assignedCollaboratorSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalBrokerId
  title: externalBrokerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalBrokerSnapshot
  title: externalBrokerSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedByCollaboratorId
  title: submittedByCollaboratorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedByCollaboratorSnapshot
  title: submittedByCollaboratorSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verificationStatus
  title: verificationStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isLandTitleAuthentic
  title: isLandTitleAuthentic
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landInfosDoc
  title: landInfosDoc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: masterPlanInfos
  title: masterPlanInfos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isNotMortgaged
  title: isNotMortgaged
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasNotCaveat
  title: hasNotCaveat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verifiedAt
  title: verifiedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: requestForReverify
  title: requestForReverify
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreement
  title: agreement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isPublished
  title: isPublished
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isBlocked
  title: isBlocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: livingSpace
  title: livingSpace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landSurface
  title: landSurface
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: longitude
  title: longitude
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: latitude
  title: latitude
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landUse
  title: landUse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: livingRoom
  title: livingRoom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: kitchen
  title: kitchen
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: room
  title: room
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bathroom
  title: bathroom
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Publication resource.
supported operation: Updates the Publication resource.

id
type: Property
domain: Publication

status
type: Property
domain: Publication
range: string

createdAt
type: Property
domain: Publication
range: dateTime

updatedAt
type: Property
domain: Publication
range: dateTime

propertyId
type: Property
domain: Publication

propertySnapshot
type: Property
domain: Publication

negotiator
type: Property
domain: Publication

assignedCollaboratorId
type: Property
domain: Publication

assignedCollaboratorSnapshot
type: Property
domain: Publication

externalBrokerId
type: Property
domain: Publication

externalBrokerSnapshot
type: Property
domain: Publication

submittedByCollaboratorId
type: Property
domain: Publication

submittedByCollaboratorSnapshot
type: Property
domain: Publication

verificationStatus
type: Property
domain: Publication
range: string

isLandTitleAuthentic
type: Property
domain: Publication
range: boolean

landInfosDoc
type: Property
domain: Publication
range: string

masterPlanInfos
type: Property
domain: Publication
range: string

isNotMortgaged
type: Property
domain: Publication
range: boolean

hasNotCaveat
type: Property
domain: Publication
range: boolean

verifiedAt
type: Property
domain: Publication
range: dateTime

requestForReverify
type: Property
domain: Publication
range: boolean

agreement
type: Link
domain: Publication
max cardinality: 1
range: Agreement

isPublished
type: Property
domain: Publication
range: boolean

isBlocked
type: Property
domain: Publication
range: boolean

livingSpace
type: Property
domain: Publication
range: integer

landSurface
type: Property
domain: Publication
range: integer

longitude
type: Property
domain: Publication
range: decimal

latitude
type: Property
domain: Publication
range: decimal

landUse
type: Property
domain: Publication
range: string

livingRoom
type: Property
domain: Publication
range: integer

kitchen
type: Property
domain: Publication
range: integer

room
type: Property
domain: Publication
range: integer

bathroom
type: Property
domain: Publication
range: integer

annex
type: Property
domain: Publication
range: integer

soldAt
type: Property
domain: Publication
range: dateTime

soldNote
type: Property
domain: Publication
range: string

soldProof
type: Property
domain: Publication
range: string

priorityCustomerId
type: Property
domain: Publication
range: string

priorityWindowExpiresAt
type: Property
domain: Publication
range: dateTime

amenities
type: Property
domain: Publication

photos
type: Link
domain: Publication
range: Photo

publishedPrice
type: Property
domain: Publication
range: integer

feeStructure
type: Property
domain: Publication

title
type: Property
domain: Publication
range: string

pendingImpacts
type: Property
domain: Publication

maxStepReached
type: Property
domain: Publication
range: integer

referenceSnapshot
type: Property
domain: Publication

submittedAt
type: Property
domain: Publication
range: dateTime

transactions
type: Property
domain: Publication

property
type: Property
domain: Publication

propertyOwners
type: Property
domain: Publication

assignedCollaborator
type: Property
domain: Publication

buyerTotalPrice
type: Property
domain: Publication
range: integer

transactionCount
type: Property
domain: Publication
range: integer

externalBrokerEmail
type: Property
domain: Publication
range: string

externalBroker
type: Property
domain: Publication

submittedByCollaborator
type: Property
domain: Publication

PublicationAdminDetailRead
type: Class
title: PublicationAdminDetailRead
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedAt
  title: submittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: property
  title: property
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: negotiator
  title: negotiator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalBroker
  title: externalBroker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaborator
  title: assignedCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedByCollaborator
  title: submittedByCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreement
  title: agreement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verification
  title: verification
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verificationStatus
  title: verificationStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isLandTitleAuthentic
  title: isLandTitleAuthentic
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isNotMortgaged
  title: isNotMortgaged
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasNotCaveat
  title: hasNotCaveat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landInfosDoc
  title: landInfosDoc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: masterPlanInfos
  title: masterPlanInfos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: amenities
  title: amenities
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: photos
  title: photos
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isPublished
  title: isPublished
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isBlocked
  title: isBlocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landUse
  title: landUse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: livingSpace
  title: livingSpace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landSurface
  title: landSurface
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: livingRoom
  title: livingRoom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: room
  title: room
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: kitchen
  title: kitchen
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bathroom
  title: bathroom
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: annex
  title: annex
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactions
  title: transactions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionCount
  title: transactionCount
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PublicationAdminDetailRead resource.

id
type: Property
domain: PublicationAdminDetailRead

status
type: Property
domain: PublicationAdminDetailRead
range: string

title
type: Property
domain: PublicationAdminDetailRead
range: string

createdAt
type: Property
domain: PublicationAdminDetailRead
range: dateTime

updatedAt
type: Property
domain: PublicationAdminDetailRead
range: dateTime

submittedAt
type: Property
domain: PublicationAdminDetailRead
range: dateTime

property
type: Property
domain: PublicationAdminDetailRead

negotiator
type: Property
domain: PublicationAdminDetailRead

externalBroker
type: Property
domain: PublicationAdminDetailRead

assignedCollaborator
type: Property
domain: PublicationAdminDetailRead

submittedByCollaborator
type: Property
domain: PublicationAdminDetailRead

agreement
type: Property
domain: PublicationAdminDetailRead

verification
type: Property
domain: PublicationAdminDetailRead

verificationStatus
type: Property
domain: PublicationAdminDetailRead
range: string

isLandTitleAuthentic
type: Property
domain: PublicationAdminDetailRead
range: boolean

isNotMortgaged
type: Property
domain: PublicationAdminDetailRead
range: boolean

hasNotCaveat
type: Property
domain: PublicationAdminDetailRead
range: boolean

landInfosDoc
type: Property
domain: PublicationAdminDetailRead
range: string

masterPlanInfos
type: Property
domain: PublicationAdminDetailRead
range: string

amenities
type: Property
domain: PublicationAdminDetailRead

photos
type: Property
domain: PublicationAdminDetailRead

isPublished
type: Property
domain: PublicationAdminDetailRead
range: boolean

isBlocked
type: Property
domain: PublicationAdminDetailRead
range: boolean

landUse
type: Property
domain: PublicationAdminDetailRead
range: string

livingSpace
type: Property
domain: PublicationAdminDetailRead
range: integer

landSurface
type: Property
domain: PublicationAdminDetailRead
range: integer

livingRoom
type: Property
domain: PublicationAdminDetailRead
range: integer

room
type: Property
domain: PublicationAdminDetailRead
range: integer

kitchen
type: Property
domain: PublicationAdminDetailRead
range: integer

bathroom
type: Property
domain: PublicationAdminDetailRead
range: integer

annex
type: Property
domain: PublicationAdminDetailRead
range: integer

transactions
type: Property
domain: PublicationAdminDetailRead

transactionCount
type: Property
domain: PublicationAdminDetailRead
range: integer

publishedPrice
type: Property
domain: PublicationAdminDetailRead
range: integer

buyerTotalPrice
type: Property
domain: PublicationAdminDetailRead
range: integer

feeStructure
type: Property
domain: PublicationAdminDetailRead

pendingImpacts
type: Property
domain: PublicationAdminDetailRead

maxStepReached
type: Property
domain: PublicationAdminDetailRead
range: integer

customersInLine
type: Property
domain: PublicationAdminDetailRead

customersInLineCount
type: Property
domain: PublicationAdminDetailRead
range: integer

priorityCustomerId
type: Property
domain: PublicationAdminDetailRead
range: string

priorityWindowExpiresAt
type: Property
domain: PublicationAdminDetailRead
range: dateTime

PublicationAdminListRead
type: Class
title: PublicationAdminListRead
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusOrder
  title: statusOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedAt
  title: submittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyType
  title: propertyType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyUpi
  title: propertyUpi
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyProvince
  title: propertyProvince
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyDistrict
  title: propertyDistrict
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertySector
  title: propertySector
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyCell
  title: propertyCell
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyVillage
  title: propertyVillage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreementContractRef
  title: agreementContractRef
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: property
  title: property
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: negotiator
  title: negotiator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalBroker
  title: externalBroker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorId
  title: assignedCollaboratorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaborator
  title: assignedCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedByCollaborator
  title: submittedByCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreement
  title: agreement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionCount
  title: transactionCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buyerTotalPrice
  title: buyerTotalPrice
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PublicationAdminListRead resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PublicationAdminListRead resource.
  returns: Nothing

id
type: Property
domain: PublicationAdminListRead

status
type: Property
domain: PublicationAdminListRead
range: string

statusOrder
type: Property
domain: PublicationAdminListRead
range: integer

title
type: Property
domain: PublicationAdminListRead
range: string

createdAt
type: Property
domain: PublicationAdminListRead
range: dateTime

updatedAt
type: Property
domain: PublicationAdminListRead
range: dateTime

submittedAt
type: Property
domain: PublicationAdminListRead
range: dateTime

propertyType
type: Property
domain: PublicationAdminListRead
range: string

propertyUpi
type: Property
domain: PublicationAdminListRead
range: string

propertyProvince
type: Property
domain: PublicationAdminListRead
range: string

propertyDistrict
type: Property
domain: PublicationAdminListRead
range: string

propertySector
type: Property
domain: PublicationAdminListRead
range: string

propertyCell
type: Property
domain: PublicationAdminListRead
range: string

propertyVillage
type: Property
domain: PublicationAdminListRead
range: string

agreementContractRef
type: Property
domain: PublicationAdminListRead
range: string

property
type: Property
domain: PublicationAdminListRead

negotiator
type: Property
domain: PublicationAdminListRead

externalBroker
type: Property
domain: PublicationAdminListRead

assignedCollaboratorId
type: Property
domain: PublicationAdminListRead

assignedCollaborator
type: Property
domain: PublicationAdminListRead

submittedByCollaborator
type: Property
domain: PublicationAdminListRead

agreement
type: Property
domain: PublicationAdminListRead

transactionCount
type: Property
domain: PublicationAdminListRead
range: integer

buyerTotalPrice
type: Property
domain: PublicationAdminListRead
range: integer

PublicationDetailsRead
type: Class
title: PublicationDetailsRead
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusCode
  title: statusCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusClass
  title: statusClass
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedAt
  title: submittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: property
  title: property
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: negotiator
  title: negotiator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalBroker
  title: externalBroker
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaborator
  title: assignedCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedByCollaborator
  title: submittedByCollaborator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verification
  title: verification
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreement
  title: agreement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishDetails
  title: publishDetails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactions
  title: transactions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transaction
  title: transaction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customersInLine
  title: customersInLine
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishedPrice
  title: publishedPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buyerTotalPrice
  title: buyerTotalPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priorityCustomerId
  title: priorityCustomerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priorityWindowExpiresAt
  title: priorityWindowExpiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customersInLineCount
  title: customersInLineCount
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PublicationDetailsRead resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PublicationDetailsRead resource.
  returns: PublicationDetailsRead

id
type: Property
domain: PublicationDetailsRead

status
type: Property
domain: PublicationDetailsRead
range: string

statusCode
type: Property
domain: PublicationDetailsRead
range: string

statusClass
type: Property
domain: PublicationDetailsRead
range: string

title
type: Property
domain: PublicationDetailsRead
range: string

createdAt
type: Property
domain: PublicationDetailsRead
range: dateTime

updatedAt
type: Property
domain: PublicationDetailsRead
range: dateTime

submittedAt
type: Property
domain: PublicationDetailsRead
range: dateTime

property
type: Property
domain: PublicationDetailsRead

negotiator
type: Property
domain: PublicationDetailsRead

externalBroker
type: Property
domain: PublicationDetailsRead

assignedCollaborator
type: Property
domain: PublicationDetailsRead

submittedByCollaborator
type: Property
domain: PublicationDetailsRead

verification
type: Property
domain: PublicationDetailsRead

agreement
type: Property
domain: PublicationDetailsRead

publishDetails
type: Property
domain: PublicationDetailsRead

transactions
type: Property
domain: PublicationDetailsRead

transaction
type: Property
domain: PublicationDetailsRead

customersInLine
type: Property
domain: PublicationDetailsRead

publishedPrice
type: Property
domain: PublicationDetailsRead
range: integer

buyerTotalPrice
type: Property
domain: PublicationDetailsRead
range: integer

priorityCustomerId
type: Property
domain: PublicationDetailsRead
range: string

priorityWindowExpiresAt
type: Property
domain: PublicationDetailsRead
range: dateTime

customersInLineCount
type: Property
domain: PublicationDetailsRead
range: integer

PublicationPublicListRead
type: Class
title: PublicationPublicListRead
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusOrder
  title: statusOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusCode
  title: statusCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusClass
  title: statusClass
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: submittedAt
  title: submittedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyType
  title: propertyType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyProvince
  title: propertyProvince
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyDistrict
  title: propertyDistrict
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertySector
  title: propertySector
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyCell
  title: propertyCell
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: propertyVillage
  title: propertyVillage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishIsPublished
  title: publishIsPublished
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishNetPrice
  title: publishNetPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishLandUse
  title: publishLandUse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: amenityNames
  title: amenityNames
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: property
  title: property
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishDetails
  title: publishDetails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactions
  title: transactions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transaction
  title: transaction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customersInLine
  title: customersInLine
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishedPrice
  title: publishedPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buyerTotalPrice
  title: buyerTotalPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priorityCustomerId
  title: priorityCustomerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priorityWindowExpiresAt
  title: priorityWindowExpiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customersInLineCount
  title: customersInLineCount
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PublicationPublicListRead resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PublicationPublicListRead resource.
  returns: Nothing

id
type: Property
domain: PublicationPublicListRead

status
type: Property
domain: PublicationPublicListRead
range: string

statusOrder
type: Property
domain: PublicationPublicListRead
range: integer

statusCode
type: Property
domain: PublicationPublicListRead
range: string

statusClass
type: Property
domain: PublicationPublicListRead
range: string

title
type: Property
domain: PublicationPublicListRead
range: string

createdAt
type: Property
domain: PublicationPublicListRead
range: dateTime

submittedAt
type: Property
domain: PublicationPublicListRead
range: dateTime

propertyType
type: Property
domain: PublicationPublicListRead
range: string

propertyProvince
type: Property
domain: PublicationPublicListRead
range: string

propertyDistrict
type: Property
domain: PublicationPublicListRead
range: string

propertySector
type: Property
domain: PublicationPublicListRead
range: string

propertyCell
type: Property
domain: PublicationPublicListRead
range: string

propertyVillage
type: Property
domain: PublicationPublicListRead
range: string

publishIsPublished
type: Property
domain: PublicationPublicListRead
range: boolean

publishNetPrice
type: Property
domain: PublicationPublicListRead
range: integer

publishLandUse
type: Property
domain: PublicationPublicListRead
range: string

amenityNames
type: Property
domain: PublicationPublicListRead
range: string

property
type: Property
domain: PublicationPublicListRead

publishDetails
type: Property
domain: PublicationPublicListRead

transactions
type: Property
domain: PublicationPublicListRead

transaction
type: Property
domain: PublicationPublicListRead

customersInLine
type: Property
domain: PublicationPublicListRead

publishedPrice
type: Property
domain: PublicationPublicListRead
range: integer

buyerTotalPrice
type: Property
domain: PublicationPublicListRead
range: integer

priorityCustomerId
type: Property
domain: PublicationPublicListRead
range: string

priorityWindowExpiresAt
type: Property
domain: PublicationPublicListRead
range: dateTime

customersInLineCount
type: Property
domain: PublicationPublicListRead
range: integer

Agreement
type: Class
title: Agreement
supported property: SupportedProperty
  property: date
  title: date
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractRef
  title: contractRef
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractVersionRef
  title: contractVersionRef
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signatureType
  title: signatureType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sellerCharges
  title: sellerCharges
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isAgreementAccepted
  title: isAgreementAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractPDF
  title: contractPDF
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signatureTokenHash
  title: signatureTokenHash
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signatureTokenExpiresAt
  title: signatureTokenExpiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: feeStructure
  title: feeStructure
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contractLanguage
  title: contractLanguage
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Agreement resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Agreement resource.
  returns: Nothing
supported operation: Updates the Agreement resource.
  type: Operation
  expects: Agreement
  method: PATCH
  title: Updates the Agreement resource.
  returns: Agreement
supported operation: Updates the Agreement resource.
  type: Operation
  expects: Agreement
  method: PATCH
  title: Updates the Agreement resource.
  returns: Agreement

date
type: Property
domain: Agreement
range: dateTime

contractRef
type: Property
domain: Agreement
range: string

contractVersionRef
type: Property
domain: Agreement
range: string

signatureType
type: Property
domain: Agreement
range: string

sellerCharges
type: Property
domain: Agreement
range: decimal

isAgreementAccepted
type: Property
domain: Agreement
range: boolean

status
type: Property
domain: Agreement
range: string

contractPDF
type: Property
domain: Agreement
range: string

signatureTokenHash
type: Property
domain: Agreement
range: string

signatureTokenExpiresAt
type: Property
domain: Agreement
range: dateTime

feeStructure
type: Property
domain: Agreement

contractLanguage
type: Property
domain: Agreement
range: string

NotarySignature
type: Class
title: NotarySignature
supported property: SupportedProperty
  property: dateSignature
  title: dateSignature
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: src
  title: src
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transaction
  title: transaction
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a NotarySignature resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a NotarySignature resource.
  returns: Nothing

dateSignature
type: Property
domain: NotarySignature
range: dateTime

src
type: Property
domain: NotarySignature
range: string

status
type: Property
domain: NotarySignature
range: string

transaction
type: Link
domain: NotarySignature
max cardinality: 1
range: Transaction

Payment
type: Class
title: Payment
supported property: SupportedProperty
  property: date
  title: date
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paymentProof
  title: paymentProof
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transaction
  title: transaction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: receptionProof
  title: receptionProof
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bankTransactionNumber
  title: bankTransactionNumber
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Payment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Payment resource.
  returns: Nothing
supported operation: Updates the Payment resource.
  type: Operation
  expects: Payment
  method: PATCH
  title: Updates the Payment resource.
  returns: Payment

date
type: Property
domain: Payment
range: dateTime

status
type: Property
domain: Payment
range: string

paymentProof
type: Property
domain: Payment
range: string

transaction
type: Link
domain: Payment
max cardinality: 1
range: Transaction

receptionProof
type: Property
domain: Payment
range: string

bankTransactionNumber
type: Property
domain: Payment
range: string

Transaction
type: Class
title: Transaction
supported property: SupportedProperty
  property: buyerId
  title: buyerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buyerSnapshot
  title: buyerSnapshot
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: publicationId
  title: publicationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publicationSnapshot
  title: publicationSnapshot
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agreement
  title: agreement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: payment
  title: payment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refNumber
  title: refNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notarySignature
  title: notarySignature
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sellerPayment
  title: sellerPayment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nlaProcess
  title: nlaProcess
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: landTitle
  title: landTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorId
  title: assignedCollaboratorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assignedCollaboratorSnapshot
  title: assignedCollaboratorSnapshot
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: archiveReason
  title: archiveReason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cancelReason
  title: cancelReason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pendingImpacts
  title: pendingImpacts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: referenceSnapshot
  title: referenceSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: maxStepReached
  title: maxStepReached
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: buyer
  title: buyer
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: buyer
  title: buyer
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: buyer
  title: buyer
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publication
  title: publication
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: publication
  title: publication
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: assignedCollaborator
  title: assignedCollaborator
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Transaction resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Transaction resource.
  returns: Transaction
supported operation: Updates the Transaction resource.
  type: Operation
  expects: Transaction
  method: PATCH
  title: Updates the Transaction resource.
  returns: Transaction
supported operation: Updates the Transaction resource.
  type: Operation
  expects: Transaction
  method: PATCH
  title: Updates the Transaction resource.
  returns: Transaction
supported operation: Updates the Transaction resource.
  type: Operation
  expects: Transaction
  method: PATCH
  title: Updates the Transaction resource.
  returns: Transaction
supported operation: Updates the Transaction resource.
  type: Operation
  expects: Transaction
  method: PATCH
  title: Updates the Transaction resource.
  returns: Transaction
supported operation: Deletes the Transaction resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Transaction resource.
  returns: Nothing

buyerId
type: Property
domain: Transaction

buyerSnapshot
type: Property
domain: Transaction

publicationId
type: Property
domain: Transaction

publicationSnapshot
type: Property
domain: Transaction

status
type: Property
domain: Transaction
range: string

agreement
type: Link
domain: Transaction
max cardinality: 1
range: Agreement

payment
type: Link
domain: Transaction
max cardinality: 1
range: Payment

refNumber
type: Property
domain: Transaction
range: string

notarySignature
type: Link
domain: Transaction
max cardinality: 1
range: NotarySignature

sellerPayment
type: Property
domain: Transaction

nlaProcess
type: Property
domain: Transaction

landTitle
type: Property
domain: Transaction

assignedCollaboratorId
type: Property
domain: Transaction

assignedCollaboratorSnapshot
type: Property
domain: Transaction

archiveReason
type: Property
domain: Transaction
range: string

cancelReason
type: Property
domain: Transaction
range: string

deletedAt
type: Property
domain: Transaction
range: dateTime

updatedAt
type: Property
domain: Transaction
range: dateTime

pendingImpacts
type: Property
domain: Transaction

referenceSnapshot
type: Property
domain: Transaction

maxStepReached
type: Property
domain: Transaction
range: integer

buyer
type: Property
domain: Transaction
range: string

publication
type: Property
domain: Transaction
range: string

assignedCollaborator
type: Property
domain: Transaction

KireziTreasury
type: Class
title: KireziTreasury
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: balance
  title: balance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a KireziTreasury resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a KireziTreasury resource.
  returns: KireziTreasury

id
type: Property
domain: KireziTreasury

balance
type: Property
domain: KireziTreasury
range: integer

updatedAt
type: Property
domain: KireziTreasury
range: dateTime

KireziTreasuryMovement
type: Class
title: KireziTreasuryMovement
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: treasury
  title: treasury
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: disbursementLineId
  title: disbursementLineId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionId
  title: transactionId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reversalOfMovementId
  title: reversalOfMovementId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transactionRefNumber
  title: transactionRefNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: amount
  title: amount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a KireziTreasuryMovement resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a KireziTreasuryMovement resource.
  returns: Nothing

id
type: Property
domain: KireziTreasuryMovement

treasury
type: Link
domain: KireziTreasuryMovement
max cardinality: 1
range: KireziTreasury

disbursementLineId
type: Property
domain: KireziTreasuryMovement

transactionId
type: Property
domain: KireziTreasuryMovement

reversalOfMovementId
type: Property
domain: KireziTreasuryMovement

transactionRefNumber
type: Property
domain: KireziTreasuryMovement
range: string

type
type: Property
domain: KireziTreasuryMovement
range: string

amount
type: Property
domain: KireziTreasuryMovement
range: integer

description
type: Property
domain: KireziTreasuryMovement
range: string

createdAt
type: Property
domain: KireziTreasuryMovement
range: dateTime

TreasuryLineTemplate
type: Class
title: TreasuryLineTemplate
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: valueType
  title: valueType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isAutoAdded
  title: isAutoAdded
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sortOrder
  title: sortOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a TreasuryLineTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TreasuryLineTemplate resource.
  returns: TreasuryLineTemplate
supported operation: Updates the TreasuryLineTemplate resource.
  type: Operation
  expects: TreasuryLineTemplate
  method: PATCH
  title: Updates the TreasuryLineTemplate resource.
  returns: TreasuryLineTemplate
supported operation: Deletes the TreasuryLineTemplate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TreasuryLineTemplate resource.
  returns: Nothing

label
type: Property
domain: TreasuryLineTemplate
range: string

type
type: Property
domain: TreasuryLineTemplate
range: string

valueType
type: Property
domain: TreasuryLineTemplate
range: string

value
type: Property
domain: TreasuryLineTemplate
range: decimal

isActive
type: Property
domain: TreasuryLineTemplate
range: boolean

isAutoAdded
type: Property
domain: TreasuryLineTemplate
range: boolean

sortOrder
type: Property
domain: TreasuryLineTemplate
range: integer

createdAt
type: Property
domain: TreasuryLineTemplate
range: dateTime

updatedAt
type: Property
domain: TreasuryLineTemplate
range: dateTime

TreasuryRecord
type: Class
title: TreasuryRecord
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transaction
  title: transaction
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lines
  title: lines
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TreasuryRecord resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TreasuryRecord resource.
  returns: TreasuryRecord
supported operation: Retrieves a TreasuryRecord resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TreasuryRecord resource.
  returns: TreasuryRecord

id
type: Property
domain: TreasuryRecord

transaction
type: Link
domain: TreasuryRecord
max cardinality: 1
range: Transaction

status
type: Property
domain: TreasuryRecord
range: string

createdAt
type: Property
domain: TreasuryRecord
range: dateTime

updatedAt
type: Property
domain: TreasuryRecord
range: dateTime

lines
type: Property
domain: TreasuryRecord

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Broker resources
  title: The collection of Broker resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Collaborator resources
  title: The collection of Collaborator resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Customer resources
  title: The collection of Customer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Disbursement resources
  title: The collection of Disbursement resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DisbursementLine resources
  title: The collection of DisbursementLine resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DisbursementLineTemplate resources
  title: The collection of DisbursementLineTemplate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Owner resources
  title: The collection of Owner resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Localization resources
  title: The collection of Localization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Property resources
  title: The collection of Property resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProspectProjectAdminRead resources
  title: The collection of ProspectProjectAdminRead resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Photo resources
  title: The collection of Photo resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Publication resources
  title: The collection of Publication resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of PublicationAdminListRead resources
  title: The collection of PublicationAdminListRead resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of PublicationPublicListRead resources
  title: The collection of PublicationPublicListRead resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Agreement resources
  title: The collection of Agreement resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of NotarySignature resources
  title: The collection of NotarySignature resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Payment resources
  title: The collection of Payment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Transaction resources
  title: The collection of Transaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of KireziTreasuryMovement resources
  title: The collection of KireziTreasuryMovement resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TreasuryLineTemplate resources
  title: The collection of TreasuryLineTemplate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TreasuryRecord resources
  title: The collection of TreasuryRecord resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Broker resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Broker
supported operation: Retrieves the collection of Broker resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Broker resources.
  returns: Collection
supported operation: Creates a Broker resource.
  type: Operation
  type: CreateAction
  expects: Broker
  method: POST
  title: Creates a Broker resource.
  returns: Broker

The collection of Collaborator resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Collaborator
supported operation: Retrieves the collection of Collaborator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Collaborator resources.
  returns: Collection
supported operation: Retrieves the collection of Collaborator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Collaborator resources.
  returns: Nothing
supported operation: Creates a Collaborator resource.
  type: Operation
  type: CreateAction
  expects: Collaborator
  method: POST
  title: Creates a Collaborator resource.
  returns: Nothing
supported operation: Creates a Collaborator resource.
  type: Operation
  type: CreateAction
  expects: Collaborator
  method: POST
  title: Creates a Collaborator resource.
  returns: Nothing

The collection of Customer resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Customer
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Nothing
supported operation: Retrieves the collection of Customer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Customer resources.
  returns: Collection
supported operation: Retrieves the collection of Customer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Customer resources.
  returns: Collection
supported operation: Retrieves the collection of Customer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Customer resources.
  returns: Collection
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Customer
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Customer
supported operation: Retrieves the collection of Customer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Customer resources.
  returns: Nothing
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Nothing
supported operation: Retrieves the collection of Customer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Customer resources.
  returns: Nothing
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Nothing

The collection of Disbursement resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Disbursement
supported operation: Retrieves the collection of Disbursement resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Disbursement resources.
  returns: Collection
supported operation: Retrieves the collection of Disbursement resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Disbursement resources.
  returns: Collection
supported operation: Creates a Disbursement resource.
  type: Operation
  type: CreateAction
  expects: Disbursement
  method: POST
  title: Creates a Disbursement resource.
  returns: Disbursement
supported operation: Creates a Disbursement resource.
  type: Operation
  type: CreateAction
  expects: Disbursement
  method: POST
  title: Creates a Disbursement resource.
  returns: Nothing

The collection of DisbursementLine resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DisbursementLine
supported operation: Creates a DisbursementLine resource.
  type: Operation
  type: CreateAction
  expects: DisbursementLine
  method: POST
  title: Creates a DisbursementLine resource.
  returns: Nothing

The collection of DisbursementLineTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DisbursementLineTemplate
supported operation: Retrieves the collection of DisbursementLineTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DisbursementLineTemplate resources.
  returns: Collection
supported operation: Creates a DisbursementLineTemplate resource.
  type: Operation
  type: CreateAction
  expects: DisbursementLineTemplate
  method: POST
  title: Creates a DisbursementLineTemplate resource.
  returns: DisbursementLineTemplate

The collection of Owner resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Owner
supported operation: Retrieves the collection of Owner resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Owner resources.
  returns: Collection
supported operation: Creates a Owner resource.
  type: Operation
  type: CreateAction
  expects: Owner
  method: POST
  title: Creates a Owner resource.
  returns: Owner

The collection of Localization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Localization
supported operation: Retrieves the collection of Localization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Localization resources.
  returns: Collection
supported operation: Creates a Localization resource.
  type: Operation
  type: CreateAction
  expects: Localization
  method: POST
  title: Creates a Localization resource.
  returns: Localization

The collection of Property resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Property
supported operation: Retrieves the collection of Property resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Property resources.
  returns: Collection
supported operation: Creates a Property resource.
  type: Operation
  type: CreateAction
  expects: Property
  method: POST
  title: Creates a Property resource.
  returns: Property

The collection of ProspectProjectAdminRead resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProspectProjectAdminRead
supported operation: Retrieves the collection of ProspectProjectAdminRead resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProspectProjectAdminRead resources.
  returns: Nothing
supported operation: Creates a ProspectProjectAdminRead resource.
  type: Operation
  type: CreateAction
  expects: ProspectProjectAdminRead
  method: POST
  title: Creates a ProspectProjectAdminRead resource.
  returns: Nothing
supported operation: Creates a ProspectProjectAdminRead resource.
  type: Operation
  type: CreateAction
  expects: ProspectProjectAdminRead
  method: POST
  title: Creates a ProspectProjectAdminRead resource.
  returns: Nothing

The collection of Photo resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Photo
supported operation: Creates a Photo resource.
  type: Operation
  type: CreateAction
  expects: Photo
  method: POST
  title: Creates a Photo resource.
  returns: Photo

The collection of Publication resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Publication
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Publication
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing
supported operation: Creates a Publication resource.
  type: Operation
  type: CreateAction
  expects: Publication
  method: POST
  title: Creates a Publication resource.
  returns: Nothing

The collection of PublicationAdminListRead resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PublicationAdminListRead
supported operation: Retrieves the collection of PublicationAdminListRead resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of PublicationAdminListRead resources.
  returns: Collection
supported operation: Retrieves the collection of PublicationAdminListRead resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of PublicationAdminListRead resources.
  returns: Collection

The collection of PublicationPublicListRead resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PublicationPublicListRead
supported operation: Retrieves the collection of PublicationPublicListRead resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of PublicationPublicListRead resources.
  returns: Collection
supported operation: Retrieves the collection of PublicationPublicListRead resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of PublicationPublicListRead resources.
  returns: Collection

The collection of Agreement resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Agreement
supported operation: Creates a Agreement resource.
  type: Operation
  type: CreateAction
  expects: Agreement
  method: POST
  title: Creates a Agreement resource.
  returns: Agreement
supported operation: Creates a Agreement resource.
  type: Operation
  type: CreateAction
  expects: Agreement
  method: POST
  title: Creates a Agreement resource.
  returns: Agreement

The collection of NotarySignature resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NotarySignature
supported operation: Creates a NotarySignature resource.
  type: Operation
  type: CreateAction
  expects: NotarySignature
  method: POST
  title: Creates a NotarySignature resource.
  returns: NotarySignature

The collection of Payment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Payment
supported operation: Creates a Payment resource.
  type: Operation
  type: CreateAction
  expects: Payment
  method: POST
  title: Creates a Payment resource.
  returns: Payment

The collection of Transaction resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Transaction
supported operation: Retrieves the collection of Transaction resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Transaction resources.
  returns: Collection
supported operation: Retrieves the collection of Transaction resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Transaction resources.
  returns: Collection
supported operation: Retrieves the collection of Transaction resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Transaction resources.
  returns: Collection
supported operation: Creates a Transaction resource.
  type: Operation
  type: CreateAction
  expects: Transaction
  method: POST
  title: Creates a Transaction resource.
  returns: Transaction
supported operation: Creates a Transaction resource.
  type: Operation
  type: CreateAction
  expects: Transaction
  method: POST
  title: Creates a Transaction resource.
  returns: Transaction

The collection of KireziTreasuryMovement resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: KireziTreasuryMovement
supported operation: Retrieves the collection of KireziTreasuryMovement resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of KireziTreasuryMovement resources.
  returns: Collection

The collection of TreasuryLineTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TreasuryLineTemplate
supported operation: Retrieves the collection of TreasuryLineTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TreasuryLineTemplate resources.
  returns: Collection
supported operation: Creates a TreasuryLineTemplate resource.
  type: Operation
  type: CreateAction
  expects: TreasuryLineTemplate
  method: POST
  title: Creates a TreasuryLineTemplate resource.
  returns: TreasuryLineTemplate

The collection of TreasuryRecord resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TreasuryRecord
supported operation: Retrieves the collection of TreasuryRecord resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TreasuryRecord resources.
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
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: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Retrieves a Customer resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Customer resource.
returns: Nothing

Replaces the Customer resource.
type: Operation
type: ReplaceAction
expects: Customer
method: PUT
title: Replaces the Customer resource.
returns: Nothing

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Nothing

Deletes the Customer resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Customer resource.
returns: Nothing

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Updates the Customer resource.
type: Operation
expects: Customer
method: PATCH
title: Updates the Customer resource.
returns: Customer

Replaces the Customer resource.
type: Operation
type: ReplaceAction
expects: Customer
method: PUT
title: Replaces the Customer resource.
returns: Customer

Deletes the Customer resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Customer resource.
returns: Nothing

SupportedProperty
property: minBudgetAmount
title: minBudgetAmount
required: false
readable: true
writeable: true

SupportedProperty
property: maxBudgetAmount
title: maxBudgetAmount
required: false
readable: true
writeable: true

Retrieves a ProspectProjectAdminRead resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a ProspectProjectAdminRead resource.
returns: Nothing

Replaces the ProspectProjectAdminRead resource.
type: Operation
type: ReplaceAction
expects: ProspectProjectAdminRead
method: PUT
title: Replaces the ProspectProjectAdminRead resource.
returns: Nothing

Updates the ProspectProjectAdminRead resource.
type: Operation
expects: ProspectProjectAdminRead
method: PATCH
title: Updates the ProspectProjectAdminRead resource.
returns: Nothing

Updates the ProspectProjectAdminRead resource.
type: Operation
expects: ProspectProjectAdminRead
method: PATCH
title: Updates the ProspectProjectAdminRead resource.
returns: Nothing

Updates the ProspectProjectAdminRead resource.
type: Operation
expects: ProspectProjectAdminRead
method: PATCH
title: Updates the ProspectProjectAdminRead resource.
returns: Nothing

Updates the ProspectProjectAdminRead resource.
type: Operation
expects: ProspectProjectAdminRead
method: PATCH
title: Updates the ProspectProjectAdminRead resource.
returns: Nothing

Retrieves a ProspectProjectAdminRead resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a ProspectProjectAdminRead resource.
returns: Nothing

SupportedProperty
property: annex
title: annex
required: false
readable: true
writeable: true

SupportedProperty
property: soldAt
title: soldAt
required: false
readable: true
writeable: true

SupportedProperty
property: soldNote
title: soldNote
required: false
readable: true
writeable: true

SupportedProperty
property: soldProof
title: soldProof
required: false
readable: true
writeable: true

SupportedProperty
property: priorityCustomerId
title: priorityCustomerId
required: false
readable: true
writeable: true

SupportedProperty
property: priorityWindowExpiresAt
title: priorityWindowExpiresAt
required: false
readable: true
writeable: true

SupportedProperty
property: amenities
title: amenities
required: false
readable: true
writeable: true

SupportedProperty
property: photos
title: photos
required: false
readable: true
writeable: true

SupportedProperty
property: publishedPrice
title: publishedPrice
required: false
readable: true
writeable: true

SupportedProperty
property: feeStructure
title: feeStructure
required: false
readable: true
writeable: true

SupportedProperty
property: title
title: title
required: false
readable: true
writeable: true

SupportedProperty
property: pendingImpacts
title: pendingImpacts
required: false
readable: true
writeable: true

SupportedProperty
property: maxStepReached
title: maxStepReached
required: false
readable: true
writeable: false

SupportedProperty
property: referenceSnapshot
title: referenceSnapshot
required: false
readable: true
writeable: true

SupportedProperty
property: submittedAt
title: submittedAt
required: false
readable: true
writeable: true

SupportedProperty
property: transactions
title: transactions
required: false
readable: true
writeable: false
description: populated by provider/projector, not persisted

SupportedProperty
property: property
title: property
required: false
readable: true
writeable: false
description: Returns the stored property payload (same JSON shape as the old Property entity serialization).

SupportedProperty
property: propertyOwners
title: propertyOwners
required: false
readable: true
writeable: false
description: Returns owners from the stored property snapshot (replaces getProperty()?->getOwners()).

SupportedProperty
property: assignedCollaborator
title: assignedCollaborator
required: false
readable: true
writeable: false

SupportedProperty
property: buyerTotalPrice
title: buyerTotalPrice
required: false
readable: true
writeable: false

SupportedProperty
property: transactionCount
title: transactionCount
required: false
readable: true
writeable: false

SupportedProperty
property: transactions
title: transactions
required: false
readable: true
writeable: false

SupportedProperty
property: externalBrokerEmail
title: externalBrokerEmail
required: false
readable: true
writeable: false
description: Returns the external broker email from the stored snapshot (replaces getExternalBroker()?->getEmail()).

SupportedProperty
property: externalBroker
title: externalBroker
required: false
readable: true
writeable: false

SupportedProperty
property: submittedByCollaborator
title: submittedByCollaborator
required: false
readable: true
writeable: false

Retrieves a Publication resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Publication resource.
returns: Nothing

Updates the Publication resource.
type: Operation
expects: Publication
method: PATCH
title: Updates the Publication resource.
returns: Publication

Updates the Publication resource.
type: Operation
expects: Publication
method: PATCH
title: Updates the Publication resource.
returns: Nothing

Updates the Publication resource.
type: Operation
expects: Publication
method: PATCH
title: Updates the Publication resource.
returns: Nothing

SupportedProperty
property: publishedPrice
title: publishedPrice
required: false
readable: true
writeable: true

SupportedProperty
property: buyerTotalPrice
title: buyerTotalPrice
required: false
readable: true
writeable: true

SupportedProperty
property: feeStructure
title: feeStructure
required: false
readable: true
writeable: true

SupportedProperty
property: pendingImpacts
title: pendingImpacts
required: false
readable: true
writeable: true

SupportedProperty
property: maxStepReached
title: maxStepReached
required: false
readable: true
writeable: true

SupportedProperty
property: customersInLine
title: customersInLine
required: false
readable: true
writeable: true

SupportedProperty
property: customersInLineCount
title: customersInLineCount
required: false
readable: true
writeable: true

SupportedProperty
property: priorityCustomerId
title: priorityCustomerId
required: false
readable: true
writeable: true

SupportedProperty
property: priorityWindowExpiresAt
title: priorityWindowExpiresAt
required: false
readable: true
writeable: true

Retrieves a PublicationAdminDetailRead resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a PublicationAdminDetailRead resource.
returns: PublicationAdminDetailRead