Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bbrands.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Primary key

document_id
uuiddefault:"Random UUID"publicrequired
The unique identifier for the MaihueStreet transaction record.

​
Specific attributes

authorization_reason
varcharpublic
The reason for the authorization status.
authorization_status
varcharpublic
The status of the authorization for the transaction.
Rules: Max length: 50 characters
dispensed_finished
booleandefault:"false"public
Indicates whether the dispensing process has finished.
dispensed_quantity
decimalpublic
The quantity of water dispensed in the transaction.
Rules: Precision: 12, Scale: 2
dispensed_reason
varcharpublic
The reason for the dispensed status.
Rules: Max length: 50 characters
dispensed_requested
booleandefault:"false"public
Indicates whether a dispensing request has been made.
dispensed_responsed
booleandefault:"false"public
Indicates whether there has been a response to the dispensing request.
finished
booleandefault:"false"publicrequired
Indicates whether the transaction has been completed.
is_nfc
booleandefault:"false"publicrequired
Indicates whether the transaction was initiated using NFC.
is_qr
booleandefault:"false"publicrequired
Indicates whether the transaction was initiated using a QR code.
new_transaction_created
booleandefault:"false"public
Indicates whether a new transaction has been created as a result of this transaction.
remove_bottle
booleandefault:"false"publicrequired
Indicates whether the bottle was removed during the transaction/dispensation.
temperature
decimalpublic
The temperatureof the transaction.
Rules: Precision: 6, Scale: 2
ppm
decimalpublic
The parts per million (PPM) value for the water in this transaction.
quantity
decimalpublic
The quantity of water requested in the transaction.
Rules: Precision: 6, Scale: 0
transaction_status
varcharpublic
The current status of the transaction.
Rules: Max length: 50 characters

​
Foreign keys

machine
uuidpublicrequired
The unique identifier of the associated machine. Ref: MaihueStreetMachine Schema
user
uuidpublic
The unique identifier of the associated user. Ref: User Schema
user_alias
uuidpublic
The unique identifier of the associated user alias. Ref: MaihueStreetUserAlias Schema
user_bottle
uuidpublic
The unique identifier of the associated user bottle. Ref: MaihueStreetUserBottle Schema
water_type
uuidpublic
The unique identifier of the associated water type. Ref: MaihueStreetWaterType Schema
workflow
uuidpublicrequired
The unique identifier of the associated workflow. Ref: MaihueStreetWorkflow Schema
workflow_step
uuidpublicrequired
The unique identifier of the associated workflow step. Ref: MaihueStreetWorkflowStep Schema

​
Tracking attributes

created_at
timestamppublic
The timestamp when the MaihueStreet transaction record was created.
Rules: Precision: 6, with timezone
deleted_at
timestamppublic
The timestamp when the MaihueStreet transaction record was deleted, if applicable.
Rules: Precision: 6, with timezone
is_actived
booleandefault:"true"public
Indicates whether the MaihueStreet transaction record is active.
is_deleted
booleandefault:"false"public
Indicates whether the MaihueStreet transaction record has been deleted.
updated_at
timestamppublic
The timestamp when the MaihueStreet transaction record was last updated.
Rules: Precision: 6, with timezone