{"openapi":"3.1.0","info":{"title":"GET /api/v1/inventory/landed-cost-allocations/{bill_id}","version":"1.0.0","description":"List a bill's landed cost allocations"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/inventory/landed-cost-allocations/{bill_id}":{"get":{"tags":["inventory:landed_cost_allocations"],"summary":"List a bill's landed cost allocations","description":"Return every landed-cost allocation recorded for the bill plus a reconciliation summary (allocated vs. unallocated cents).","operationId":"list_allocations","parameters":[{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LandedCostAllocationListResponse_"}}}},"401":{"description":"Unauthorized - Missing/invalid token or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_allocations_api_v1_inventory_landed_cost_allocations__bill_id__get"}}},"components":{"schemas":{"AllocationBasis":{"type":"string","enum":["quantity","value"],"title":"AllocationBasis","description":"How a per-PO allocation amount is split across the PO's variants."},"LandedCostAllocationListResponse":{"properties":{"bill_id":{"type":"string","title":"Bill Id"},"bill_amount_cents":{"type":"integer","title":"Bill Amount Cents","default":0},"allocated_cents":{"type":"integer","title":"Allocated Cents","default":0},"unallocated_cents":{"type":"integer","title":"Unallocated Cents","default":0},"items":{"items":{"$ref":"#/components/schemas/LandedCostAllocationResponse"},"type":"array","title":"Items"}},"type":"object","required":["bill_id"],"title":"LandedCostAllocationListResponse","description":"All allocations for a bill plus a reconciliation summary."},"LandedCostAllocationResponse":{"properties":{"id":{"type":"string","title":"Id"},"bill_id":{"type":"string","title":"Bill Id"},"inventory_order_id":{"type":"string","title":"Inventory Order Id"},"po_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Po Number"},"cost_layer":{"$ref":"#/components/schemas/LandedCostLayer"},"allocation_basis":{"$ref":"#/components/schemas/AllocationBasis"},"amount_cents":{"type":"integer","title":"Amount Cents"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"variant_count":{"type":"integer","title":"Variant Count","default":0},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","bill_id","inventory_order_id","cost_layer","allocation_basis","amount_cents"],"title":"LandedCostAllocationResponse","description":"One persisted allocation row, enriched with PO display fields."},"LandedCostLayer":{"type":"string","enum":["freight","duties","handling"],"title":"LandedCostLayer","description":"Landed-cost layer a bill allocation contributes to.\n\nMirrors the non-material, non-packaging layers on ``CostSnapshot``.\nMaterial/packaging/processing are derived from the PO/recipe, not from\nstandalone landed-cost bills, so they are intentionally excluded here."},"SuccessEnvelope_LandedCostAllocationListResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/LandedCostAllocationListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[LandedCostAllocationListResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}