Schema

Scalars

Enums

Objects

Input Objects

RootMutationType (OBJECT)

Mutations exist to create cases (including drafts) for brokers, or to generate API tokens for a company.

Schema Definition

type RootMutationType {   # Clones the given case.
cloneCase: Case!   # Completes the given case.
completeCase: Case!   # Creates a buy-to-let, BTL, case to run the affordability results for.
createBtlCase: Case!   # Creates a draft buy-to-let, BTL, case to run the affordability results lazily.
createBtlCaseDraft: Case!   # Creates a residential case to run the affordability results for.
createCase: Case!   # Creates a draft residential case to run the affordability results lazily.
createCaseDraft: Case!   # Allows creation of companies by 3rd party API integrations, requires integration token.
createCompany: CreateCompanyResult!   # Create or update webhook subscription
createOrUpdateWebhookSubscription: WebhookSubscription!   # Allows creation of broker tokens by email addresses for 3rd party API integration, requires company token.
createTokenByEmail: String!   # Allows creation of broker tokens by email or uuid for 3rd party API integration, requires company token.
createTokenForBroker: String!   # Allows creation of company tokens by fca number, company number or domain for 3rd party API integration, requires integration token.
createTokenForCompany: String!   # Allows creation of users for the current company
createUser: User!   # Evaluates the results of the case.
invokeCaseResults: Case!   # Updates details of a buy-to-let, BTL, draft case.
updateBtlCaseDraft: Case!   # Updates details of a residential draft case.
updateCaseDraft: Case! }