ITMS API — POST /api/v1/provider/batches/generate

Prepare or explicitly refresh a governed batch of filing packages through the same workflow as Provider Console.

POST/api/v1/provider/batches/generate

Prepare or explicitly refresh a governed batch of filing packages through the same workflow as Provider Console.

Persistence: Creates an auditable batch and preparation work. It does not grant filing, remittance, or approval authority. Production only.
Auth: Production provider API key · scope provider:return-jobs:write · governed provider authority enforced
Request: Optional client_org_ids and states filters, refresh_existing, and up to 10,000 exact work_items; explicit refresh requires work_items. Idempotency-Key is supported.
Response: HTTP 202 with batch_id, service_provider_id, status, progress_pct, created, child_count, children, requested_states, and created_at

Request template for this operation

Set ITMS_API_KEY to a key with the scope shown above. Use a sandbox key while developing. Create request.json from this operation’s OpenAPI request schema for cURL, and set ITMS_REQUEST_BODY to that same JSON for JavaScript or Python. Do not copy production customer data into a sandbox request.

cURL

curl --request POST \
  --url "${ITMS_BASE_URL:-https://prophit.ai}/api/v1/provider/batches/generate" \
  --header "Authorization: Bearer ${ITMS_API_KEY}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

JavaScript (Node 18+)

const requiredEnv = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name} before running this request.`);
  return value;
};
const requestBody = JSON.parse(requiredEnv("ITMS_REQUEST_BODY"));
const path = `/api/v1/provider/batches/generate`;
const response = await fetch(`${process.env.ITMS_BASE_URL ?? 'https://prophit.ai'}${path}`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${requiredEnv('ITMS_API_KEY')}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(requestBody),
});
const requestId = response.headers.get('x-request-id');
const payload = response.status === 204 ? null : await response.json();
if (!response.ok) throw Object.assign(new Error(payload?.error?.message), { code: payload?.error?.code, requestId });
console.log({ requestId, payload });

Python

import os
import json
import requests

def required_env(name):
    value = os.getenv(name)
    if not value:
        raise RuntimeError(f"Set {name} before running this request.")
    return value

request_body = json.loads(required_env("ITMS_REQUEST_BODY"))
path = f"/api/v1/provider/batches/generate"
response = requests.request(
    "POST",
    f"{os.getenv('ITMS_BASE_URL', 'https://prophit.ai')}{path}",
    headers={
        "Authorization": f"Bearer {required_env('ITMS_API_KEY')}",
    },
    json=request_body,
    timeout=30,
)
request_id = response.headers.get("x-request-id")
if not response.ok:
    error = response.json().get("error", {})
    raise RuntimeError(f"{error.get('code')}: {error.get('message')} (request_id={request_id})")
print(None if response.status_code == 204 else response.json())

Request and response shape

Request: Optional client_org_ids and states filters, refresh_existing, and up to 10,000 exact work_items; explicit refresh requires work_items. Idempotency-Key is supported.
Response: HTTP 202 with batch_id, service_provider_id, status, progress_pct, created, child_count, children, requested_states, and created_at

The versioned OpenAPI document is the machine-readable authority for required fields, types, enums, response schemas, and status codes. This page supplies the product and workflow context around that contract.

Integration contract

Use a key whose environment, organization, location, and scopes match the operation.
Validate the request against the customer OpenAPI document; never infer omitted required facts.
For create, apply, commit, refund, adjustment, or replay operations, follow the documented idempotency and duplicate semantics.
Persist the response request ID, result authority, warnings, and evidence references needed to reproduce the decision.
Handle the machine-readable error envelope and honor rate-limit retry headers.

POST /api/v1/provider/batches/generate