This section documents breaking and dangerous changes made to active versions of our GraphQL API. To see full details about versioning, see here. Any additive or non-breaking changes are not documented in our changelog.
Client
was added to Union type NoteCreatedByUnion
Package
was removed from enum WorkItemCategoryTypeEnum
PACKAGE
was removed from enum ProductsAndServicesCategory
previewUrl
was removed from object type Quote
previewUrl
was removed from object type Invoice
ClientEditInput.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
ClientCreateInput.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldCreateInput!]
PropertyAttributes.address
changed type from AddressAttributes
to AddressAttributes!
attachmentsConnection
was removed from object type ClientNote
attachments
was removed from object type ClientNote
valueUrl
was removed from object type CustomFieldLink
valueText
was removed from object type CustomFieldLink
CustomFieldSelect
was removed from Union type
CustomFieldUnion
CustomFieldNumber
was removed from Union type
CustomFieldUnion
CustomFieldBoolean
was removed from Union type
CustomFieldUnion
NoteFileEdge
was removedRequestUpdateAttributes
was removedRequestUpsertPayload
was removedRequestNoteEditPayload
was removedRequestNoteCreatePayload
was removedNoteEditAttributes
was removedNoteCreateAttributes
was removedJobNoteEditPayload
was removedJobNoteCreatePayload
was removedCustomFieldsEditInput
was removedCustomFieldsCreateInput
was removedClientNoteEditPayload
was removedClientNoteCreatePayload
was removedNoteFileConnection
was removedNoteFile
was removedCustomFieldAttributes
was removedCustomFieldSelect
was removedCustomFieldNumber
was removedQuoteLineItem.unitCost
changed type from Float!
to Float
CustomFieldBoolean
was removedinternalCost
was removed from object type QuoteLineItem
startsBefore
was removed from input object type
TimeSheetEntriesFilterAttributes
startsAfter
was removed from input object type
TimeSheetEntriesFilterAttributes
includeEveryAccountTimer
was removed from input object type
TimeSheetEntriesFilterAttributes
upsertRequest
was removed from object type Mutation
requestUpsert
was removed from object type Mutation
requestNoteEdit
was removed from object type Mutation
requestNoteCreate
was removed from object type Mutation
jobNoteEdit
was removed from object type Mutation
jobNoteCreate
was removed from object type Mutation
clientUpsert
was removed from object type Mutation
clientNoteEdit
was removed from object type Mutation
clientNoteCreate
was removed from object type Mutation
QuoteEditAttributes.customFields
changed type from
[CustomFieldsEditInput!]
to [CustomFieldEditInput!]
QuoteCreateAttributes.customFields
changed type from
[CustomFieldsCreateInput!]
to [CustomFieldCreateInput!]
JobEditInput.customFields
changed type from
[CustomFieldsEditInput!]
to [CustomFieldEditInput!]
JobCreateAttributes.customFields
changed type from
[CustomFieldsCreateInput!]
to [CustomFieldCreateInput!]
attachmentsConnection
was removed from object type RequestNote
attachments
was removed from object type RequestNote
attachmentsConnection
was removed from object type QuoteNote
attachments
was removed from object type QuoteNote
unitCost
was removed from object type LineItemInterface
InvoiceEditInput.customFields
changed type from
[CustomFieldsEditInput!]
to [CustomFieldEditInput!]
attachmentsConnection
was removed from object type JobNote
attachments
was removed from object type JobNote
JobLineItem.unitCost
changed type from Float!
to Float
attachmentsConnection
was removed from object type InvoiceNote
attachments
was removed from object type InvoiceNote
unitCost
was removed from object type InvoiceLineItem
ProductOrService.id
changed type from Int!
to EncodedId!
ClientUpdateAttributes.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
PropertyUpdateAttributes.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
attachmentsConnection
was removed from object type NoteInterface
attachments
was removed from object type NoteInterface
CustomFieldNumeric
was added to Union type CustomFieldUnion
CustomFieldTrueFalse
was added to Union type CustomFieldUnion
CustomFieldDropdown
was added to Union type CustomFieldUnion
valueUrl
was removed from input object type
CustomFieldCreateInput
CustomFieldSelect
was removedstartsBefore
was removed from input object type
TimeSheetEntriesFilterAttributes
startsAfter
was removed from input object type
TimeSheetEntriesFilterAttributes
includeEveryAccountTimer
was removed from input object type
TimeSheetEntriesFilterAttributes
CustomFieldBoolean
was removed from Union type
CustomFieldUnion
CustomFieldNumber
was removed from Union type
CustomFieldUnion
CustomFieldSelect
was removed from Union type
CustomFieldUnion
CustomFieldBoolean
was removedvalueText
was removed from object type CustomFieldLink
valueUrl
was removed from object type CustomFieldLink
valueUrl
was removed from input object type
CustomFieldEditInput
valueSelect
was removed from input object type
CustomFieldEditInput
valueNumber
was removed from input object type
CustomFieldEditInput
valueBoolean
was removed from input object type
CustomFieldEditInput
valueAreaWidth
was removed from input object type
CustomFieldEditInput
valueAreaLength
was removed from input object type
CustomFieldEditInput
PropertyAttributes.address
changed type from AddressAttributes
to AddressAttributes!
valueAreaLength
was removed from input object type
CustomFieldCreateInput
valueAreaWidth
was removed from input object type
CustomFieldCreateInput
valueBoolean
was removed from input object type
CustomFieldCreateInput
valueNumber
was removed from input object type
CustomFieldCreateInput
valueSelect
was removed from input object type
CustomFieldCreateInput
CustomFieldNumber
was removedCustomFieldTrueFalse
was added to Union type CustomFieldUnion
CustomFieldNumeric
was added to Union type CustomFieldUnion
CustomFieldDropdown
was added to Union type CustomFieldUnion
unitCost
was removed from object type QuoteLineItem
unitCost
was removed from object type LineItemInterface
JobLineItem.unitCost
changed type from Float!
to Float
unitCost
was removed from object type InvoiceLineItem
CustomFieldsCreateInput
was removedQuoteEditAttributes.customFields
changed type from
[CustomFieldsEditInput!]
to [CustomFieldEditInput!]
CustomFieldAttributes
was removedQuoteCreateAttributes.customFields
changed type from
[CustomFieldsCreateInput!]
to [CustomFieldCreateInput!]
JobEditInput.customFields
changed type from
[CustomFieldsEditInput!]
to [CustomFieldEditInput!]
JobCreateAttributes.customFields
changed type from
[CustomFieldsCreateInput!]
to [CustomFieldCreateInput!]
ClientUpdateAttributes.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
PropertyUpdateAttributes.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
ClientEditInput.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldEditInput!]
ClientCreateInput.customFields
changed type from
[CustomFieldAttributes!]
to [CustomFieldCreateInput!]
CustomFieldsEditInput
was removedattachments
was removed from object type InvoiceNote
NoteFile
was removedattachmentsConnection
was removed from object type NoteInterface
attachments
was removed from object type NoteInterface
attachmentsConnection
was removed from object type ClientNote
attachments
was removed from object type ClientNote
NoteFileEdge
was removedNoteFileConnection
was removedProductOrService.id
changed type from Int!
to EncodedId!
attachmentsConnection
was removed from object type RequestNote
attachments
was removed from object type RequestNote
attachmentsConnection
was removed from object type QuoteNote
attachments
was removed from object type QuoteNote
attachmentsConnection
was removed from object type JobNote
attachments
was removed from object type JobNote
attachmentsConnection
was removed from object type InvoiceNote
InvoiceCreateNotePayload.invoice
changed type from Invoice!
to
Invoice
JobLineItem.category
changed type from String!
to
ProductsAndServicesCategory!
InvoiceNote.createdBy
changed type from User
to NoteCreatedByUnion
InvoiceLineItem.category
changed type from String!
to
ProductsAndServicesCategory!
workItem
was removed from object type InvoiceLineItem
NoteInterface.createdBy
changed type from User
to
NoteCreatedByUnion
ClientEditNotePayload.client
changed type from Client!
to Client
ClientCreateNotePayload.client
changed type from Client!
to Client
Request.notes
changed type from RequestNoteConnection!
to
RequestNoteUnionConnection!
sort
on field Quote.notes
changed from
[QuoteNotesSortInput!]
to [NotesSortInput!]
Quote.notes
changed type from QuoteNoteConnection!
to
QuoteNoteUnionConnection!
ClientNote.createdBy
changed type from User
to NoteCreatedByUnion
sort
on field Invoice.notes
changed from
[InvoiceNotesSortAttributes!]
to [NotesSortInput!]
Invoice.notes
changed type from InvoiceNoteConnection!
to
InvoiceNoteUnionConnection!
sort
on field Job.notes
changed from
[JobNotesSortAttributes!]
to [NotesSortInput!]
Job.notes
changed type from JobNoteConnection!
to
JobNoteUnionConnection!
sort
on field Client.notes
changed from
[ClientNotesSortAttributes!]
to [NotesSortInput!]
RequestNoteEdge
was removedRequestNoteConnection
was removedQuoteNotesSortKey
was removedQuoteNoteEdge
was removedQuoteNotesSortInput
was removedQuoteNoteConnection
was removedJobNotesSortableFieldsEnum
was removedWorkItemCategoryTypeEnum
was removedJobNotesSortAttributes
was removedInvoiceNotesSortableFieldsEnum
was removedInvoiceNoteEdge
was removedInvoiceNotesSortAttributes
was removedInvoiceNoteConnection
was removedClientNotesSortableFieldsEnum
was removedQuoteNote.createdBy
changed type from User
to NoteCreatedByUnion
ClientNotesSortAttributes
was removedQuoteLineItem.category
changed type from String!
to
ProductsAndServicesCategory!
requestId:
was removed from field Mutation.requestEditNote
quoteId:
was removed from field Mutation.quoteEditNote
jobId:
was removed from field Mutation.jobEditNote
invoiceId:
was removed from field Mutation.invoiceEditNote
clientId:
was removed from field Mutation.clientEditNote
RequestNote.createdBy
changed type from User
to NoteCreatedByUnion
RequestEditNotePayload.request
changed type from Request!
to
Request
QuoteEditNotePayload.quote
changed type from Quote!
to Quote
LineItemEditAttributes.category
changed type from
WorkItemCategoryTypeEnum
to ProductsAndServicesCategory
LineItemCreateAttributes.category
changed type from
WorkItemCategoryTypeEnum
to ProductsAndServicesCategory
JobEditNotePayload.job
changed type from Job!
to Job
JobEditLineItemAttributes.category
changed type from
WorkItemCategoryTypeEnum
to ProductsAndServicesCategory
JobCreateLineItemAttributes.category
changed type from
WorkItemCategoryTypeEnum
to ProductsAndServicesCategory
JobNote.createdBy
changed type from User
to NoteCreatedByUnion
ProductOrService.category
changed type from
WorkItemCategoryTypeEnum!
to ProductsAndServicesCategory!
LineItemInterface.category
changed type from String!
to
ProductsAndServicesCategory!
InvoiceEditNotePayload.invoice
changed type from Invoice!
to
Invoice
The DDoS protection middleware started returning "429 Too Many Requests" rather than "503 Service Unavailable" when a client's requests exceed the limits outlined in our API Rate Limits.
This section documents breaking/dangerous changes introduced in historic versions of the GraphQL API. All of these versions are inactive. Requests for these versions will be automatically resolved against the nearest active version.
Query.jobs
changed type from WorkOrderConnection!
to
JobConnection!
WorkOrderEdge
was removedWorkOrderConnection
was removedNo breaking or dangerous changes.