GraphQL API Changelog

This page shows the history of changes to the GraphQL schema.

Enum value INDUSTRY_WARNING_MESSAGE_RECEIVED was removed from AccountReminderTypes enum

Enum value REQUESTED was removed from OnSiteJobsAssetStatus enum

Type CreatePaymentMethodActionIntent was added
Type CreatePaymentMethodActionIntentInput was added
Type PaymentMethodOwnerInput was added
Field createPaymentMethodActionIntent was added to object type Mutation

Type TerminationFeeTypeEnum was added
TerminationFeeType.feeType type changed from TerminationFeeType to TerminationFeeTypeEnum

Type UpdateOptionsLanguagePreference was added
Type OptionsLanguagePreferenceChoices was added
Type OptionsLanguagePreferenceInput was added
Field updateOptionsLanguagePreference was added to object type Mutation

Type EscalateInkConversation was added
Type EscalateInkConversationInput was added
Field escalateInkConversation was added to object type Mutation
Enum value ESCALATE_INK_CONVERSATION was added to PreSignedTokenScope enum
Enum value ESCALATE_INK_CONVERSATION was added to ExpiringTokenScope enum

Type AssociateArchivedCallRecordingsWithCalls was added
Type AssociateArchivedCallRecordingsWithCallsInput was added
Type ArchivedCallRecordingInput was added
Type URI was added
Field associateArchivedCallRecordingsWithCalls was added to object type Mutation

Input Field contractNote: ContractNoteInput was added to input type VaryContractTermsInput
Input Field contractNote: ContractNoteInput was added to input type TerminateContractInput

Field id was added to object type AccountNoteType

Type CreateExternalMessageEvent was added
Type ExternalMessageEventType was added
Type MessageEventType was added
Type CreateExternalMessageEventInput was added
Type DeliveryFailedInput was added
Type DeferredInput was added
Type OpenedInput was added
Type ClickedInput was added
Field createExternalMessageEvent was added to object type Mutation

Input Field isHouseMove: Boolean was added to input type UpdateLeaveSupplierInput
Input Field isHouseMove: Boolean was added to input type LeaveSupplierInput

Enum value READ was added to InkMessageDeliveryStatus enum

Field stage was added to object type LeaveSupplierProcessType
Field stage was added to object type JoinSupplierProcessType

Deprecation reason on field Mutation.instigateContractTermination changed from None to The 'instigateContractTermination' field is deprecated. This is a legacy mutation. The terminateContract mutation should be used instead. - Marked as deprecated on 2026-04-01. - Scheduled for removal on or after 2026-04-30.

Field request was added to object type OnSiteJobsAppointmentType

Enum value POST_APPOINTMENT_RESCHEDULED was added to OnSiteJobsAppointmentActionTriggerStage enum

Enum value IFS was added to OnSiteJobsAgent enum

Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface AccountInterface
Field billingTriggerConfiguration of type BillingTriggerConfiguration was added to interface LedgerInterface
Field billingTriggerConfiguration was added to object type LedgerType
Field billingTriggerConfiguration was added to object type AccountType

Type TrancheTargetConfigurationType was added
Type TrancheTargetMarketConfigurationType was added
Type TrancheTargetConfigurationInput was added
Type TrancheTargetMarketConfigurationInput was added
Type CalculationPeriodFrequency was added
Input Field tranchetargetconfiguration: TrancheTargetConfigurationInput was added to input type OneOfTermInput

Type BulkAwardLoyaltyPoints was added
Type BulkAwardLoyaltyPointsInsertedItemResult was added
Type BulkAwardLoyaltyPointsFailedItemResult was added
Type BulkAwardLoyaltyPointsInput was added
Type BulkAwardLoyaltyPointsItemInput was added
Field bulkAwardLoyaltyPoints was added to object type Mutation

Field isReversed was added to object type VoucherRedemptionType

Argument accountNumbers: [NonEmptyString!] added to Query.getOnSiteJobsRequests

Type CreateAccountCredit was removed
Type CreateAccountCreditInput was removed
Type AccountCreditReasonType was removed
Field createAccountCredit was removed from object type Mutation

Enum value ACCOUNT_PROPERTY_EFFECTIVE_PERIOD was added to LinkedObjectType enum
Enum value PROPERTY was added to LinkedObjectType enum

Type UpdateCampaignAccountExpiryDate was added
Type UpdateCampaignAccountExpiryDateInput was added
Field updateCampaignAccountExpiryDate was added to object type Mutation

Type BillingTriggerConfigurationsForTarget was added
Type BillingTriggerTargetReference was added
Type BillingTriggerTargetType was added
Type BillingTriggerConfiguration was added
Type BillingOperationFrequency was added
Type BillingTriggerOperationType was added
Type BillingTriggerFrequency was added
Type BillingOperationTemporalParamsType was added
Type BillingTriggerConfigurationsConnection was added
Type BillingTriggerConfigurationsEdge was added
Type TargetInput was added
Field billingTriggerConfigurations was added to object type Query

Enum value CUSTOM was added to PaymentType enum

Type BillTriggeredScheduleType was added
Type BalanceTriggeredScheduleType was added
Type BillTriggeredBalanceTargetScheduleType was added
Type PaymentScheduleDataType was added
Type RegularScheduleType was added
Field paymentScheduleData was added to object type JoinSupplierProcessDataType

Input Field timestamp: DateTime! was added to input type PaymentDetailsInput
Input Field timestamp: DateTime! was added to input type FailedPaymentDetailsInput
Input Field timestamp: DateTime! was added to input type SuccessfulPaymentDetailsInput

Type PaymentAdequacyChangeType was added
Field latestAppliedPaymentAdequacyChange was added to object type PaymentAdequacyDetailsType

Argument excludeByDisplayName: [String] added to Query.vouchersForAccount

Type InkStorylineAnalyzerResult was added
Type InkStorylineAnalyzerResultInput was added
Type StorylineAnalyzerTypeChoices was added
Field analyzerResults was added to object type InkStoryline
Input Field analyzerResults: [InkStorylineAnalyzerResultInput!] was added to input type AddStorylineToInkConversationInput

Type RegisterCustomerAsset was added
Type RegisterCustomerAssetInput was added
Type CustomerAssetTypeEnum was added
Type CustomerAssetType was added
Field registerCustomerAsset was added to object type Mutation
Field customerAssets of type [CustomerAssetType] was added to interface AccountInterface
Field customerAsset was added to object type Query
Field customerAssets was added to object type AccountType

Type CreateInternalCompany was added
Type CreateInternalCompanyResultType was added
Type CreateInternalCompanyInput was added
Field createInternalCompany was added to object type Mutation

Type PushNotificationEventType was added
Type PushNotificationMessageType was added
Union member PushNotificationEventType was added to AccountEvent Union type
Enum value PUSH_NOTIFICATION_SENT was added to AccountEventType enum

Argument offset: Int added to Query.opportunities
Argument offset: Int added to Query.leads

Enum value DUPLICATE_CARD_FINGERPRINTS was added to AccountReminderTypes enum
Enum value DUPLICATE_CARD_FINGERPRINTs was removed from AccountReminderTypes enum

Field refundedAt was added to object type VoucherPurchaseType
Argument excludeRefunded: Boolean added to Query.vouchersForAccount

Type PublishApprovalApprovedEvent was added
Type PublishApprovalApprovedEventInput was added
Field publishApprovalApprovedEvent was added to object type Mutation

Type RecordFailedPayment was added
Type RecordFailedPaymentInput was added
Type FailedPaymentDetailsInput was added
Type FailureReason was added
Field recordFailedPayment was added to object type Mutation

Type InternalCompanyConnectionTypeConnection was added
Type InternalCompanyConnectionTypeEdge was added
Type RoutingAttributeType was added
Field internalCompanies was added to object type Query
Field routingAttributes was added to object type Query

Type ContractNoteInput was added
Type ContractNoteType was added
Field notes was added to object type ContractCreationJourneyType
Input Field contractNote: ContractNoteInput was added to input type InstigateContractVariationInput
Field notes of type [ContractNoteType] was added to interface ContractJourneyInterface
Field notes was added to object type Contract
Field notes was added to object type ContractDetails
Input Field contractNote: ContractNoteInput was added to input type BaseInstigateContractTerminationInput

CreateExternalMessageInput.accountNumber type changed from String to String!

Type EnrollmentReversed was added
Type ReverseEnrollmentInput was added
Field reverseEnrollment was added to object type Mutation

Type LeaveSupplierReversed was added
Type ReverseLeaveSupplierInput was added
Field reverseLeaveSupplier was added to object type Mutation

Type OrderDetailsType was removed
Type OrderType was removed
Type OrderCustomerType was removed
Type OrderLineType was removed
Type OrderItemType was removed
Type ItemProfileType was removed
Type OrderLinePeriodType was removed
Type OrderLineDateRangeType was removed
Type OrderLineDurationType was removed
Type OrderResource was removed
Type ProcessOrderOutput was removed
Type LegacyOrderDetailsType was added
Type LegacyOrderType was added
Type LegacyOrderCustomerType was added
Type LegacyOrderLineType was added
Type LegacyOrderItemType was added
Type LegacyItemProfileType was added
Type LegacyOrderLinePeriodType was added
Type LegacyOrderLineDateRangeType was added
Type LegacyOrderLineDurationType was added
Type LegacyOrderResource was added
Type LegacyProcessOrderOutput was added
Type OnSiteJobsExternalJobTypeMappingType was added
Field externalJobTypeMapping was added to object type OnSiteJobsAppointmentType
Deprecation reason on field OnSiteJobsAppointmentType.externalJobType changed from None to The 'externalJobType' field is deprecated. Please use externalJobTypeMapping instead. - Marked as deprecated on 2026-03-17. - Scheduled for removal on or after 2026-04-17.
Field legacyOrderDetails was added to object type Query
Field orderDetails was removed from object type Query
Deprecation reason on field Mutation.createAccountCredit changed from The 'createAccountCredit' field is deprecated. Use postCredit mutation as it is ledger aware. - Marked as deprecated on 2022-07-04. - Scheduled for removal on or after 2024-01-01. to The 'createAccountCredit' field is deprecated. Use postCredit mutation as it is ledger aware. - Marked as deprecated on 2022-07-04. - Scheduled for removal on or after 2026-03-30.
Mutation.legacyProcessOrder type changed from ProcessOrderOutput! to LegacyProcessOrderOutput!
Enum value JPN_BILLING_PATTERN_CHANGED_DUE_TO_READING_DATE_CHANGE was removed from AccountReminderTypes enum

Type InternalCompanyType was added
Type SearchCriteriaInput was added
Field internalCompany was added to object type Query

Field contractIdentifiers was added to object type JoinSupplierProcessType
Input Field contractIdentifiers: [String] was added to input type EnrollmentInput

Type PromotionAssignmentPeriodType was removed
Type PromotionAssignmentPeriodInput was removed
Field assignmentPeriod was removed from object type PromotionAssignmentScheduleType
Input Field assignmentPeriod removed from input type PromotionAssignmentScheduleInput

Type UpdateAgentAuxiliaryStatus was added
Type UpdateAgentAuxiliaryStatusInput was added
Field updateAgentAuxiliaryStatus was added to object type Mutation

Type RecordPendingPayment was added
Type RecordPendingPaymentInput was added
Type PaymentDetailsInput was added
Type CreateExternalMessage was added
Type ExternalMessageType was added
Type CreateExternalMessageInput was added
Type EmailContentInput was added
Field createExternalMessage was added to object type Mutation
Field recordPendingPayment was added to object type Mutation

Argument ledgerNumber: String added to PeriodBasedDocumentType.closingBalance
Argument ledgerNumber: String added to PeriodBasedDocumentType.openingBalance

Enum value AUS_GET_CORRECT_PHONE_NUMBER was removed from AccountReminderTypes enum

Type CloseInkConversation was added
Type CloseInkConversationInput was added
Type ConversationClosedReasonChoices was added
Field closeInkConversation was added to object type Mutation
OnSiteJobsUpdateRequestInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
OnSiteJobsCreateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
OnSiteJobsUpdateAppointmentInput.assets type changed from [OnSiteJobsAssetInput] to [OnSiteJobsAssetInput!]
CreateOnSiteJobsRequestInputType.assets type changed from [OnSiteJobsAssetInput]! to [OnSiteJobsAssetInput!]!
CreateOnSiteJobsRequestInputType.supplyPointIdentifierToMarketNameMapping type changed from [SupplyPointIdentifierToMarketNameMappingInput] to [SupplyPointIdentifierToMarketNameMappingInput!]
CreateOnSiteJobsRequestInputType.supplyPointInternalIds type changed from [Int] to [Int!]

InkStorylineEntry.contentId type changed from Int to BigInt
InkStorylineEntryInput.contentId type changed from Int to BigInt

Input Field knowledgeArticleIds: [Int!] was added to input type AddStorylineToInkConversationInput
Field knowledgeArticleIds was added to object type InkStoryline

Field params was added to object type CommonAgreementType

Type DeletePropertyDescendants was added
Type DeletePropertyDescendantsInput was added
Field deletePropertyDescendants was added to object type Mutation

Type RemovePropertyFromHierarchy was added
Type RemovePropertyFromHierarchyInput was added
Field removePropertyFromHierarchy was added to object type Mutation

Type AddParentToProperty was added
Type AddParentToPropertyInput was added
Field addParentToProperty was added to object type Mutation

Field deadlineDate was added to object type OnSiteJobsAppointmentType
Field createdAt was added to object type OnSiteJobsAppointmentType
Field preferredStartDate was added to object type OnSiteJobsAppointmentType

Input Field externalIdentifier: String was added to input type SimpleServicesEnrollmentMarketInput

Type RecordSuccessfulPayment was added
Type RecordSuccessfulPaymentInput was added
Type NoticePriority was added
Type SuccessfulPaymentDetailsInput was added
Type PaymentActionIntentOneOfInput was added
Type PaymentActionIntentOptionsInput was added
Type PaymentMethodInput was added
Field recordSuccessfulPayment was added to object type Mutation

Type SimpleServicesMarketDataSourceInput was added
Type SimpleServicesQuotedSupplyPointInput was added
Type SimpleServicesProductCatalogInput was added
Type SimpleServicesAgreementTransferInput was added
Input Field marketDataSource: SimpleServicesMarketDataSourceInput was added to input type SimpleServicesEnrollmentMarketInput
Input Field quotedSupplyPointId removed from input type SimpleServicesEnrollmentMarketInput
Input Field externalIdentifier removed from input type SimpleServicesEnrollmentMarketInput

Input Field bypassTerminalAppointmentStatus: Boolean was added to input type OnSiteJobsUpdateAppointmentInput
Input Field alignRequestStatusWithAppointment: Boolean was added to input type OnSiteJobsUpdateAppointmentInput

Type AddChildToProperty was added
Type AddChildToPropertyInput was added
Field addChildToProperty was added to object type Mutation

Deprecation reason on field Mutation.instigateContractVariation changed from None to The 'instigateContractVariation' field is deprecated. This is a legacy mutation. The varyContractTerms should be used instead. - Marked as deprecated on 2026-03-05. - Scheduled for removal on or after 2026-04-11.
Deprecation reason on field Mutation.varyContractTerms changed from The 'varyContractTerms' field is deprecated. This is a legacy mutation. The instigateContractVariation should be used instead. - Marked as deprecated on 2026-01-20. - Scheduled for removal on or after 2026-02-27. to None

Argument ledgerNumber: String added to InvoiceType.transactions
Argument ledgerNumber: String added to PeriodBasedDocumentType.transactions