PhotoCopyOrder.GetExisting

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.

Path Parameters

Field Type Required Notes
workOrder string Yes Existing photocopy order number.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status Notes
200 OK Existing photocopy order was found.
404 Not Found Requested order was not found for the authenticated customer.

Success Body

Response type: PhotoCopyOrderResponse

This endpoint resolves exported work orders only. See the Order Lifecycle guide for how draft web order ids become exported work order ids.

Field Type Required Max Length Notes
workOrder string Yes Existing imported CWorkOrder number. When a pseudo-facility is requested, this includes the suffix from the route.
webOrder string Yes
referenceNumber string Yes
caseNumber string Yes
courtCode string Yes 12 Court code, not the court display name. See Court.Search, Court.GetAll, or Court.Get for court lookup details.
courtName string Yes Court display name used by Process Status.
courtAddress string Yes Court street address used by Process Status.
courtCity string Yes Court city used by Process Status.
courtState string Yes Court state used by Process Status.
courtZip string Yes Court ZIP used by Process Status.
attorney int? No
attorneyName string Yes Attorney display name used by Process Status.
billToAttorney int? No
plaintiff string Yes
defendant string Yes
representing string Yes
claimNumber string Yes Claim number used by Process Status.
billMe bool No
shipToMe bool No
releaseType int No
releaseTypeTitle string Yes Release type display title used by Process Status.
patientName string Yes
patientId string Yes
birthDate DateTime? No
injuryDate DateTime? No
specialInstructions string Yes
dateOrdered string Yes
dueDate string Yes
rush bool No
jobType string Yes Job type display title used by Process Status.
milestone string Yes Milestone display title used by Process Status.
hasStatusUpdates bool No True when status updates are returned.
hasInvoice bool No True when invoice lines are returned.
hasDownloads bool No True when downloadable work order attachments are returned.
statusUpdates List<PhotoCopyStatusUpdateResponse> No Status updates from CWorkOrderStatus. If a pseudo-facility suffix is supplied in workOrder, results are scoped to that facility.
invoice PhotoCopyInvoiceResponse No Latest CWorkOrderInvoiceHeader and detailed CWorkOrderInvoiceDetail price breakdown. Includes totalOrderPrice, priceComments, secondPriceComments, and line items.
downloads List<PhotoCopyDownloadResponse> No Downloadable CWorkorderAttachment records used by WinCopy.
images List<PhotoCopyRecordImageResponse> No Photocopy record S3 image metadata and presigned URLs.
billToParties List<PhotoCopyBillToPartyRequest> No
shipToParties List<PhotoCopyShipToPartyRequest> No
opposingCounsels List<PhotoCopyOpposingCounselRequest> No
facilities List<PhotoCopyFacilityRequest> No
documents List<PhotoCopyDocumentResponse> No

Invoice Fields

Field Type Notes
invoice.invoiceNumber string Latest invoice number for the work order/facility.
invoice.invoiceDate DateTime? Invoice date from CWorkOrderInvoiceHeader.
invoice.facilityLineItem int? Facility line item used for the invoice header.
invoice.priceComments string Price comments from CWorkOrderInvoiceHeader.Comments.
invoice.secondPriceComments string Additional price comments from CWorkOrderInvoiceHeader.SecondComments.
invoice.totalOrderPrice decimal Sum of invoice detail lines plus sales tax when present.
invoice.lines List<PhotoCopyInvoiceLineResponse> Detailed price breakdown for each order line, plus sales tax and total rows when applicable.

Response Sample

{
  "workOrder": "C123456-01",
  "webOrder": "C123456",
  "referenceNumber": "REF-12345",
  "caseNumber": "24STCV12345",
  "courtCode": "LASC",
  "courtName": "Los Angeles Superior Court",
  "courtAddress": "111 N Hill St",
  "courtCity": "Los Angeles",
  "courtState": "CA",
  "courtZip": "90012",
  "attorney": 123,
  "attorneyName": "Alex Attorney",
  "billToAttorney": 456,
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "representing": "Plaintiff",
  "claimNumber": "CLM-12345",
  "billMe": false,
  "shipToMe": false,
  "releaseType": 1,
  "releaseTypeTitle": "Medical Records",
  "patientName": "John Patient",
  "patientId": "PAT-12345",
  "birthDate": "2026-05-07T00:00:00",
  "injuryDate": "2026-05-07T00:00:00",
  "specialInstructions": "Call before delivery.",
  "dateOrdered": "05/07/2026",
  "dueDate": "05/14/2026",
  "rush": false,
  "jobType": "Records",
  "milestone": "In Progress",
  "hasStatusUpdates": true,
  "hasInvoice": true,
  "hasDownloads": true,
  "statusUpdates": [
    {
      "workOrder": "C123456",
      "facilityLineItem": 1,
      "lineItem": 1,
      "date": "2026-05-08T00:00:00",
      "time": "2026-05-08T09:30:00",
      "report": "Records requested.",
      "actionDate": null,
      "enteredBy": "CSR"
    }
  ],
  "invoice": {
    "invoiceNumber": "01",
    "invoiceDate": "2026-05-10T00:00:00",
    "facilityLineItem": 1,
    "priceComments": "Price approved by client.",
    "secondPriceComments": "",
    "totalOrderPrice": 125.00,
    "lines": [
      {
        "lineItem": 1,
        "title": "Records",
        "incomeAccountCode": "4000",
        "flatAmount": 0,
        "flatRate": 1.00,
        "units": 100,
        "totalAmount": 100.00,
        "taxable": true,
        "noCharge": false,
        "isSalesTaxLine": false,
        "isTotalLine": false
      },
      {
        "lineItem": 2,
        "title": "Total",
        "incomeAccountCode": "",
        "flatAmount": 0,
        "flatRate": 0,
        "units": 0,
        "totalAmount": 125.00,
        "taxable": false,
        "noCharge": false,
        "isSalesTaxLine": false,
        "isTotalLine": true
      }
    ]
  },
  "opposingCounsels": [
    {
      "name": "Opposing Counsel LLP",
      "adjuster": "Olivia Opposing",
      "address": "700 Counsel Rd",
      "city": "Los Angeles",
      "state": "CA",
      "zip": "90012",
      "phone": "2135550456",
      "consumer": "John Patient",
      "representing": "Defendant",
      "representativeName": "John Doe",
      "primaryOpposingCounsel": true,
      "handServeOpposing": false,
      "mailNotice": true,
      "emailNotice": false
    }
  ]
}