Preview the cash impact of a reorder

POST /api/v1/inventory/reorder/cash-impact

Model the effect of placing one or more (not-yet-created) purchase orders on the 13-week cash forecast. Runs the live forecast with and without the proposed POs and returns the delta -- including how far the projected cash low point moves -- so the operator can see the cash impact of a reorder before committing to it.

Operation ID: reorder_cash_impact_api_v1_inventory_reorder_cash_impact_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: ReorderCashImpactRequest

proposed_pos array · ProposedPurchaseOrder ProposedPurchaseOrder

5 fields

amount_cents integer required: Total PO cost in cents.
week_number integer: Forecast week the cash leaves (1-indexed). Default 1.
expected_pay_date string: ISO date the cash leaves (overrides week_number).
variant_id string
label string

weeks integer

Responses

201 Successful Response

Schema: ReorderCashImpactResponse

proposed_total_cents integer

proposed_po_count integer

weeks integer

baseline_ending_cash_cents integer

scenario_ending_cash_cents integer

ending_cash_delta_cents integer

baseline_lowest_cash_cents integer

scenario_lowest_cash_cents integer

lowest_cash_delta_cents integer

baseline_lowest_cash_week integer

scenario_lowest_cash_week integer

week_deltas array · ReorderCashImpactWeekDelta ReorderCashImpactWeekDelta

5 fields

week integer required
start_date string required
baseline_ending_cash_cents integer required
scenario_ending_cash_cents integer required
delta_cents integer required

headline string

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/inventory/reorder/cash-impact

bash

curl -X POST 'https://api.ondayzero.com/api/v1/inventory/reorder/cash-impact' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "proposed_pos": [],
  "weeks": 0
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/inventory/reorder/cash-impact', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "proposed_pos": [],
  "weeks": 0
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "proposed_pos": [],
  "weeks": 0
}

response = httpx.post("https://api.ondayzero.com/api/v1/inventory/reorder/cash-impact", headers=headers, json=payload)
data = response.json()