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.
JobCreateAttributes.jobFormIds changed type from [ID!] to [EncodedId!]REPLACED was added to enum CapitalLoanStatusADVANCE_FUNDING was added to enum BalanceTransactionADVANCE was added to enum BalanceTransactionRESERVED_FUNDS was added to enum BalanceTransactionsort on field requests changed from RequestsSortInput
to [RequestsSortInput!]No external breaking changes
No external breaking changes
ProductOrService object implements CustomFieldsInterface interfaceALL_PRODUCTS_AND_SERVICES was added to enum
CustomFieldAppliesToNo external breaking changes
ProductsAndServicesEditInput.category changed type from
WorkItemCategoryTypeEnum to ProductsAndServicesCategoryClient was added to Union type NoteCreatedByUnionPackage was removed from enum WorkItemCategoryTypeEnumPACKAGE was removed from enum ProductsAndServicesCategorypreviewUrl was removed from object type QuotepreviewUrl was removed from object type InvoiceClientEditInput.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 ClientNoteattachments was removed from object type ClientNotevalueUrl was removed from object type CustomFieldLinkvalueText was removed from object type CustomFieldLinkCustomFieldSelect was removed from Union type
CustomFieldUnionCustomFieldNumber was removed from Union type
CustomFieldUnionCustomFieldBoolean was removed from Union type
CustomFieldUnionNoteFileEdge 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 FloatCustomFieldBoolean was removedinternalCost was removed from object type QuoteLineItemstartsBefore was removed from input object type
TimeSheetEntriesFilterAttributesstartsAfter was removed from input object type
TimeSheetEntriesFilterAttributesincludeEveryAccountTimer was removed from input object type
TimeSheetEntriesFilterAttributesupsertRequest was removed from object type MutationrequestUpsert was removed from object type MutationrequestNoteEdit was removed from object type MutationrequestNoteCreate was removed from object type MutationjobNoteEdit was removed from object type MutationjobNoteCreate was removed from object type MutationclientUpsert was removed from object type MutationclientNoteEdit was removed from object type MutationclientNoteCreate was removed from object type MutationQuoteEditAttributes.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 RequestNoteattachments was removed from object type RequestNoteattachmentsConnection was removed from object type QuoteNoteattachments was removed from object type QuoteNoteunitCost was removed from object type LineItemInterfaceInvoiceEditInput.customFields changed type from
[CustomFieldsEditInput!] to [CustomFieldEditInput!]attachmentsConnection was removed from object type JobNoteattachments was removed from object type JobNoteJobLineItem.unitCost changed type from Float! to FloatattachmentsConnection was removed from object type InvoiceNoteattachments was removed from object type InvoiceNoteunitCost was removed from object type InvoiceLineItemProductOrService.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 NoteInterfaceattachments was removed from object type NoteInterfaceCustomFieldNumeric was added to Union type CustomFieldUnionCustomFieldTrueFalse was added to Union type CustomFieldUnionCustomFieldDropdown was added to Union type CustomFieldUnionvalueUrl was removed from input object type
CustomFieldCreateInputCustomFieldSelect was removedstartsBefore was removed from input object type
TimeSheetEntriesFilterAttributesstartsAfter was removed from input object type
TimeSheetEntriesFilterAttributesincludeEveryAccountTimer was removed from input object type
TimeSheetEntriesFilterAttributesCustomFieldBoolean was removed from Union type
CustomFieldUnionCustomFieldNumber was removed from Union type
CustomFieldUnionCustomFieldSelect was removed from Union type
CustomFieldUnionCustomFieldBoolean was removedvalueText was removed from object type CustomFieldLinkvalueUrl was removed from object type CustomFieldLinkvalueUrl was removed from input object type
CustomFieldEditInputvalueSelect was removed from input object type
CustomFieldEditInputvalueNumber was removed from input object type
CustomFieldEditInputvalueBoolean was removed from input object type
CustomFieldEditInputvalueAreaWidth was removed from input object type
CustomFieldEditInputvalueAreaLength was removed from input object type
CustomFieldEditInputPropertyAttributes.address changed type from AddressAttributes
to AddressAttributes!valueAreaLength was removed from input object type
CustomFieldCreateInputvalueAreaWidth was removed from input object type
CustomFieldCreateInputvalueBoolean was removed from input object type
CustomFieldCreateInputvalueNumber was removed from input object type
CustomFieldCreateInputvalueSelect was removed from input object type
CustomFieldCreateInputCustomFieldNumber was removedCustomFieldTrueFalse was added to Union type CustomFieldUnionCustomFieldNumeric was added to Union type CustomFieldUnionCustomFieldDropdown was added to Union type CustomFieldUnionunitCost was removed from object type QuoteLineItemunitCost was removed from object type LineItemInterfaceJobLineItem.unitCost changed type from Float! to FloatunitCost was removed from object type InvoiceLineItemCustomFieldsCreateInput 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 InvoiceNoteNoteFile was removedattachmentsConnection was removed from object type NoteInterfaceattachments was removed from object type NoteInterfaceattachmentsConnection was removed from object type ClientNoteattachments was removed from object type ClientNoteNoteFileEdge was removedNoteFileConnection was removedProductOrService.id changed type from Int! to EncodedId!attachmentsConnection was removed from object type RequestNoteattachments was removed from object type RequestNoteattachmentsConnection was removed from object type QuoteNoteattachments was removed from object type QuoteNoteattachmentsConnection was removed from object type JobNoteattachments was removed from object type JobNoteattachmentsConnection was removed from object type InvoiceNoteInvoiceCreateNotePayload.invoice changed type from Invoice! to
InvoiceJobLineItem.category changed type from String! to
ProductsAndServicesCategory!InvoiceNote.createdBy changed type from User to NoteCreatedByUnionInvoiceLineItem.category changed type from String! to
ProductsAndServicesCategory!workItem was removed from object type InvoiceLineItemNoteInterface.createdBy changed type from User to
NoteCreatedByUnionClientEditNotePayload.client changed type from Client! to ClientClientCreateNotePayload.client changed type from Client! to ClientRequest.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 NoteCreatedByUnionsort 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 NoteCreatedByUnionClientNotesSortAttributes was removedQuoteLineItem.category changed type from String! to
ProductsAndServicesCategory!requestId: was removed from field Mutation.requestEditNotequoteId: was removed from field Mutation.quoteEditNotejobId: was removed from field Mutation.jobEditNoteinvoiceId: was removed from field Mutation.invoiceEditNoteclientId: was removed from field Mutation.clientEditNoteRequestNote.createdBy changed type from User to NoteCreatedByUnionRequestEditNotePayload.request changed type from Request! to
RequestQuoteEditNotePayload.quote changed type from Quote! to QuoteLineItemEditAttributes.category changed type from
WorkItemCategoryTypeEnum to ProductsAndServicesCategoryLineItemCreateAttributes.category changed type from
WorkItemCategoryTypeEnum to ProductsAndServicesCategoryJobEditNotePayload.job changed type from Job! to JobJobEditLineItemAttributes.category changed type from
WorkItemCategoryTypeEnum to ProductsAndServicesCategoryJobCreateLineItemAttributes.category changed type from
WorkItemCategoryTypeEnum to ProductsAndServicesCategoryJobNote.createdBy changed type from User to NoteCreatedByUnionProductOrService.category changed type from
WorkItemCategoryTypeEnum! to ProductsAndServicesCategory!LineItemInterface.category changed type from String! to
ProductsAndServicesCategory!InvoiceEditNotePayload.invoice changed type from Invoice! to
InvoiceThe 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.