THE GENERATED CONTRACT · v1
API reference
Every operation, grouped by the part of N1 it belongs to. Search by name, type or error with ⌘ K.
AUTH
Profile
SHOP SETUP
Users and roles
- MUTATIONcreateUserMock
Add a person to the shop
- MUTATIONresetUserPasswordMock
Set a new password for a locked-out person
- QUERYrolesMock
Every role and its permissions
- MUTATIONsetUserStatusMock
Mark a person active or inactive
- MUTATIONupdateUserMock
Change a person’s name, contact or role
- QUERYuserMock
One person by id
- QUERYusersMock
The shop’s people, paged
CUSTOMERS
ORDERS
QC
PLATFORM
APP
FILES
INVOICES
Invoices
- MUTATIONcreateInvoiceMock
Bill a job card, or enter an invoice by hand
- QUERYinvoiceMock
Open one invoice with lines, totals and payment
- QUERYinvoicesMock
Page through invoices by status and search
- QUERYinvoiceSummaryMock
Counts and amounts for the invoices header
- MUTATIONmarkInvoicePaidMock
Record the payment, with optional TDS
- MUTATIONupdateInvoiceMock
Change an unpaid invoice and re-total it
JOB CARDS
Job cards
- MUTATIONassignJobOperationMock
Give one step of a job card to an operator
- QUERYjobCardMock
One job card by id, with its operations
- QUERYjobCardByQrMock
Open a job card from the text of its QR code
- QUERYjobCardsMock
The shop’s job cards, paged, filterable and searchable
- QUERYmyJobsMock
The signed-in operator’s own job cards
MACHINES
Machines
- MUTATIONassignMachineMock
Run a job operation on a machine
- MUTATIONcreateMachineMock
Add a machine to the shop
- MUTATIONdeleteMachineMock
Remove a machine from the shop’s lists
- QUERYmachineMock
One machine by id, with its open assignment
- QUERYmachinesMock
The shop’s machines, paged, filterable and searchable
- MUTATIONreleaseMachineMock
End a machine’s open assignment
- MUTATIONsetMachineStatusMock
Take a machine into or out of maintenance
- MUTATIONupdateMachineMock
Rename a machine or change its kind
QUOTES
Quotes
- MUTATIONconvertQuoteToOrderMock
Turn a quote into one order, linked both ways
- MUTATIONcreateQuoteMock
Price a part and number the quote
- QUERYquoteMock
Open one quote with its lines and totals
- QUERYquotesMock
Page through the shop’s quotes
- MUTATIONsendQuoteMock
Mark a quote as sent to the customer
- MUTATIONupdateQuoteMock
Change a draft quote and re-price it