Intake an order-form PDF into a draft order

POST/api/v1/contracts/orders/intake-pdf

AI-extract an uploaded order-form PDF (referenced by its S3 key) into a DRAFT order for human review. Reuses the invoice document-extraction path. Upload the file first via the uploads endpoint, then pass the S3 key.

Operation ID: intake_order_pdf_api_v1_contracts_orders_intake_pdf_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: OrderPdfIntakeRequest

s3_keystringrequired: S3 key of the uploaded order-form PDF.
customer_idstring: Customer to attach the draft order to. When omitted, the extracted customer name is matched against existing customers.

Responses

201Successful Response

Schema: app__core__success__SuccessEnvelope_OrderResponse___1

successboolean
messagestring
codestring
dataapp__api__v1__schemas__orders__OrderResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/contracts/orders/intake-pdf

bash

curl -X POST 'https://api.ondayzero.com/api/v1/contracts/orders/intake-pdf' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "s3_key": "string"
}'