FileAndServeOrder.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: FileAndServeOrderRequest

Field Type Required Max Length Notes
webOrder string? No 20
orderType int Yes Order type code from FileAndServeOrder.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.
referenceNumber 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
department string Yes 50
room string Yes 50
hearingDate DateTime? No
advanceFees bool No
checkAttached bool No
callClientWithCaseNumber bool No
statuteFiling bool No
rushReturnConfirmed bool No
representingName string Yes 100
representingCode int? No
specialInstructions string Yes 500
documentsDescription string Yes 2000
servees List<FileAndServeServeeRequest> Yes At least one servee is required.
export bool No
documents List<FileAndServeDocumentRequest> 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.
orderType Integer from FileAndServeOrder.GetJobTypes Use the linked lookup endpoint to get valid file-and-serve job types for the tenant.
servees[].addresses[].addressType 1 Business, 2 Home, 3 Other, 4 Government, 5 Not a physical address Required on Create. WinServe address category.

Request Sample

{
  "webOrder": "W123456",
  "orderType": 201,
  "referenceNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "courtCode": "LASC",
  "caseNumber": "24STCV12345",
  "department": "Dept 12",
  "room": "Room 305",
  "hearingDate": "2026-05-07T09:00:00",
  "advanceFees": false,
  "checkAttached": false,
  "callClientWithCaseNumber": false,
  "statuteFiling": false,
  "rushReturnConfirmed": false,
  "representingName": "Acme Corporation",
  "representingCode": 123,
  "specialInstructions": "File and serve all parties.",
  "documentsDescription": "Summons and complaint",
  "servees": [
    {
      "partyBeingServed": "John Doe",
      "addresses": [
        {
          "addressType": 1,
          "businessName": "Acme Corporation",
          "street": "123 Main St",
          "suite": "Suite 100",
          "city": "Los Angeles",
          "state": "CA",
          "zip": "90012",
          "phone": "2135550100"
        }
      ],
      "serviceInstructions": "Serve before 5 PM.",
      "advanceFees": false,
      "amount": null,
      "agent": "Registered Agent",
      "fileProofOfService": true,
      "partyIsAnEntity": false
    }
  ],
  "export": false,
  "documents": [
    {
      "name": "summons.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, invalid request, invalid contact, or service/export failure.

Success Body

Response type: ExportedOrderResult

The response body is returned as ExportedOrderResult. File-and-serve exports create a court work order plus one or more process work orders; workOrderId is the court work order and generatedWorkOrders lists the court work order followed by each process work order.

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

Response Sample

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