receivingorderep

type AllocationRequest struct {
	// ID of the storage location to put the quantity away at.
	//
	// When omitted, the inventory receipt is created without a storage location.
	LocationID field.Optional[string] `json:"location_id,omitzero"`
	// Quantity to allocate, as a decimal string.
	Quantity string `json:"quantity"`
}

type ListReceivingOrdersEndpoint struct{}

type ListReceivingOrdersRequest struct {
	apiresource.PaginationRequest
	// Filter by completion status.
	//
	// Completed orders are hidden when this is omitted.
	Status *constants.ReceivingOrderStatus `query:"status"`
	// Filter to orders that have at least one line for any of the given item IDs.
	ItemIDs []string `query:"item_ids"`
	// Filter to orders whose originating purchase order was placed with any of the given supplier account IDs.
	SupplierIDs []string `query:"supplier_ids"`
	// Only return orders created on or after this date (`YYYY-MM-DD`).
	StartDate *string `query:"starts_at"`
	// Only return orders created on or before this date (`YYYY-MM-DD`), covering that whole day.
	EndDate *string `query:"ends_at"`
}

type ReceiveReceivingOrderEndpoint struct{}

type ReceiveReceivingOrderLineEndpoint struct{}

type ReceiveReceivingOrderLineRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"receiving_order_id" validate:"required"`
	// Receiving order line ID.
	LineID string `path:"id" validate:"required"`
}

type ReceiveReceivingOrderRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"id" validate:"required"`
}

type ReceivingOrderSvc interface {
	ListReceivingOrders(ctx context.Context, req *ListReceivingOrdersRequest) (*apiresource.List[apiresource.ReceivingOrder], *apierror.APIError)
	GetReceivingOrder(ctx context.Context, req *RetrieveReceivingOrderRequest) (*apiresource.ReceivingOrder, *apierror.APIError)
	StockReceivingOrder(ctx context.Context, req *StockReceivingOrderRequest) (*apiresource.ReceivingOrder, *apierror.APIError)
	ReceiveReceivingOrder(ctx context.Context, req *ReceiveReceivingOrderRequest) (*apiresource.ReceivingOrder, *apierror.APIError)
	VoidReceivingOrder(ctx context.Context, req *VoidReceivingOrderRequest) (*apiresource.ReceivingOrder, *apierror.APIError)
	UpdateReceivingOrderLine(ctx context.Context, req *UpdateReceivingOrderLineRequest) (*apiresource.ReceivingOrderLine, *apierror.APIError)
	VoidReceivingOrderLine(ctx context.Context, req *VoidReceivingOrderLineRequest) (*apiresource.ReceivingOrderLine, *apierror.APIError)
	ReceiveReceivingOrderLine(ctx context.Context, req *ReceiveReceivingOrderLineRequest) (*apiresource.ReceivingOrderLine, *apierror.APIError)
}

type ReceivingOrderSvcConfig struct {
	// CoreClient (required) is the core-service receiving gRPC client.
	CoreClient pb.CoreReceivingServiceClient
}

type RetrieveReceivingOrderEndpoint struct{}

type RetrieveReceivingOrderRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"id" validate:"required"`
}

type StockLineItemRequest struct {
	// ID of the receiving order line being stocked.
	ReceivingOrderLineID string `json:"receiving_order_line_id"`
	// Lot number to record for the received goods.
	//
	// A lot is created for the line's item if one with this number does not already exist for it. The lot applies to every allocation and to any rejected quantity on this line item.
	LotNumber field.Optional[string] `json:"lot_number,omitzero"`
	// Quantity refused on inspection, as a decimal string.
	//
	// The refused quantity is recorded on the delivery and on the receiving order line's `rejected_quantity`, but never enters inventory.
	RejectedQuantity field.Optional[string] `json:"rejected_quantity,omitzero"`
	// Storage allocations for the quantity being accepted.
	//
	// Each allocation creates an inventory receipt for the given quantity at the given location, so a single line can be split across several locations.
	Allocations []AllocationRequest `json:"allocations,omitzero"`
}

type StockReceivingOrderEndpoint struct{}

type StockReceivingOrderRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"id" validate:"required"`
	// Per-line stocking details: where to put the goods away, which lot to record them under, and how much was refused on inspection.
	//
	// Unstocked lines left out of this list are still marked as stocked, but nothing is added to inventory for them and they contribute no delivery lines.
	LineItems []StockLineItemRequest `json:"line_items,omitzero"`
}

type UpdateReceivingOrderLineEndpoint struct{}

type UpdateReceivingOrderLineRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"receiving_order_id" validate:"required"`
	// Receiving order line ID.
	LineID string `path:"id" validate:"required"`
	// New received quantity for the line, as a decimal string.
	//
	// When omitted, the line is returned unchanged.
	QuantityValue field.Optional[string] `json:"quantity_value,omitzero"`
}

type VoidReceivingOrderEndpoint struct{}

type VoidReceivingOrderLineEndpoint struct{}

type VoidReceivingOrderLineRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"receiving_order_id" validate:"required"`
	// Receiving order line ID.
	LineID string `path:"id" validate:"required"`
}

type VoidReceivingOrderRequest struct {
	// Receiving order ID.
	ReceivingOrderID string `path:"id" validate:"required"`
}