Audits
Models
Audit Model
The audit model represents an inventory counting workflow for a location. An audit groups together one or more audit_task records, each of which counts a specific item at a specific layout.
object "audit"
The enum value identifying this as an audit model.
id string
Unique identifier for this audit, prefixed with audit_.
organization_id string
The ID of the organization that owns this audit.
number string
A human-readable identifier for the audit. If one is not supplied at creation, the system generates one in the form AUD-<n> where <n> increments per organization.
location object
The location at which the audit is being performed.
Show Details
status string
The current status of the audit. Can be created, processing, in_review, recount, approved, or canceled. See Audit Statuses for the typical progression.
priority string
The priority of the audit. Can be low, medium, or high. Defaults to medium.
assignee Contact | null
The contact responsible for performing this audit, returned as a full Contact object. Null if no contact is assigned.
tasks Array.<AuditTask>
The list of counting tasks that make up this audit. This array is returned when group_by is not specified. When group_by is supplied, this array will be empty and the tasks will be grouped under by_item or by_layout instead.
by_item object
A map of item_id to an array of AuditTask objects. Only populated when the audit is retrieved with group_by=by_item; otherwise this is an empty object.
by_layout object
A map of layout_id to an array of AuditTask objects. Only populated when the audit is retrieved with group_by=by_layout; otherwise this is an empty object.
feedback string
Free-form feedback or notes about the audit, typically added during review.
complete_at integer | null
Time in epoch seconds by which this audit is scheduled to be completed. Used to determine if the audit is overdue.
finished_at integer | null
Time in epoch seconds at which this audit was approved. Set automatically when the status transitions to approved.
overdue boolean
Indicates whether the audit passed its complete_at deadline without being approved.
update_inventory boolean
If true, inventory levels will be reconciled with counted_qty when the audit is approved. If false, the audit is recorded but does not modify inventory. Defaults to true.
metadata object
Additional metadata associated with the audit.
created_at integer
Time in epoch seconds when this audit was created.
updated_at integer
Time in epoch seconds when this audit was last updated.
created_by string
The ID of the user or API key that created this audit.
updated_by string
The ID of the user or API key that last updated this audit.
created_by_details object
The ID and display name of the user or API key that created this audit.
Show Details
updated_by_details object
The ID and display name of the user or API key that last updated this audit.
Show Details
checksum string
An MD5 checksum computed from the audit's properties. This value changes whenever the audit is modified, making it useful for detecting changes without comparing individual fields.
Audit Task Model
The audit task model represents a single counting task within an audit. Each task targets one item at one layout (bin), and tracks the system quantity, counted quantity, and any discrepancy between the two.
object "audit_task"
The enum value identifying this as an audit task model.
id string
Unique identifier for this audit task, prefixed with audit_task_.
organization_id string
The ID of the organization that owns this audit task.
item object
The item being counted in this task.
Show Details
layout object | null
The layout (bin) at which the item is being counted.
Show Details
counted_qty integer
The quantity that the auditor has counted for this task. Defaults to 0 until the auditor submits a count.
total_qty integer
The system quantity for this task. This is captured from the inventory level (available_qty + reserved_qty) while the audit is in created, processing, or recount status, and is frozen once the audit moves to in_review.
discrepancy integer
The absolute difference between counted_qty and total_qty.
reason_code ReasonCode | null
The reason code associated with the discrepancy on this task. Required during the in_review status if the discrepancy exceeds the organization-level audit approval threshold.
metadata object
Additional metadata associated with the audit task.
created_at integer
Time in epoch seconds when this audit task was created.
updated_at integer
Time in epoch seconds when this audit task was last updated.
created_by string
The ID of the user or API key that created this audit task.
updated_by string
The ID of the user or API key that last updated this audit task.
created_by_details object
The ID and display name of the user or API key that created this audit task.
Show Details
updated_by_details object
The ID and display name of the user or API key that last updated this audit task.
Show Details
checksum string
An MD5 checksum computed from the audit task's properties. This value changes whenever the task is modified.