Struct square_api_client::models::InventoryAdjustment

pub struct InventoryAdjustment {

    pub id: String,
    pub reference_id: String,
    pub from_state: InventoryState,
    pub to_state: InventoryState,
    pub location_id: String,
    pub catalog_object_id: String,
    pub catalog_object_type: String,
    pub quantity: String,
    pub total_price_money: Option<Money>,
    pub occurred_at: String,
    pub created_at: String,
    pub source: SourceApplication,
    pub employee_id: String,
    pub team_member_id: String,
    pub transaction_id: String,
    pub refund_id: String,
    pub purchase_order_id: String,
    pub goods_receipt_id: String,
    pub adjustment_group: InventoryAdjustmentGroup,
}

Represents a change in state or quantity of product inventory at a particular time and location.

Fields

id: String

A unique ID generated by Square for the InventoryAdjustment.

reference_id: String

An optional ID provided by the application to tie the InventoryAdjustment

from_state: InventoryState

The current inventory state for the related quantity of items.

to_state: InventoryState

The current inventory state for the related quantity of items.

location_id: String

The Square-generated ID of the Location where the related quantity of items is being tracked.

catalog_object_id: String

The Square-generated ID of the CatalogObject being tracked.

catalog_object_type: String

The type of the CatalogObject being tracked. The Inventory API supports setting and reading the “catalog_object_type”: “ITEM_VARIATION” In addition, it can also read the “catalog_object_type”: “ITEM”

quantity: String

The number of items affected by the estimated count as a decimal string.

total_price_money: Option<Money>

Read only The total price paid for goods associated with the adjustment. Present if and only if to_state is SOLD. Always non-negative.

occurred_at: String

Read only An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting the estimated count is received.

created_at: String

Read only RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.

source: SourceApplication

The current inventory state for the related quantity of items.

employee_id: String

The Square-generated ID of the Employee responsible for the inventory adjustment.

team_member_id: String

The Square-generated ID of the Team Member responsible for the inventory adjustment.

transaction_id: String

Read only The Square-generated ID of the Transaction that caused the adjustment. Only relevant for payment-related state transitions.

refund_id: String

Read only The Square-generated ID of the Refund that caused the adjustment. Only relevant for refund-related state transitions.

purchase_order_id: String

Read only The Square-generated ID of the purchase order that caused the adjustment. Only relevant for state transitions from the Square for Retail app.

goods_receipt_id: String

Read only The Square-generated ID of the goods receipt that caused the adjustment. Only relevant for state transitions from the Square for Retail app.

adjustment_group: InventoryAdjustmentGroup

Read only An adjustment group bundling the related adjustments of item variations through stock conversions in a single inventory event.

Trait Implementations

impl Clone for InventoryAdjustment

fn clone(&self) -> InventoryAdjustment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InventoryAdjustment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InventoryAdjustment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<InventoryAdjustment> for InventoryAdjustment

fn eq(&self, other: &InventoryAdjustment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InventoryAdjustment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InventoryAdjustment

impl StructuralEq for InventoryAdjustment

impl StructuralPartialEq for InventoryAdjustment