Work orders

The shop's jobs on aircraft: one record per job, from the owner's call to the invoice. Owners, admins and technicians only.

26 endpoints · base URL https://api.aerscheduler.com

get/work-orders

List work orders

Owners, admins and technicians only (not dispatchers), on any aircraft, because a job carries the owner and money; everybody else gets 403 for any request. Defaults to the open jobs, oldest first (the job board); state=closed lists completed and cancelled jobs newest first.

Query parameters

state"open" | "closed" | "all"open (default), closed, or all.
resourceIdstringComma-separated aircraft ids: those aircraft's jobs.
billToOrgUserIdstringComma-separated member ids: the jobs billed to any of them.
ownerOrgUserIdstringComma-separated member ids: jobs on aircraft any of them owns, billed to them or not.
technicianOrgUserIdstringComma-separated member ids: jobs with any of them assigned as a technician.
locationIdstringComma-separated location ids: jobs on aircraft based at any of them.
reservationIdstringComma-separated booking ids: the jobs a maintenance booking holds.
qstringMatches the job number (1042, WO-1042), the tail number, the person billed, or the request.
limitintegerRows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
offsetintegerRows to skip, for paging. Defaults to 0.
sortstringField to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
order"asc" | "desc"asc (default) or desc. Only meaningful with sort.

Responses

200OKThe jobs.→ { data: WorkOrder[] }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders

Open a work order

Owners, admins and technicians only. Opens a job on an aircraft and gives it the organization's next number (from WO-1001). The person billed defaults to the aircraft's primary owner; send billToOrgUserId: null for the organization's own aircraft. Every id in the body must belong to this organization.

Request body

The job.

resourceIdrequiredintegerThe aircraft.
status"requested" | "scheduled" | "received" | "in_progress" | "waiting_owner" | "waiting_parts" | "ready"The stage a new job starts in; it starts open (never completed or cancelled). Defaults to requested. An in-the-shop stage stamps receivedAt.
complaintstring | nullWhat the owner asked for, in their words.
receivedAtstring | nullISO 8601 with an offset, e.g. 2026-10-14T09:30:00Z. Refused in the future, on a job that is requested or scheduled, and as null while the aircraft is at the shop.
promisedOnstring | nullThe day the shop told the owner it would be ready.
completedAtstring | nullISO 8601 with an offset. Only a completed job has one, it cannot be cleared while the job is completed, and it is refused in the future or before receivedAt.
hobbsIninteger | nullHobbs at arrival, in TENTHS of an hour (1234.5 hours is 12345). A changed reading in or out is also recorded on the aircraft's meter log (GET /resources/{id}/meters), linked to the job, and moves the aircraft's own meters as recording it there would; one dated before the aircraft's newest reading is kept as history only. See confirmLower.
tachIninteger | nullTach at arrival, in tenths.
hobbsOutinteger | nullHobbs at return to service, in tenths. Recorded on the aircraft's meter log as its return to service, like hobbsIn.
tachOutinteger | nullTach at return to service, in tenths.
customerNotesstring | nullNotes the owner may be shown.
internalNotesstring | nullThe shop's own notes.
holdOwnerNoticesbooleanOpen the job without telling the owners: no booked-in, arrived or ready notices until the hold is lifted. Default false.
billToOrgUserIdinteger | nullWho is billed: a member of this organization, usually the aircraft's owner. Null on the organization's own aircraft. Cannot change while an invoice is live. Chosen by an admin; a technician gets the aircraft's owner (403 otherwise).
reservationIdinteger | nullA maintenance booking on the same aircraft that holds the hangar slot. A booking with no mechanics of its own takes the job's technicians.
technicianOrgUserIdsinteger[]People with the technician role assigned. Replaces the whole list; somebody already on the job who lost the role may stay.
noInvoicebooleanClose a completed job without an invoice (true), or put it back to be billed (false). Refused on a job that is not completed or has a live invoice. Cleared when the job is reopened or invoiced. Admins only (403 otherwise).
laborRateCentsinteger | nullThis job's labor rate in cents an hour, for lines added from now on (lines already written keep their price); null to follow the customer's or the shop's. Admins only.
partsMarkupBpsinteger | nullThis job's parts markup in basis points (0 is at cost); null to follow the customer's or the shop's. Admins only.
outsideWorkMarkupBpsinteger | nullThis job's outside work markup in basis points; null to follow the customer's or the shop's. Admins only.
confirmLowerbooleanA reading in or out lower than the aircraft's own answers 409 METER_LOWER before anything saves; send again with this to record it as a correction.
confirmMaintenanceTriggerbooleanA reading that passes an inspection that grounds the aircraft answers 409 MAINTENANCE_TRIGGER (with details.triggers) before anything saves; send again with this to save it and ground the aircraft.

Responses

201CreatedThe new job.→ { data: WorkOrder }
400Bad RequestA field failed validation, or an id is not in this organization.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
409The readings in need confirming first: code is METER_LOWER or MAINTENANCE_TRIGGER. Nothing was saved.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resourceId":1}'
get/work-orders/{id}

Get a work order

Owners, admins and technicians only. 404 for an id that is not one of this organization's jobs.

Path parameters

idrequiredintegerThe work order id.

Responses

200OKThe job.→ { data: WorkOrder }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
patch/work-orders/{id}

Change a work order

Owners, admins and technicians only. Only the fields sent move. Everything a person changes is recorded in the audit trail, with the job's number, aircraft and the person billed.

Path parameters

idrequiredintegerThe work order id.

Request body

Any subset.

status"requested" | "scheduled" | "received" | "in_progress" | "waiting_owner" | "waiting_parts" | "ready" | "completed" | "cancelled"The stage the shop sets. Moving to an in-the-shop stage stamps receivedAt, and moving back to requested or scheduled clears it; completed stamps completedAt; reopening clears it. A job with a live invoice cannot be cancelled.
complaintstring | nullWhat the owner asked for, in their words.
receivedAtstring | nullISO 8601 with an offset, e.g. 2026-10-14T09:30:00Z. Refused in the future, on a job that is requested or scheduled, and as null while the aircraft is at the shop.
promisedOnstring | nullThe day the shop told the owner it would be ready.
completedAtstring | nullISO 8601 with an offset. Only a completed job has one, it cannot be cleared while the job is completed, and it is refused in the future or before receivedAt.
hobbsIninteger | nullHobbs at arrival, in TENTHS of an hour (1234.5 hours is 12345). A changed reading in or out is also recorded on the aircraft's meter log (GET /resources/{id}/meters), linked to the job, and moves the aircraft's own meters as recording it there would; one dated before the aircraft's newest reading is kept as history only. See confirmLower.
tachIninteger | nullTach at arrival, in tenths.
hobbsOutinteger | nullHobbs at return to service, in tenths. Recorded on the aircraft's meter log as its return to service, like hobbsIn.
tachOutinteger | nullTach at return to service, in tenths.
customerNotesstring | nullNotes the owner may be shown.
internalNotesstring | nullThe shop's own notes.
holdOwnerNoticesbooleanHold or release the owners' stage notices. Releasing it tells the owners where the job stands now (booked in, arrived or ready); sending findings also releases it.
billToOrgUserIdinteger | nullWho is billed: a member of this organization, usually the aircraft's owner. Null on the organization's own aircraft. Cannot change while an invoice is live. Chosen by an admin; a technician gets the aircraft's owner (403 otherwise).
reservationIdinteger | nullA maintenance booking on the same aircraft that holds the hangar slot. A booking with no mechanics of its own takes the job's technicians.
technicianOrgUserIdsinteger[]People with the technician role assigned. Replaces the whole list; somebody already on the job who lost the role may stay.
confirmLowerbooleanA reading in or out lower than the aircraft's own answers 409 METER_LOWER before anything saves; send again with this to record it as a correction.
confirmMaintenanceTriggerbooleanA reading that passes an inspection that grounds the aircraft answers 409 MAINTENANCE_TRIGGER (with details.triggers) before anything saves; send again with this to save it and ground the aircraft.

Responses

200OKThe job as it now stands.→ { data: WorkOrder }
400Bad RequestA field failed validation, an id is not in this organization, or the change is refused while an invoice is live.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
409The readings need confirming first: code is METER_LOWER or MAINTENANCE_TRIGGER. Nothing was saved.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X PATCH https://api.aerscheduler.com/work-orders/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"requested","complaint":"…"}'
delete/work-orders/{id}

Delete a work order

Admins only. For a job opened by mistake. A job that has ever had an invoice, voided or not, stays on the record: cancel it instead (status: cancelled). Its notifications are removed with it, the shop's and the owners'. The audit trail keeps a line saying it existed.

Path parameters

idrequiredintegerThe work order id.

Responses

204No ContentSuccess. No body.
400Bad RequestThe job has been invoiced.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot an admin.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X DELETE https://api.aerscheduler.com/work-orders/:id \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
get/work-orders/settings

Get the shop's rates

Owners, admins and technicians only. The labor rate and default markups that price new lines.

Responses

200OKThe rates.→ { data: WorkOrderSettings }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/settings \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
put/work-orders/settings

Change the shop's rates

Admins only. Any subset. Lines already on jobs keep their price.

Request body

Any subset.

laborRateCentsinteger | null
partsMarkupBpsinteger | null
outsideWorkMarkupBpsinteger | null

Responses

200OKThe rates.→ { data: WorkOrderSettings }
400Bad RequestFailed validation.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot an admin.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X PUT https://api.aerscheduler.com/work-orders/settings \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"laborRateCents":1,"partsMarkupBps":1}'
get/work-orders/{id}/approvals

List the owner's answers

Owners, admins and technicians only. The phone calls recorded on a job, newest first.

Path parameters

idrequiredintegerThe work order id.

Query parameters

limitintegerRows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
offsetintegerRows to skip, for paging. Defaults to 0.
sortstringField to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
order"asc" | "desc"asc (default) or desc. Only meaningful with sort.

Responses

200OKThe calls.→ { data: WorkOrderApproval[] }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id/approvals \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/approvals

Record the owner's answer

Owners, admins and technicians only. A record of a phone call, not an owner approval flow: who was reached, when (defaults to the moment it is recorded), the spend limit, notes, and approved, declined or deferred for each item discussed. Every item must be on this job. An item a LATER call (or the owner, in AerScheduler) already answered keeps that answer: the call still records what was said, and the item is listed in kept. A job at Waiting on owner goes back to In progress when this answers the last finding sent that was waiting. Refused with a 409 while the job has a live invoice: void it to change the work.

Path parameters

idrequiredintegerThe work order id.

Request body

The call.

contactNamerequiredstring
contactedAtstringISO 8601 with an offset. Refused in the future.
spendLimitCentsinteger | null
notesstring | null
decisionsrequiredobject[]

Responses

201CreatedThe call, and what took its answer.→ { data: object }
400Bad RequestFailed validation, or an item is not on this job.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
409The job is invoiced: void the invoice to change the work.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/approvals \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"contactName":"…","decisions":[]}'
get/work-orders/{id}/files

List a job's files

Photos and documents on the job and on its items. url is a link that works for 15 minutes; visibility is shop (the shop's own) or owner (one the owner may be shown). Owners, admins and technicians only; anybody else is answered 403 for any id.

Path parameters

idrequiredintegerThe work order id.

Query parameters

limitintegerRows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
offsetintegerRows to skip, for paging. Defaults to 0.
sortstringField to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
order"asc" | "desc"asc (default) or desc. Only meaningful with sort.

Responses

200OKThe files, oldest first.→ { data: WorkOrderFile[] }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot a work-order role.
404Not FoundWork order not found.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id/files \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/files

Attach files to a job

Send fileNames (up to 5 per request; jpg, png, heic or pdf), optionally itemId to put them on one item, visibility (shop by default) and a label for a single file. The answer has the new rows in data and, in the same order, signedUrlData: a presigned POST for each file, which the client posts the bytes to. A job holds up to 60 files. Refused in the demo. Files may be added after the job is invoiced.

Path parameters

idrequiredintegerThe work order id.

Request body

The files to attach.

fileNamesstring[]
itemIdinteger | nullOne of this job's items.
visibility"shop" | "owner"
labelstring | null

Responses

201CreatedThe rows and where to upload each file.
400Bad RequestA file name, the item or the count is not valid.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot allowed, or the demo.
404Not FoundWork order not found.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/files \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileNames":[],"itemId":1}'
post/work-orders/{id}/invoice

Raise a job's invoice

Admins only. Raises the job's invoice to the person billed, as a work order bill linked to the job, through Stripe in both billing modes (never onto an account balance), with sales tax by the organization's rules. One live invoice per job: void it to raise another. Send expectedTotal and expectedDetails from the preview; a 409 carries the current total if either moved. Refused in the public demo.

Path parameters

idrequiredintegerThe work order id.

Request body

Optional.

expectedTotalintegerThe total the preview showed, in cents. Anything but a whole number is refused.
expectedDetailsstringThe preview's details.hash: refused with a 409 (data.details true) if the notes for the owner or the finished work changed since.
dueInintegerDays until due.
includeUnsentbooleanBill the findings in the preview's ownerNotTold anyway. Without it, a bill charging for a finding never sent to the owner is refused with a 409.
includeUnansweredbooleanBill the findings in the preview's awaitingAnswer anyway. Without it, a bill charging for a finding still waiting on the owner's answer is refused with a 409.

Responses

201CreatedThe invoice.→ { data: Invoice }
400Bad RequestNobody billed, nothing billable, an owner with no address, or the job already has an invoice.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot an admin, or the demo.
404Not FoundNot one of this organization's jobs.
409With data.total: the total (or, with data.details, the invoice's text) moved since it was priced, and that is the current total. Without it: findings with charges were never sent to the owner (send includeUnsent to bill them anyway) or are still waiting on the owner's answer (send includeUnanswered), or the job changed while the invoice was being made, and that invoice was voided (or Stripe would not void it: void it in Billing).
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/invoice \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedTotal":1,"expectedDetails":"…"}'
get/work-orders/{id}/items

List a job's items

Owners, admins and technicians only. In order. 404 for a job that is not this organization's.

Path parameters

idrequiredintegerThe work order id.

Query parameters

limitintegerRows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
offsetintegerRows to skip, for paging. Defaults to 0.
sortstringField to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
order"asc" | "desc"asc (default) or desc. Only meaningful with sort.

Responses

200OKThe items.→ { data: WorkOrderItem[] }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id/items \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/items

Add an item to a job

Owners, admins and technicians only. Something the owner asked for (requested) or the shop found (found). Attach an open inspection or squawk on the same aircraft and the item is done when that is signed off or resolved.

Path parameters

idrequiredintegerThe work order id.

Request body

The item.

sourcerequired"requested" | "found"
descriptionrequiredstring
maintenanceReminderIdintegerAn open inspection on the job's aircraft.
squawkIdintegerAn open squawk on the job's aircraft.

Responses

201CreatedThe item.→ { data: WorkOrderItem }
400Bad RequestFailed validation.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/items \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"requested","description":"…"}'
get/work-orders/{id}/lines

List a job's lines

Owners, admins and technicians only. In order.

Path parameters

idrequiredintegerThe work order id.

Query parameters

limitintegerRows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected.
offsetintegerRows to skip, for paging. Defaults to 0.
sortstringField to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding.
order"asc" | "desc"asc (default) or desc. Only meaningful with sort.

Responses

200OKThe lines.→ { data: WorkOrderLine[] }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id/lines \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/lines

Add a line

Owners, admins and technicians only. Labor is priced from minutes at rateCents (the shop rate by default); a part or outside work from costCents plus the markup (the organization default by default) unless unitPriceCents is sent. A line can be at most $999,999.99. Refused once the job has a live invoice.

Only an admin prices. Anyone else in the shop sends rateCents, markupBps, billable and taxable only with the shop's defaults, and unitPriceCents only for supplies, freight, fees and other (403 otherwise).

Path parameters

idrequiredintegerThe work order id.

Request body

The line.

categoryrequired"labor" | "part" | "supply" | "outside_service" | "freight" | "fee" | "other"
descriptionrequiredstring
qtyintegerNot for labor (always 1).
costCentsinteger | nullParts and outside work: what the shop paid per unit. Priced with the markup when no price is sent.
markupBpsinteger | nullOverrides the organization's default markup (parts and outside work). Admin only.
unitPriceCentsintegerThe customer's price per unit. For labor, a flat charge instead of hours at the rate.
discountBpsinteger | nullA discount on the line in basis points (1000 is 10% off), applied per unit before tax and said on the invoice line. Admin only.
taxableboolean | nullDecide the tax on this line; null follows the organization's rule.
billableboolean
minutesintegerLabor: clock minutes.
rateCentsinteger | nullLabor: overrides the shop rate. Admin only.
workedOnstring | null
technicianOrgUserIdinteger | nullLabor: who did the work, a person with the technician role.
partNumberstring | null
serialNumberstring | null
vendorstring | null
partStatusstring | null
orderedOnstring | null
expectedOnstring | null
itemIdinteger | nullAn item on the same job.

Responses

201CreatedThe line.→ { data: WorkOrderLine }
400Bad RequestFailed validation, or the job is invoiced.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/lines \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"labor","description":"…"}'
get/work-orders/{id}/send-to-owner

Who a send would reach

Owners, admins and technicians only. Who Send to owner would reach on this job right now, by the same rules as the send, sending nothing: the aircraft's owners and the person billed, less the caller. blocked says why a send would reach nobody (no owner on record, nobody with an address, or the caller is the only owner), and is null when it would reach somebody.

Path parameters

idrequiredintegerThe work order id.

Responses

200OKWho it would reach.→ { data: object }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl https://api.aerscheduler.com/work-orders/:id/send-to-owner \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/send-to-owner

Send findings to the owners

Owners, admins and technicians only. Sends the found items still waiting on an answer that have not been sent yet to every owner of the aircraft and the person billed, in one message (prices only to the person billed). An owner who has not signed up is emailed at the address on record, with a way to sign up. Until a finding is sent the owners are not shown it. A job in Received or In progress moves to Waiting on owner, and back to In progress once every finding sent is answered. Answers 409 when there is nothing new to send, or when nobody can be reached, with the reason (nothing is marked sent then). GET on the same path says who would be reached before sending.

Path parameters

idrequiredintegerThe work order id.

Responses

201CreatedSent.→ { data: object }
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
409Nothing new to send, or nobody could be reached.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/send-to-owner \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
patch/work-orders/{id}/files/{fileId}

Change a job's file

Its label, its visibility, or the item it is on (itemId, null for the job itself).

Path parameters

idrequiredintegerThe work order id.
fileIdrequiredintegerThe file id.

Request body

The fields to change.

labelstring | null
visibility"shop" | "owner"
itemIdinteger | null

Responses

200OKThe file.→ { data: WorkOrderFile }
400Bad RequestA field is not valid.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot allowed.
404Not FoundFile not found.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X PATCH https://api.aerscheduler.com/work-orders/:id/files/:fileId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"…","visibility":"shop"}'
delete/work-orders/{id}/files/{fileId}

Remove a job's file

It stops listing; the stored object is kept.

Path parameters

idrequiredintegerThe work order id.
fileIdrequiredintegerThe file id.

Responses

204No ContentSuccess. No body.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot allowed.
404Not FoundFile not found.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X DELETE https://api.aerscheduler.com/work-orders/:id/files/:fileId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/invoice/preview

Price a job's invoice

Admins only. The bill as it would be raised now: the job's billable lines, each with its sales tax, the organization's service fee, and the total. Priced by the same code as the invoice. Lines on an item the owner declined or deferred are left off (leftOff).

Path parameters

idrequiredintegerThe work order id.

Responses

200OKThe priced bill.→ { data: object }
400Bad RequestNobody billed, nothing billable (or everything with charges was declined or deferred), the job was cancelled, or a line is marked taxable with no sales tax rate to charge it at (code: TAX_RATE_MISSING; add one under Settings, Billing, Sales tax).
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenNot an admin.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/invoice/preview \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
patch/work-orders/{id}/items/{itemId}

Change an item

Owners, admins and technicians only. Reword it, or mark a plain item done (done: true) or not. An item tied to an inspection or squawk is refused: sign off the inspection or resolve the squawk. Rewording a found item the owner was sent or answered (and not done) clears its answer and its send: it must be asked again. On a job that is invoiced or closed it cannot be asked again, so the wording changes and the answer stands. Ticking, rewording or removing a finding that was waiting on the owner may move a job at Waiting on owner back to In progress; unticking one that was sent and not answered moves a job at Received or In progress to Waiting on owner.

Path parameters

idrequiredintegerThe work order id.
itemIdrequiredintegerThe item id.

Request body

Any subset.

descriptionstring
doneboolean

Responses

200OKThe item.→ { data: WorkOrderItem }
400Bad RequestFailed validation.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot this job's item.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X PATCH https://api.aerscheduler.com/work-orders/:id/items/:itemId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"…","done":true}'
delete/work-orders/{id}/items/{itemId}

Remove an item

Owners, admins and technicians only. Lines charged against it stay on the job. A finding on a customer's aircraft never sent to the owner, answered or done, that still has charges on it, is refused: take its lines off first, or send it to the owner.

Path parameters

idrequiredintegerThe work order id.
itemIdrequiredintegerThe item id.

Responses

204No ContentSuccess. No body.
400Bad RequestA finding the owner was never told about that still has charges.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot this job's item.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X DELETE https://api.aerscheduler.com/work-orders/:id/items/:itemId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
post/work-orders/{id}/items/ads

Add the aircraft's ADs to review

Owners, admins and technicians only. Adds a found item for each AD the AD library lists against the job's aircraft that nobody has decided (done when the AD is decided on the aircraft, doneVia: ad), and one for each AD inspection on it that is overdue or due soon (done when signed off). Anything already on the job is skipped, so a second call adds nothing. 400 on a closed job.

Path parameters

idrequiredintegerThe work order id.

Responses

200OKSuccess.→ { data: object }
400Bad RequestThe job is closed.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot one of this organization's jobs.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X POST https://api.aerscheduler.com/work-orders/:id/items/ads \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"
patch/work-orders/{id}/lines/{lineId}

Change a line

Owners, admins and technicians only. Any subset; the line is re-priced only when its hours, rate, cost or markup CHANGE and no price is sent, so resending them keeps a price set by hand. Refused once the job has a live invoice. Somebody other than an admin changes only the lines they entered, and only as on create.

Path parameters

idrequiredintegerThe work order id.
lineIdrequiredintegerThe line id.

Request body

Any subset.

category"labor" | "part" | "supply" | "outside_service" | "freight" | "fee" | "other"
descriptionstring
qtyintegerNot for labor (always 1).
costCentsinteger | nullParts and outside work: what the shop paid per unit. Priced with the markup when no price is sent.
markupBpsinteger | nullOverrides the organization's default markup (parts and outside work). Admin only.
unitPriceCentsintegerThe customer's price per unit. For labor, a flat charge instead of hours at the rate.
discountBpsinteger | nullA discount on the line in basis points (1000 is 10% off), applied per unit before tax and said on the invoice line. Admin only.
taxableboolean | nullDecide the tax on this line; null follows the organization's rule.
billableboolean
minutesintegerLabor: clock minutes.
rateCentsinteger | nullLabor: overrides the shop rate. Admin only.
workedOnstring | null
technicianOrgUserIdinteger | nullLabor: who did the work, a person with the technician role.
partNumberstring | null
serialNumberstring | null
vendorstring | null
partStatusstring | null
orderedOnstring | null
expectedOnstring | null
itemIdinteger | nullAn item on the same job.

Responses

200OKThe line.→ { data: WorkOrderLine }
400Bad RequestFailed validation, or the job is invoiced.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot this job's line.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X PATCH https://api.aerscheduler.com/work-orders/:id/lines/:lineId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"labor","description":"…"}'
delete/work-orders/{id}/lines/{lineId}

Remove a line

Owners, admins and technicians only. Refused once the job has a live invoice. Somebody other than an admin removes only the lines they entered.

Path parameters

idrequiredintegerThe work order id.
lineIdrequiredintegerThe line id.

Responses

204No ContentSuccess. No body.
400Bad RequestThe job is invoiced.
401UnauthorizedNo token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again.
403ForbiddenAuthenticated, but not allowed to do this.
404Not FoundNot this job's line.
429Too Many RequestsRate limited. Retry-After says how long to wait.
Example request
curl -X DELETE https://api.aerscheduler.com/work-orders/:id/lines/:lineId \
  -H "Authorization: Bearer $AERSCHEDULER_KEY"