Lots

albert.resources.lots

LotStatus

Bases: str, Enum

The status of a lot

Attributes:

Name	Type	Description
ACTIVE
INACTIVE
QUARANTINED

ACTIVE

ACTIVE = 'active'

INACTIVE

INACTIVE = 'inactive'

QUARANTINED

QUARANTINED = 'quarantined'

Lot

Bases: BaseResource

A lot in Albert.

Attributes:

Name	Type	Description
id	LotId | None	The Albert ID of the lot. Set when the lot is retrieved from Albert.
inventory_id	InventoryId	The Albert ID of the inventory item associated with the lot.
task_id	str | None	The Albert ID of the task associated with the creation of lot. Optional.
notes	str | None	The notes associated with the lot. Optional.
expiration_date	str | None	The expiration date of the lot. YYYY-MM-DD format. Optional.
manufacturer_lot_number	str | None	The manufacturer lot number of the lot. Optional.
storage_location	StorageLocation | None	The storage location of the lot. Optional.
pack_size	str | None	The pack size of the lot. Optional. Used to calculate the cost per unit.
initial_quantity	NonNegativeFloat | None	The initial quantity of the lot. Optional.
cost	NonNegativeFloat | None	The cost of the lot. Optional.
inventory_on_hand	NonNegativeFloat	The inventory on hand of the lot.
owner	list[User] | None	The owners of the lot. Optional.
lot_number	str | None	The lot number of the lot. Optional.
external_barcode_id	str | None	The external barcode ID of the lot. Optional.
metadata	dict[str, str | list[EntityLink] | EntityLink] | None	The metadata of the lot. Optional. Metadata allowed values can be found using the Custom Fields API.
has_notes	bool	Whether the lot has notes. Read-only.
has_attachments	bool	Whether the lot has attachments. Read-only.
barcode_id	str	The barcode ID of the lot. Read-only.

Methods:

Name	Description
validate_has_notes
validate_has_attachments
serialize_initial_quantity
serialize_cost
serialize_inventory_on_hand

action

action: str | None = Field(default=None)

id

id: LotId | None = Field(None, alias='albertId')

inventory_id

inventory_id: InventoryId = Field(alias='parentId')

task_id

task_id: str | None = Field(default=None, alias='taskId')

expiration_date

expiration_date: str | None = Field(
    None, alias="expirationDate"
)

manufacturer_lot_number

manufacturer_lot_number: str | None = Field(
    None, alias="manufacturerLotNumber"
)

storage_location

storage_location: (
    SerializeAsEntityLink[StorageLocation] | None
) = Field(alias="StorageLocation", default=None)

pack_size

pack_size: str | None = Field(None, alias='packSize')

initial_quantity

initial_quantity: float | None = Field(
    default=None, alias="initialQuantity"
)

cost

cost: NonNegativeFloat | None = Field(default=None)

inventory_on_hand

inventory_on_hand: float = Field(alias='inventoryOnHand')

owner

owner: list[SerializeAsEntityLink[User]] | None = Field(
    default=None, alias="Owner"
)

lot_number

lot_number: str | None = Field(None, alias='lotNumber')

external_barcode_id

external_barcode_id: str | None = Field(
    None, alias="externalBarcodeId"
)

metadata

metadata: dict[str, MetadataItem] | None = Field(
    alias="Metadata", default=None
)

notes

notes: str | None = Field(default=None)

status

status: LotStatus | None = Field(
    default=None, exclude=True, frozen=True
)

location

location: SerializeAsEntityLink[Location] | None = Field(
    default=None, alias="Location"
)

has_notes

has_notes: bool | None = Field(
    default=None,
    alias="hasNotes",
    exclude=True,
    frozen=True,
)

has_attachments

has_attachments: bool | None = Field(
    default=None,
    alias="hasAttachments",
    exclude=True,
    frozen=True,
)

parent_name

parent_name: str | None = Field(
    default=None,
    alias="parentName",
    exclude=True,
    frozen=True,
)

parent_unit

parent_unit: str | None = Field(
    default=None,
    alias="parentUnit",
    exclude=True,
    frozen=True,
)

parent_category

parent_category: InventoryCategory | None = Field(
    default=None,
    alias="parentCategory",
    exclude=True,
    frozen=True,
)

barcode_id

barcode_id: str | None = Field(
    default=None,
    alias="barcodeId",
    exclude=True,
    frozen=True,
)

task_completion_date

task_completion_date: str | None = Field(
    default=None,
    alias="taskCompletionDate",
    exclude=True,
    frozen=True,
)

validate_has_notes

validate_has_notes(value: Any) -> Any

Source code in src/albert/resources/lots.py

@field_validator("has_notes", mode="before")
def validate_has_notes(cls, value: Any) -> Any:
    if value == "1":
        return True
    elif value == "0":
        return False
    return value

validate_has_attachments

validate_has_attachments(value: Any) -> Any

Source code in src/albert/resources/lots.py

@field_validator("has_attachments", mode="before")
def validate_has_attachments(cls, value: Any) -> Any:
    if value == "1":
        return True
    elif value == "0":
        return False
    return value

serialize_initial_quantity

serialize_initial_quantity(
    initial_quantity: NonNegativeFloat,
)

Source code in src/albert/resources/lots.py

@field_serializer("initial_quantity", return_type=str)
def serialize_initial_quantity(self, initial_quantity: NonNegativeFloat):
    return self._format_decimal(initial_quantity)

serialize_cost

serialize_cost(cost: NonNegativeFloat)

Source code in src/albert/resources/lots.py

@field_serializer("cost", return_type=str)
def serialize_cost(self, cost: NonNegativeFloat):
    return self._format_decimal(cost)

serialize_inventory_on_hand

serialize_inventory_on_hand(
    inventory_on_hand: NonNegativeFloat,
)

Source code in src/albert/resources/lots.py

@field_serializer("inventory_on_hand", return_type=str)
def serialize_inventory_on_hand(self, inventory_on_hand: NonNegativeFloat):
    return self._format_decimal(inventory_on_hand)

LotSearchItem

Bases: BaseAlbertModel, HydrationMixin[Lot]

Lightweight representation of a Lot returned from search().

Show JSON schema:

{
  "$defs": {
    "InventoryCategory": {
      "enum": [
        "RawMaterials",
        "Consumables",
        "Equipment",
        "Formulas"
      ],
      "title": "InventoryCategory",
      "type": "string"
    }
  },
  "description": "Lightweight representation of a Lot returned from search().",
  "properties": {
    "albertId": {
      "title": "Albertid",
      "type": "string"
    },
    "parentId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Parentid"
    },
    "parentName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Parentname"
    },
    "parentUnit": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Parentunit"
    },
    "parentIdCategory": {
      "anyOf": [
        {
          "$ref": "#/$defs/InventoryCategory"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "taskId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Taskid"
    },
    "barcodeId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Barcodeid"
    },
    "expirationDate": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Expirationdate"
    },
    "manufacturerLotNumber": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Manufacturerlotnumber"
    },
    "number": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Number"
    }
  },
  "required": [
    "albertId"
  ],
  "title": "LotSearchItem",
  "type": "object"
}

Fields:

• _collection (BaseCollection | None)
• id (LotId)
• inventory_id (InventoryId | None)
• parent_name (str | None)
• parent_unit (str | None)
• parent_category (InventoryCategory | None)
• task_id (str | None)
• barcode_id (str | None)
• expiration_date (str | None)
• manufacturer_lot_number (str | None)
• lot_number (str | None)

id

id: LotId

inventory_id

inventory_id: InventoryId | None = None

parent_name

parent_name: str | None = None

parent_unit

parent_unit: str | None = None

parent_category

parent_category: InventoryCategory | None = None

task_id

task_id: str | None = None

barcode_id

barcode_id: str | None = None

expiration_date

expiration_date: str | None = None

manufacturer_lot_number

manufacturer_lot_number: str | None = None

lot_number

lot_number: str | None = None