WorkItems

Create a work item

Creates a work item of the given type, seeded at the initial draft state. data is the schemaless, work-type-specific bag validated per type. Internal-only: a work item names the client it bills (ownerId) and may carry performer payout amounts, so only internal (Proof) actors may create one. An unknown or disabled work type is rejected with 422.

post/v2/work-items

Request

  • Base URL: https://api-docs.proofserve.com
  • URL: https://api-docs.proofserve.com/v2/work-items
  • Auth: none declared

Request body

workTypestring required

Stable identifier for a work type, as registered in the work-type registry. Deliberately an open string rather than an enum: work types are plug-ins, and the set is served by GET /v2/work-types — pinning it here would make adding one a five-artifact change (Go implementation, registry line, this spec, Go regen, webapp regen) and would give clients a literal union that has to be widened in lockstep with the server. Nothing validates it against this schema; an unregistered code is rejected at runtime with 422.

ownerIdinteger required

User id of the client the work item is billed to. Required — the completion invoice leg bills this user.

lawFirmIdinteger nullable

Law firm id of the owner, carried for invoicing. Optional; omit or null when the owner has no firm.

dataobject nullable

Work-type-specific fields to seed onto the item. A work type's court-picker field (court pickup's courtId) carries the selected court id here; the server resolves it into the pickup address and pricing county and stashes the court/county display names alongside it. A document-upload field carries staged upload keys (from POST /document-uploads) here; the server promotes them into attached documents and does not store them in the data bag.

Example request

{
  "workType": "court_pickup"
}

Response

The created work item.

Example response

{
  "data": {
    "workType": "court_pickup",
    "title": "Jefferson County Circuit Court · 24-CV-00123",
    "status": "ready_for_pickup",
    "instruction": "Call the court before heading there.",
    "documents": [
      {
        "kind": "scanned_copy",
        "kindLabel": "Scanned copy"
      }
    ],
    "lineItems": [
      {
        "description": "Court pickup fee"
      }
    ],
    "totalPayoutAmountCents": 2500
  },
  "meta": {
    "requestId": "req_8xKp2mN4"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.