ordercloud-python 2026.4.1__py3-none-any.whl

ordercloud/models/order.py

@@ -0,0 +1,477 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud OrderApprovalInfo and related models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .address import Address
+from .approval import ApprovalStatus
+from .line_item import LineItem
+from .line_item_types import LineItemProduct, LineItemSpec, LineItemVariant
+from .misc import OrderDirection, OrderStatus
+from .product import AdHocProduct
+from .promotion import PromotionOverride
+from .shipment import ShipEstimateResponse
+from .subscription import Subscription, SubscriptionIntegrationResponse
+from .user import OrderUser, User
+
+__all__ = [
+    "OrderApprovalInfo",
+    "ApprovalInfo",
+    "OrderApproval",
+    "OrderPromotion",
+    "ShipMethodSelection",
+    "OrderShipMethodSelection",
+    "OrderSplitResult",
+    "OrderSubmitResponse",
+    "OrderSubmitForApprovalResponse",
+    "OrderApprovedResponse",
+    "OrderCalculateResponse",
+    "LineItemOverride",
+    "ExtendedLineItem",
+    "OrderWorksheet",
+    "Order",
+    "OrderDirection",
+    "OrderStatus",
+]
+_Subscription = Subscription
+_ShipEstimateResponse = ShipEstimateResponse
+_SubscriptionIntegrationResponse = SubscriptionIntegrationResponse
+
+
+class OrderApprovalInfo(OrderCloudModel):
+    """An OrderCloud OrderApprovalInfo.
+
+    Attributes:
+        allow_resubmit: Only relevant when declining an order. Changes the order Status back to Unsubmitted and allows the user to make changes and resubmit.
+        comments: Comments to be saved with the order approval or denial.
+    """
+
+    allow_resubmit: Optional[bool] = Field(None, alias="AllowResubmit")
+    comments: Optional[str] = Field(None, alias="Comments")
+
+
+class ApprovalInfo(OrderCloudModel):
+    """An OrderCloud ApprovalInfo.
+
+    Attributes:
+        comments: Comments to be saved with the order approval or denial.
+    """
+
+    comments: Optional[str] = Field(None, alias="Comments")
+
+
+class OrderApproval(OrderCloudModel):
+    """An OrderCloud OrderApproval.
+
+    Attributes:
+        allow_resubmit: If true, the submitting user will be able to modify the order and resubmit for approval. (read-only)
+        approval_rule_id:  (read-only)
+        approving_group_id:  (read-only)
+        status:  (read-only)
+        date_created:  (read-only)
+        date_completed:  (read-only)
+        approver:  (read-only)
+        comments:  (read-only)
+    """
+
+    allow_resubmit: Optional[bool] = Field(None, alias="AllowResubmit")
+    approval_rule_id: Optional[str] = Field(None, alias="ApprovalRuleID")
+    approving_group_id: Optional[str] = Field(None, alias="ApprovingGroupID")
+    status: Optional[ApprovalStatus] = Field(None, alias="Status")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    date_completed: Optional[str] = Field(None, alias="DateCompleted")
+    approver: Optional[User] = Field(None, alias="Approver")
+    comments: Optional[str] = Field(None, alias="Comments")
+
+
+class OrderPromotion(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderPromotion.
+
+    Attributes:
+        amount:  (read-only)
+        line_item_id:  (read-only)
+        amount_overridden: True when the Amount has been set via PromotionOverrides. (read-only)
+        date_applied:  (read-only)
+        id:
+        line_item_level: If true, certain eligible expression requirements must be met, and the PromotionDiscount will be applied at the line item level.
+        code: Must be unique. Entered by buyer when adding promo to order.
+        name:
+        redemption_limit: Limit the total number of orders this promotion can be applied to across all users.
+        redemption_limit_per_user: Limit the total number of orders this promotion can be applied to per user.
+        redemption_count: The number of times this promotion has been applied to an order. (read-only)
+        quantity_limit_per_order: Can only be used when LineItemLevel is true and ItemLimitPerOrder does not have a value. When defined the ValueExpression will be the discount applied to each qualifying quantity of eligible items. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_limit_per_order: Can only be used when LineItemLevel is true and QuantityLimitPerOrder does not have a value. Limits the number of items the promotion will apply to when eligible. When no ItemSortBy is defined, items will be sorted by DateAdded ascending.
+        item_sort_by: Comma delimited list of properties to sort by. Can only be used when ItemLimitPerOrder is true. Used to determine the order in which the promotion is applied to the specified limit of items. Use ! to reverse sort order on a property.
+        description:
+        fine_print: For reference only. Terms, conditions, and other legal jargon.
+        start_date:
+        expiration_date:
+        eligible_expression: The expression evaluated to determine if an item or order is eligible for a promotion. See rules engine documentation for formatting details.
+        value_expression: The expression evaluated to determine the discount amount of an eligible promotion. See rules engine documentation for formatting details.
+        can_combine: If true, the promotion can be applied to an order that already other promotions applied, as long as they can also be combined.
+        allow_all_buyers: Allow promo to be used by all buyers without creating explicit assignments.
+        owner_id: ID of the organization that owns the promotion. Only the marketplace owner can override the OwnerID on create.
+        auto_apply:
+        active:
+        use_integration:
+        priority: Used to control the order in which promotions are applied when calling the auto apply or refresh endpoint.
+        xp:
+    """
+
+    amount: float = Field(0.0, alias="Amount")
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    amount_overridden: Optional[bool] = Field(None, alias="AmountOverridden")
+    date_applied: Optional[str] = Field(None, alias="DateApplied")
+    id: Optional[str] = Field(None, alias="ID")
+    line_item_level: Optional[bool] = Field(None, alias="LineItemLevel")
+    code: Optional[str] = Field(None, alias="Code")
+    name: Optional[str] = Field(None, alias="Name")
+    redemption_limit: Optional[int] = Field(None, alias="RedemptionLimit")
+    redemption_limit_per_user: Optional[int] = Field(None, alias="RedemptionLimitPerUser")
+    redemption_count: int = Field(0, alias="RedemptionCount")
+    quantity_limit_per_order: Optional[int] = Field(None, alias="QuantityLimitPerOrder")
+    item_limit_per_order: Optional[int] = Field(None, alias="ItemLimitPerOrder")
+    item_sort_by: Optional[str] = Field(None, alias="ItemSortBy")
+    description: Optional[str] = Field(None, alias="Description")
+    fine_print: Optional[str] = Field(None, alias="FinePrint")
+    start_date: Optional[str] = Field(None, alias="StartDate")
+    expiration_date: Optional[str] = Field(None, alias="ExpirationDate")
+    eligible_expression: Optional[str] = Field(None, alias="EligibleExpression")
+    value_expression: Optional[str] = Field(None, alias="ValueExpression")
+    can_combine: Optional[bool] = Field(None, alias="CanCombine")
+    allow_all_buyers: Optional[bool] = Field(None, alias="AllowAllBuyers")
+    owner_id: Optional[str] = Field(None, alias="OwnerID")
+    auto_apply: bool = Field(False, alias="AutoApply")
+    active: bool = Field(True, alias="Active")
+    use_integration: Optional[bool] = Field(None, alias="UseIntegration")
+    priority: Optional[int] = Field(None, alias="Priority")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class ShipMethodSelection(OrderCloudModel):
+    """An OrderCloud ShipMethodSelection.
+
+    Attributes:
+        ship_estimate_id:
+        ship_method_id:
+    """
+
+    ship_estimate_id: Optional[str] = Field(None, alias="ShipEstimateID")
+    ship_method_id: Optional[str] = Field(None, alias="ShipMethodID")
+
+
+class OrderShipMethodSelection(OrderCloudModel):
+    """An OrderCloud OrderShipMethodSelection.
+
+    Attributes:
+        ship_method_selections:
+    """
+
+    ship_method_selections: Optional[list[ShipMethodSelection]] = Field(
+        None, alias="ShipMethodSelections"
+    )
+
+
+class OrderSplitResult(OrderCloudModel):
+    """An OrderCloud OrderSplitResult.
+
+    Attributes:
+        outgoing_orders: The outgoing orders created, one for each unique Product.DefaultSupplierID on the original order.
+        remaining_line_item_i_ds: IDs of line items not added to an outgoing order, most likely because Product.DefaultSupplierID is not set.
+    """
+
+    outgoing_orders: Optional[list[Order]] = Field(None, alias="OutgoingOrders")
+    remaining_line_item_i_ds: Optional[list[str]] = Field(None, alias="RemainingLineItemIDs")
+
+
+class OrderSubmitResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderSubmitResponse.
+
+    Attributes:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    http_status_code: Optional[int] = Field(None, alias="HttpStatusCode")
+    unhandled_error_body: Optional[str] = Field(None, alias="UnhandledErrorBody")
+    xp: Optional[XP] = Field(None, alias="xp")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+
+
+class OrderSubmitForApprovalResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderSubmitForApprovalResponse.
+
+    Attributes:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    http_status_code: Optional[int] = Field(None, alias="HttpStatusCode")
+    unhandled_error_body: Optional[str] = Field(None, alias="UnhandledErrorBody")
+    xp: Optional[XP] = Field(None, alias="xp")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+
+
+class OrderApprovedResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderApprovedResponse.
+
+    Attributes:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    http_status_code: Optional[int] = Field(None, alias="HttpStatusCode")
+    unhandled_error_body: Optional[str] = Field(None, alias="UnhandledErrorBody")
+    xp: Optional[XP] = Field(None, alias="xp")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+
+
+class OrderCalculateResponse(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderCalculateResponse.
+
+    Attributes:
+        line_item_overrides:
+        shipping_total:
+        tax_total:
+        fee_total:
+        http_status_code:
+        unhandled_error_body:
+        xp:
+        succeeded:
+    """
+
+    line_item_overrides: Optional[list[LineItemOverride]] = Field(None, alias="LineItemOverrides")
+    shipping_total: Optional[float] = Field(None, alias="ShippingTotal")
+    tax_total: Optional[float] = Field(None, alias="TaxTotal")
+    fee_total: Optional[float] = Field(None, alias="FeeTotal")
+    http_status_code: Optional[int] = Field(None, alias="HttpStatusCode")
+    unhandled_error_body: Optional[str] = Field(None, alias="UnhandledErrorBody")
+    xp: Optional[XP] = Field(None, alias="xp")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+
+
+class LineItemOverride(OrderCloudModel):
+    """An OrderCloud LineItemOverride.
+
+    Attributes:
+        line_item_id:
+        unit_price:
+        product:
+        promotion_overrides:
+        inventory_record_id:
+        remove:
+    """
+
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    unit_price: Optional[float] = Field(None, alias="UnitPrice")
+    product: Optional[AdHocProduct] = Field(None, alias="Product")
+    promotion_overrides: Optional[list[PromotionOverride]] = Field(None, alias="PromotionOverrides")
+    inventory_record_id: Optional[str] = Field(None, alias="InventoryRecordID")
+    remove: Optional[bool] = Field(None, alias="Remove")
+
+
+class ExtendedLineItem(OrderCloudModel, Generic[XP]):
+    """An OrderCloud ExtendedLineItem.
+
+    Attributes:
+        order_id:
+        order: Currently unused.
+        id:
+        product_id:
+        quantity:
+        bundle_item_id: The ID of the line item that represents the bundle. Signifies that the product is being purchased as part of a bundle. (read-only)
+        is_bundle: When true, this item represents a bundle being purchased. (read-only)
+        date_added:  (read-only)
+        quantity_shipped: Sum of QuantityShipped from all shipment items. (read-only)
+        unit_price: Auto calculated price per quantity. Modification requires OverrideUnitPrice role.
+        promotion_discount: Sum of all line item level promotion discount amounts applied. (read-only)
+        base_discount: Discount amount from discount assignments applied to this line item. (read-only)
+        discount_id: ID of the discount applied to this line item. (read-only)
+        line_total: LineSubtotal - BaseDiscount - PromotionDiscount (read-only)
+        line_subtotal: UnitPrice x Quantity (read-only)
+        cost_center: For reference only, does not influence any OrderCloud behavior.
+        date_needed:
+        shipping_account: For reference only, does not influence any OrderCloud behavior.
+        shipping_address_id:
+        ship_from_address_id: Marketplace owner or supplier AddressID where the product will be shipped from. Can be used to calculate shipping costs.
+        product:  (read-only)
+        variant:  (read-only)
+        shipping_address:  (read-only)
+        ship_from_address:  (read-only)
+        supplier_id:  (read-only)
+        inventory_record_id: InventoryRecordID of which product inventory location to use. Cannot be modified once an order is submitted.
+        price_schedule_id: PriceScheduleID used to determine unit price. (read-only)
+        is_on_sale: True when the price schedule and price break has an active SalePrice. (read-only)
+        price_overridden: If true, UnitPrice was overridden. (read-only)
+        specs:
+        incoming_order_id: ID of the original order. Only returns a value for the marketplace owner. (read-only)
+        outgoing_order_id: ID of the split or forwarded order. Only returns a value for the marketplace owner. (read-only)
+        invitation_id:  (read-only)
+        xp:
+    """
+
+    order_id: Optional[str] = Field(None, alias="OrderID")
+    order: Optional[_Order] = Field(None, alias="Order")
+    id: Optional[str] = Field(None, alias="ID")
+    product_id: Optional[str] = Field(None, alias="ProductID")
+    quantity: int = Field(1, alias="Quantity")
+    bundle_item_id: Optional[str] = Field(None, alias="BundleItemID")
+    is_bundle: Optional[bool] = Field(None, alias="IsBundle")
+    date_added: Optional[str] = Field(None, alias="DateAdded")
+    quantity_shipped: int = Field(0, alias="QuantityShipped")
+    unit_price: Optional[float] = Field(None, alias="UnitPrice")
+    promotion_discount: float = Field(0.0, alias="PromotionDiscount")
+    base_discount: float = Field(0.0, alias="BaseDiscount")
+    discount_id: Optional[str] = Field(None, alias="DiscountID")
+    line_total: float = Field(0.0, alias="LineTotal")
+    line_subtotal: float = Field(0.0, alias="LineSubtotal")
+    cost_center: Optional[str] = Field(None, alias="CostCenter")
+    date_needed: Optional[str] = Field(None, alias="DateNeeded")
+    shipping_account: Optional[str] = Field(None, alias="ShippingAccount")
+    shipping_address_id: Optional[str] = Field(None, alias="ShippingAddressID")
+    ship_from_address_id: Optional[str] = Field(None, alias="ShipFromAddressID")
+    product: Optional[LineItemProduct] = Field(None, alias="Product")
+    variant: Optional[LineItemVariant] = Field(None, alias="Variant")
+    shipping_address: Optional[Address] = Field(None, alias="ShippingAddress")
+    ship_from_address: Optional[Address] = Field(None, alias="ShipFromAddress")
+    supplier_id: Optional[str] = Field(None, alias="SupplierID")
+    inventory_record_id: Optional[str] = Field(None, alias="InventoryRecordID")
+    price_schedule_id: Optional[str] = Field(None, alias="PriceScheduleID")
+    is_on_sale: Optional[bool] = Field(None, alias="IsOnSale")
+    price_overridden: Optional[bool] = Field(None, alias="PriceOverridden")
+    specs: Optional[list[LineItemSpec]] = Field(None, alias="Specs")
+    incoming_order_id: Optional[str] = Field(None, alias="IncomingOrderID")
+    outgoing_order_id: Optional[str] = Field(None, alias="OutgoingOrderID")
+    invitation_id: Optional[str] = Field(None, alias="InvitationID")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class OrderWorksheet(OrderCloudModel):
+    """An OrderCloud OrderWorksheet.
+
+    Attributes:
+        order:
+        line_items:
+        order_promotions:
+        subscription:
+        ship_estimate_response:
+        order_calculate_response:
+        order_submit_response:
+        order_submit_for_approval_response:
+        order_approved_response:
+        subscription_integration_response:
+    """
+
+    order: Optional[_Order] = Field(None, alias="Order")
+    line_items: Optional[list[LineItem]] = Field(None, alias="LineItems")
+    order_promotions: Optional[list[OrderPromotion]] = Field(None, alias="OrderPromotions")
+    subscription: Optional[_Subscription] = Field(None, alias="Subscription")
+    ship_estimate_response: Optional[_ShipEstimateResponse] = Field(
+        None, alias="ShipEstimateResponse"
+    )
+    order_calculate_response: Optional[_OrderCalculateResponse] = Field(
+        None, alias="OrderCalculateResponse"
+    )
+    order_submit_response: Optional[_OrderSubmitResponse] = Field(None, alias="OrderSubmitResponse")
+    order_submit_for_approval_response: Optional[_OrderSubmitForApprovalResponse] = Field(
+        None, alias="OrderSubmitForApprovalResponse"
+    )
+    order_approved_response: Optional[_OrderApprovedResponse] = Field(
+        None, alias="OrderApprovedResponse"
+    )
+    subscription_integration_response: Optional[_SubscriptionIntegrationResponse] = Field(
+        None, alias="SubscriptionIntegrationResponse"
+    )
+
+
+class Order(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Order.
+
+    Attributes:
+        id:
+        from_user: User placing the order. (read-only)
+        from_company_id: ID of the Buyer placing the order, or the marketplace owner when an order is being forwarded. Mainly useful to the marketplace owner or supplier receiving it.
+        to_company_id: ID of the marketplace owner or supplier receiving the order, only writable on create. Mainly useful to the user placing it.
+        from_user_id: This property is only writable when creating an order on behalf of a buyer user.
+        billing_address_id:
+        billing_address:  (read-only)
+        shipping_address_id: ID of the ShippingAddress for all line items on the order. Null when there are multiple shipping addresses defined.
+        comments:
+        line_item_count:  (read-only)
+        status:  (read-only)
+        date_created:  (read-only)
+        date_submitted: Null until the order passes from the buyer to the marketplace owner, including when Status is PendingApproval. (read-only)
+        date_approved:  (read-only)
+        date_declined:  (read-only)
+        date_canceled:  (read-only)
+        date_completed: Populated when all items on an order have shipped, or the order is explicitly completed. (read-only)
+        last_updated:  (read-only)
+        subtotal: Sum of all LineItem.LineSubtotals. (read-only)
+        shipping_cost: Modifying requires OverrideShipping role.
+        tax_cost: Modifying requires TaxOverride role.
+        gratuity:
+        fees: Fees associated with order or line items (read-only)
+        base_discount: Sum of all discount amounts from discount assignments applied to line items on this order. (read-only)
+        promotion_discount: Sum of all promotion amounts applied to the order. (read-only)
+        currency: Inherited from the user placing the order. (read-only)
+        total: Subtotal - BaseDiscount - PromotionDiscount + TaxCost + ShippingCost + Gratuity + Fees (read-only)
+        is_submitted: True if this order has been passed from the Buyer to the marketplace owner or supplier. (read-only)
+        subscription_id: ID of the subscription used to create an order in an automated process. (read-only)
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    from_user: Optional[OrderUser] = Field(None, alias="FromUser")
+    from_company_id: Optional[str] = Field(None, alias="FromCompanyID")
+    to_company_id: Optional[str] = Field(None, alias="ToCompanyID")
+    from_user_id: Optional[str] = Field(None, alias="FromUserID")
+    billing_address_id: Optional[str] = Field(None, alias="BillingAddressID")
+    billing_address: Optional[Address] = Field(None, alias="BillingAddress")
+    shipping_address_id: Optional[str] = Field(None, alias="ShippingAddressID")
+    comments: Optional[str] = Field(None, alias="Comments")
+    line_item_count: int = Field(0, alias="LineItemCount")
+    status: Optional[OrderStatus] = Field(None, alias="Status")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    date_submitted: Optional[str] = Field(None, alias="DateSubmitted")
+    date_approved: Optional[str] = Field(None, alias="DateApproved")
+    date_declined: Optional[str] = Field(None, alias="DateDeclined")
+    date_canceled: Optional[str] = Field(None, alias="DateCanceled")
+    date_completed: Optional[str] = Field(None, alias="DateCompleted")
+    last_updated: Optional[str] = Field(None, alias="LastUpdated")
+    subtotal: float = Field(0.0, alias="Subtotal")
+    shipping_cost: Optional[float] = Field(None, alias="ShippingCost")
+    tax_cost: Optional[float] = Field(None, alias="TaxCost")
+    gratuity: float = Field(0, alias="Gratuity")
+    fees: float = Field(0, alias="Fees")
+    base_discount: float = Field(0.0, alias="BaseDiscount")
+    promotion_discount: float = Field(0.0, alias="PromotionDiscount")
+    currency: Optional[str] = Field(None, alias="Currency")
+    total: float = Field(0.0, alias="Total")
+    is_submitted: Optional[bool] = Field(None, alias="IsSubmitted")
+    subscription_id: Optional[str] = Field(None, alias="SubscriptionID")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+_Order = Order
+
+
+_OrderCalculateResponse = OrderCalculateResponse
+
+
+_OrderSubmitResponse = OrderSubmitResponse
+
+
+_OrderSubmitForApprovalResponse = OrderSubmitForApprovalResponse
+
+
+_OrderApprovedResponse = OrderApprovedResponse

ordercloud/models/order_return.py

@@ -0,0 +1,92 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud OrderReturnItem, OrderReturnApproval, OrderReturn models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudModel, XP
+from .approval import ApprovalStatus
+from .misc import OrderStatus
+from .user import User
+
+__all__ = ["OrderReturnItem", "OrderReturnApproval", "OrderReturn"]
+
+
+class OrderReturnItem(OrderCloudModel):
+    """An OrderCloud OrderReturnItem.
+
+    Attributes:
+        line_item_id:
+        quantity:
+        refund_amount:
+        comments:
+    """
+
+    line_item_id: Optional[str] = Field(None, alias="LineItemID")
+    quantity: int = Field(0, alias="Quantity")
+    refund_amount: Optional[float] = Field(None, alias="RefundAmount")
+    comments: Optional[str] = Field(None, alias="Comments")
+
+
+class OrderReturnApproval(OrderCloudModel):
+    """An OrderCloud OrderReturnApproval.
+
+    Attributes:
+        order_return_id:
+        approval_rule_id:  (read-only)
+        approving_group_id:  (read-only)
+        status:  (read-only)
+        date_created:  (read-only)
+        date_completed:  (read-only)
+        approver:  (read-only)
+        comments:  (read-only)
+    """
+
+    order_return_id: Optional[str] = Field(None, alias="OrderReturnID")
+    approval_rule_id: Optional[str] = Field(None, alias="ApprovalRuleID")
+    approving_group_id: Optional[str] = Field(None, alias="ApprovingGroupID")
+    status: Optional[ApprovalStatus] = Field(None, alias="Status")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    date_completed: Optional[str] = Field(None, alias="DateCompleted")
+    approver: Optional[User] = Field(None, alias="Approver")
+    comments: Optional[str] = Field(None, alias="Comments")
+
+
+class OrderReturn(OrderCloudModel, Generic[XP]):
+    """An OrderCloud OrderReturn.
+
+    Attributes:
+        id:
+        order_id:
+        payment_i_ds: IDs of payments associated with this order return. (read-only)
+        status:  (read-only)
+        date_created:  (read-only)
+        date_submitted: Will be null until the order return passes from the buyer to the seller, including when Status is PendingApproval. (read-only)
+        date_approved:  (read-only)
+        date_declined:  (read-only)
+        date_canceled:  (read-only)
+        date_completed: Populated when payment to customer has been completed. (read-only)
+        last_updated:  (read-only)
+        refund_amount: Sum of all RefundAmounts for items. This value can be overridden by a user with the OrderAdmin role. To remove the override set the value to null.
+        comments:
+        items_to_return:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    order_id: Optional[str] = Field(None, alias="OrderID")
+    payment_i_ds: Optional[list[str]] = Field(None, alias="PaymentIDs")
+    status: Optional[OrderStatus] = Field(None, alias="Status")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    date_submitted: Optional[str] = Field(None, alias="DateSubmitted")
+    date_approved: Optional[str] = Field(None, alias="DateApproved")
+    date_declined: Optional[str] = Field(None, alias="DateDeclined")
+    date_canceled: Optional[str] = Field(None, alias="DateCanceled")
+    date_completed: Optional[str] = Field(None, alias="DateCompleted")
+    last_updated: Optional[str] = Field(None, alias="LastUpdated")
+    refund_amount: Optional[float] = Field(None, alias="RefundAmount")
+    comments: Optional[str] = Field(None, alias="Comments")
+    items_to_return: Optional[list[OrderReturnItem]] = Field(None, alias="ItemsToReturn")
+    xp: Optional[XP] = Field(None, alias="xp")

ordercloud/models/payment.py

@@ -0,0 +1,77 @@
+# GENERATED by tools/codegen — DO NOT EDIT
+# Source: ordercloud-openapi-v3.json
+"""OrderCloud PaymentType, PaymentTransaction, Payment models."""
+
+from __future__ import annotations
+from typing import Generic, Optional
+from pydantic import Field
+
+from .shared import OrderCloudEnum, OrderCloudModel, XP
+
+__all__ = ["PaymentType", "PaymentTransaction", "Payment"]
+
+
+class PaymentType(OrderCloudEnum):
+    """"""
+
+    PurchaseOrder = "PurchaseOrder"
+    CreditCard = "CreditCard"
+    SpendingAccount = "SpendingAccount"
+
+
+class PaymentTransaction(OrderCloudModel, Generic[XP]):
+    """An OrderCloud PaymentTransaction.
+
+    Attributes:
+        id:
+        type:
+        date_executed:
+        currency: Usually the same as Payment.Currency, but can be different. A marketplace owner may capture funds from the buyer user in one currency and process a payout to the seller in another.
+        amount: Usually the same as Payment.Amount, but can be different. A charge might have a subsequent partial credit, for example.
+        succeeded:
+        result_code:
+        result_message:
+        xp:
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    type: Optional[str] = Field(None, alias="Type")
+    date_executed: Optional[str] = Field(None, alias="DateExecuted")
+    currency: Optional[str] = Field(None, alias="Currency")
+    amount: Optional[float] = Field(None, alias="Amount")
+    succeeded: Optional[bool] = Field(None, alias="Succeeded")
+    result_code: Optional[str] = Field(None, alias="ResultCode")
+    result_message: Optional[str] = Field(None, alias="ResultMessage")
+    xp: Optional[XP] = Field(None, alias="xp")
+
+
+class Payment(OrderCloudModel, Generic[XP]):
+    """An OrderCloud Payment.
+
+    Attributes:
+        id:
+        type:
+        date_created:  (read-only)
+        credit_card_id: Only writeable on create.
+        spending_account_id: Only writeable on create.
+        description:
+        currency: Inherited from order. (read-only)
+        amount: If null, payment applies to order total (or total of specific line items, if set), less any other payments where Amount is set. Value can only be negative if processing a payment for an order return.
+        accepted: All payments must be Accepted to submit an order. This property should be updated after authorizing or capturing the payment in your middleware by a user with the elevated OrderAdmin role.
+        order_return_id: Used to indicate this payment is associated with an order return.
+        xp:
+        transactions:  (read-only)
+    """
+
+    id: Optional[str] = Field(None, alias="ID")
+    type: Optional[PaymentType] = Field(None, alias="Type")
+    date_created: Optional[str] = Field(None, alias="DateCreated")
+    credit_card_id: Optional[str] = Field(None, alias="CreditCardID")
+    spending_account_id: Optional[str] = Field(None, alias="SpendingAccountID")
+    description: Optional[str] = Field(None, alias="Description")
+    currency: Optional[str] = Field(None, alias="Currency")
+    amount: Optional[float] = Field(None, alias="Amount")
+    accepted: Optional[bool] = Field(None, alias="Accepted")
+    order_return_id: Optional[str] = Field(None, alias="OrderReturnID")
+    xp: Optional[XP] = Field(None, alias="xp")
+    transactions: Optional[list[PaymentTransaction]] = Field(None, alias="Transactions")