CourtOrder.Create

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

JSON Body

Body type: CourtOrderRequest

Field Type Required Max Length Notes
webOrder string? No 20
jobTypeCode int Yes Job type code from CourtOrder.GetJobTypes.
adjusterCode int? Yes Canonical property name. Attorney code from Attorney.GetAll. Do not send adjuster, attorney, or attorneyCode. Required on Create; SaveDraft is lenient.
billToAdjusterCode int? No Bill-to attorney code from BillTo.GetAttorneys. Defaults to adjusterCode when omitted.
theirFileNumber string Yes 35
plaintiff string Yes 600
defendant string Yes 600
courtCode string Conditional 12 Court code, not the court display name. Required unless court override is used. Use Court.Search, Court.GetAll, or Court.Get to retrieve valid court codes.
caseNumber string Yes 100
claimNumber string Conditional 50 Required when the bill-to customer is an insurance customer.
department string Yes 50
room string Yes 50
hearingDate DateTime? No
copyType string Yes
courtFile bool No
advanceFees bool No
advanceFeeAmount decimal? No
checkAttached bool No
checkAttachedAmount decimal? No
courtesyCopyDelivery bool No
statuteFiling bool No
eServe bool No
callClientWithCaseNumber bool No
rushReturnConformed bool No
researchCopy bool No
caseType int Yes
specialInstructions string Yes 500
documentsDescription string Yes 2000
export bool No When true, the saved draft is immediately exported and the response includes both webOrderId and workOrderId. When omitted or false, the response is only the draft webOrder string.
documents List<CourtOrderDocumentRequest> Conditional Required when the selected job type requires uploads.

Type / Enum Values

Field Allowed Values Notes
courtCode code from Court.Search, Court.GetAll, or Court.Get Send the court code, not the court name/description.
copyType StandardCopy, CertifiedCopy Maps to CourtCopyTypeEnum.
caseType 0 Other, 1 SmallClaims, 2 Probate, 3 FamilyLaw, 4 Complex, 5 Civil Maps to CourtCaseTypeEnum.
jobTypeCode Integer from CourtOrder.GetJobTypes Must be a code returned by the linked lookup. Invalid codes return 400 with a jobTypeCode validation error.

Request Sample

{
  "webOrder": "W123456",
  "jobTypeCode": 101,
  "adjusterCode": 123,
  "billToAdjusterCode": 456,
  "theirFileNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "courtCode": "LASC",
  "caseNumber": "24STCV12345",
  "claimNumber": "CLM-12345",
  "department": "Dept 12",
  "room": "Room 305",
  "hearingDate": "2026-05-07T09:00:00",
  "copyType": "StandardCopy",
  "courtFile": true,
  "advanceFees": false,
  "advanceFeeAmount": null,
  "checkAttached": false,
  "checkAttachedAmount": null,
  "courtesyCopyDelivery": false,
  "statuteFiling": false,
  "eServe": false,
  "callClientWithCaseNumber": false,
  "rushReturnConformed": false,
  "researchCopy": false,
  "caseType": 5,
  "specialInstructions": "Call before filing.",
  "documentsDescription": "Summons and complaint",
  "export": false,
  "documents": [
    {
      "name": "supporting-document.pdf",
      "id": "doc-123",
      "base64": "JVBERi0xLjQ="
    }
  ]
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request Validation (including unknown jobTypeCode), invalid request, invalid contact, or service/export failure.

Success Body

Response type: string when export is omitted or false; exported order result when export is true.

Use CourtOrder.GetDraft/{webOrder} with the draft web order returned from non-exported creates. Use CourtOrder.GetExisting/{workOrder} with the workOrderId returned only after export.

See the Order Lifecycle guide for how draft web order ids become exported work order ids.

Draft Response Sample

"W123456"

Exported Response Sample

{
  "webOrderId": "W123456",
  "workOrderId": "C123456",
  "generatedWorkOrders": [
    {
      "workOrder": "C123456",
      "servee": null
    }
  ]
}