• inventory: array inventory
• kitTypes: array kitTypes
• nsInventory: array nsInventory
• order: object OrderDTO v5.0
  Title: OrderDTO v5.0

  Contains order related details.
• version: integer (int32)
  Version.

  Example: 1

{
    "title":"OrdersInventoryDTO v8.0",
    "type":"object",
    "properties":{
        "order":{
            "$ref":"#/components/schemas/OrderDTOV5"
        },
        "inventory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InventoryDTOV3"
            }
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrdersKitTypes"
            }
        },
        "nsInventory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NsInventoryDTO"
            }
        },
        "version":{
            "type":"integer",
            "description":"Version.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Contains non serialized inventory order details."
}

• Array of: object InventoryDTO v3.0
  Title: InventoryDTO v3.0

  Contains kit details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/InventoryDTOV3"
    }
}

• Array of: object OrdersKitTypes
  Orders Kit Types object for Pooling Supplies.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OrdersKitTypes"
    }
}

• Array of: object NsInventoryDTO v1.0
  Title: NsInventoryDTO v1.0

  Contains non serialized kit details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NsInventoryDTO"
    }
}

• comment: string
  comment

  Example: Updated with new values
• deliveryNumber: string
  Delivery Number

  Example: Order123
• depotId: string (uuid)
  Depot Id.
• depotVersionStart: string (date-time)
  Depot version start.
• includePooledShipments: boolean
  includePooledShipments

  Example: true
• isDepotShipment: boolean
  isDepotShipment

  Example: true
• isReconciliation: boolean
  isReconciliation

  Example: true
• jobInstanceId: string (uuid)
  Job instance Id.
• objectVersionNumber: number (double)
  Software version Number

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "MODIFIED", "REMOVED" ]

  Operation type.

  Example: CREATED
• orderDate: string (date-time)
  Date of order
• orderId: string (uuid)
  Order Id.
• orderStatusId: number (double)
  Order status Id.

  Example: 5
• orderType: string
  Allowed Values: [ "INITIAL", "RESUPPLY", "MANUAL" ]

  Order type.

  Example: MANUAL
• orderTypeId: integer (int64)
  Order type Id.

  Example: 5
• reason: string
  reason

  Example: DATA ENTRY ERROR
• reportId: string (uuid)
  report Id.
• shipDate: string (date-time)
  Date of shipping.
• shipmentId: string
  ID of the shipment.

  Example: 123
• shipmentReceiptDate: string (date-time)
  Shipment Receipt Date
• shipmentReceivedById: string (uuid)
  Shipment received by ID
• shippingAddress: string
  Shipping Address

  Example: City,Country,Local Address
• shippingAddressId: string (uuid)
  Shipping address ID
• siteId: string (uuid)
  ID of the site
• siteVersionStart: string (date-time)
  Site version start.
• studyId: string (uuid)
  ID of the study
• studyVersionStart: string (date-time)
  Study version start.
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberUrl: string
  Tracking number url.

  Example: http://www.site.com
• userId: string (uuid)
  User Id.
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"OrderDTO v5.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "depotId":{
            "type":"string",
            "description":"Depot Id.",
            "format":"uuid"
        },
        "depotVersionStart":{
            "type":"string",
            "description":"Depot version start.",
            "format":"date-time"
        },
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance Id.",
            "format":"uuid"
        },
        "orderDate":{
            "type":"string",
            "description":"Date of order",
            "format":"date-time"
        },
        "orderStatusId":{
            "type":"number",
            "description":"Order status Id.",
            "format":"double",
            "example":5
        },
        "studyId":{
            "type":"string",
            "description":"ID of the study",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Date of shipping.",
            "format":"date-time"
        },
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"123"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "type":"string",
            "description":"Tracking number url.",
            "example":"http://www.site.com"
        },
        "orderType":{
            "type":"string",
            "description":"Order type.",
            "example":"MANUAL",
            "enum":[
                "INITIAL",
                "RESUPPLY",
                "MANUAL"
            ]
        },
        "orderTypeId":{
            "type":"integer",
            "description":"Order type Id.",
            "format":"int64",
            "example":5
        },
        "userId":{
            "type":"string",
            "description":"User Id.",
            "format":"uuid"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED",
            "enum":[
                "CREATED",
                "MODIFIED",
                "REMOVED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Software version Number",
            "format":"double",
            "example":5
        },
        "reason":{
            "type":"string",
            "description":"reason",
            "example":"DATA ENTRY ERROR"
        },
        "comment":{
            "type":"string",
            "description":"comment",
            "example":"Updated with new values"
        },
        "isReconciliation":{
            "type":"boolean",
            "description":"isReconciliation",
            "example":true
        },
        "reportId":{
            "type":"string",
            "description":"report Id.",
            "format":"uuid"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"isDepotShipment",
            "example":true
        },
        "shipmentReceivedById":{
            "type":"string",
            "description":"Shipment received by ID",
            "format":"uuid"
        },
        "shippingAddressId":{
            "type":"string",
            "description":"Shipping address ID",
            "format":"uuid"
        },
        "shippingAddress":{
            "type":"string",
            "description":"Shipping Address",
            "example":"City,Country,Local Address"
        },
        "shipmentReceiptDate":{
            "type":"string",
            "description":"Shipment Receipt Date",
            "format":"date-time"
        },
        "includePooledShipments":{
            "type":"boolean",
            "description":"includePooledShipments",
            "example":true
        },
        "deliveryNumber":{
            "type":"string",
            "description":"Delivery Number",
            "example":"Order123"
        },
        "orderId":{
            "type":"string",
            "description":"Order Id.",
            "format":"uuid"
        }
    },
    "description":"Contains order related details."
}

• Block number: string
  Block number.

  Example: 245
• blocknumber: string
• doNotCount: number (double)
  Do Not Count (DNC) Days.

  Example: 5
• doNotShip: number (double)
  Do Not Ship (DNS) Days.

  Example: 5
• expirationDate: string (date-time)
  Expiration date
• inventoryId: string (uuid)
  Inventory Id.
• inventorySourceId: string (uuid)
  Id of the Inventory
• inventorySourceVersionStart: string (date-time)
  Inventory version start
• inventoryStatusId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitNumber: number (double)
  Kit number.

  Example: 5
• kitNumberUTF: string
  Kit number UTF8.

  Example: 24-1
• kitTypeId: string (uuid)
  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Kit type version start
• labelGroupId: string (uuid)
  Label group Id.
• labelGroupVersionStart: string (date-time)
  Label group version start
• lotId: string (uuid)
  Lot Id.
• lotVersionStart: string (date-time)
  Lot version start
• sequenceNumber: number (double)
  Sequence nuumber.

  Example: 5
• siteId: string (uuid)
  ID of the site
• siteVersionStart: string (date-time)
  Site version start
• tempExcursionNumber: string
  Temperature excursion number

  Example: 001
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"InventoryDTO v3.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "doNotCount":{
            "type":"number",
            "description":"Do Not Count (DNC) Days.",
            "format":"double",
            "example":5
        },
        "doNotShip":{
            "type":"number",
            "description":"Do Not Ship (DNS) Days.",
            "format":"double",
            "example":5
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start",
            "format":"date-time"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group Id.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start",
            "format":"date-time"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence nuumber.",
            "format":"double",
            "example":5
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start",
            "format":"date-time"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Id of the Inventory",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory version start",
            "format":"date-time"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number UTF8.",
            "example":"24-1"
        },
        "Block number":{
            "type":"string",
            "description":"Block number.",
            "example":"245"
        },
        "tempExcursionNumber":{
            "type":"string",
            "description":"Temperature excursion number",
            "example":"001"
        },
        "blocknumber":{
            "type":"string",
            "writeOnly":true
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        }
    },
    "description":"Contains kit details."
}

• Comment: string
  Comment

  Example: test
• id: string (uuid)
  Order Kit Type Id for Pooling Supplies
• kitTypeSrcId: string (uuid)
  KitType source Id
• lotId: string (uuid)
  Lot Id
• minExpirationDate: string (date-time)
  Min Expiration date
• MLot: string
  Manufacturing Lot

  Example: MLOT
• objectVersionNumber: number
• Operation Type: string
  Operation Type

  Example: modified
• Pooled KitID: string
  Pooled KitID

  Example: Pooled Kit01
• quantity: number (number)
  Kit quantity

  Example: 5
• Reason: string
  Reason

  Example: test
• softwareVersionNumber: number
• UserId: string (uuid)
  User Id
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Order Kit Type Id for Pooling Supplies",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"KitType source Id",
            "format":"uuid"
        },
        "quantity":{
            "type":"number",
            "description":"Kit quantity",
            "format":"number",
            "example":5
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id",
            "format":"uuid"
        },
        "minExpirationDate":{
            "type":"string",
            "description":"Min Expiration date",
            "format":"date-time"
        },
        "UserId":{
            "type":"string",
            "description":"User Id",
            "format":"uuid"
        },
        "Operation Type":{
            "type":"string",
            "description":"Operation Type",
            "example":"modified"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "Reason":{
            "type":"string",
            "description":"Reason",
            "example":"test"
        },
        "Comment":{
            "type":"string",
            "description":"Comment",
            "example":"test"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "Pooled KitID":{
            "type":"string",
            "description":"Pooled KitID",
            "example":"Pooled Kit01"
        },
        "MLot":{
            "type":"string",
            "description":"Manufacturing Lot",
            "example":"MLOT"
        }
    },
    "description":"Orders Kit Types object for Pooling Supplies."
}

• inventoryStatusId: number (double)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

  Example: 5
• kitTypeId: string (uuid)
  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Kit type version start
• labelGroupId: string (uuid)
  Label group Id.
• labelGroupVersionStart: string (date-time)
  Label group version start
• lotId: string (uuid)
  Lot Id.
• lotNumber: string
  Lot Number

  Example: lot1
• lotVersionStart: string (date-time)
  Lot version start
• nsInventoryId: string (uuid)
  ID of the kit type.
• objectVersionNumber: number
  objectVersionNumber

  Example: 1
• operationType: string
  operationType

  Example: CREATED
• quantity: number (double)
  Kit Quantity

  Example: 5
• siteId: string (uuid)
  ID of the site
• siteVersionStart: string (date-time)
  Site version start
• softwareVersionNumber: number
  softwareVersionNumber

  Example: 1
• transactionId: string (uuid)
  transactionId
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"NsInventoryDTO v1.0",
    "type":"object",
    "properties":{
        "nsInventoryId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start",
            "format":"date-time"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group Id.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start",
            "format":"date-time"
        },
        "quantity":{
            "type":"number",
            "description":"Kit Quantity",
            "format":"double",
            "example":5
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot Number",
            "example":"lot1"
        },
        "operationType":{
            "type":"string",
            "description":"operationType",
            "example":"CREATED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"objectVersionNumber",
            "example":1
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"softwareVersionNumber",
            "example":1
        },
        "transactionId":{
            "type":"string",
            "description":"transactionId",
            "format":"uuid"
        }
    },
    "description":"Contains non serialized kit details."
}

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

• details: string
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

  Example: User role is missing required permission REPORTING_VIEW. Field: userId
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}