Reference
Queries#
platformOpsStatus#
Requires: platform key or token · scope platform_usage:read.
platformOpsStatus: PlatformOpsStatus!
platformKeys#
Requires: platform key or token.
platformKeys(platformId: ID): [PlatformKey!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformCompany#
Requires: platform key or token · scope platform_companies:read.
platformCompany(platformId: ID, profileId: ID, externalId: String): PlatformCompany
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID | |
externalId | String |
platformCompanies#
Requires: platform key or token · scope platform_companies:read.
platformCompanies(platformId: ID, first: Int, after: String, filter: PlatformCompanyFilter, lifecycleStates: [ProfileLifecycleState!], includeArchived: Boolean): PlatformCompanyConnection!
| Argument | Type | |
|---|---|---|
platformId | ID | |
first | Int | |
after | String | |
filter | PlatformCompanyFilter | |
lifecycleStates | [ProfileLifecycleState!] | Default: every state except archived. Name archived (or pass includeArchived) to see archived companies. |
includeArchived | Boolean |
platformUser#
Requires: platform key or token · scope platform_users:read.
platformUser(platformId: ID, userId: ID, externalUserId: String): PlatformUser
| Argument | Type | |
|---|---|---|
platformId | ID | |
userId | ID | |
externalUserId | String |
platformUsers#
Requires: platform key or token · scope platform_users:read.
platformUsers(platformId: ID, profileId: ID, first: Int, after: String): PlatformUserConnection!
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID | |
first | Int | |
after | String |
platformPortalAccess#
Requires: platform key or token.
platformPortalAccess(platformId: ID): PlatformPortalAccess!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformPortalMembers#
Requires: platform key or token.
platformPortalMembers(platformId: ID): [PlatformPortalMember!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformSandboxSettings#
Requires: platform key or token · scope platform_companies:read.
platformSandboxSettings(platformId: ID): PlatformSandboxSettings!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformFeatureAllowance#
Requires: platform key or token · scope platform_features:read.
platformFeatureAllowance(platformId: ID): PlatformFeatureAllowance!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformFeatureLimits#
Requires: platform key or token · scope platform_features:read.
platformFeatureLimits(platformId: ID, profileId: ID): [PlatformFeatureLimit!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID |
platformCompanyFeatures#
Requires: platform key or token · scope platform_features:read.
platformCompanyFeatures(platformId: ID, profileId: ID!): [PlatformCompanyFeature!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID! |
platformFeatureExplain#
The steps behind a feature key for one of the platform's companies: environment, requires, allowance, platform and company limits. Firm overrides are shown as skipped.
Requires: platform key or token · scope platform_features:read.
platformFeatureExplain(platformId: ID, profileId: ID!, key: String!): FeatureExplain!
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID! | |
key | String! |
platformMobileApps#
Requires: platform key or token · scope platform_embed:read.
platformMobileApps(platformId: ID): [PlatformMobileApp!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
embedSessions#
Requires: platform key or token.
embedSessions(filter: EmbedSessionFilterInput, first: Int, after: String): EmbedSessionConnection!
| Argument | Type | |
|---|---|---|
filter | EmbedSessionFilterInput | |
first | Int | |
after | String |
embedSession#
Requires: platform key or token.
embedSession(id: ID!): EmbedSession
| Argument | Type | |
|---|---|---|
id | ID! |
embedContext#
Embed or headless token only.
embedContext: EmbedContext!
platformAllowedOrigins#
Requires: platform key or token · scope platform_embed:read.
platformAllowedOrigins(platformId: ID): [PlatformAllowedOrigin!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformEmbedSettings#
Requires: platform key or token · scope platform_embed:read.
platformEmbedSettings(platformId: ID): PlatformEmbedSettings!
| Argument | Type | |
|---|---|---|
platformId | ID |
onboardingRequirements#
What the company still has to provide before FinBaze can book and file for it.
onboardingRequirements(profileId: ID!): [OnboardingRequirement!]!
| Argument | Type | |
|---|---|---|
profileId | ID! |
resolveEmbedIntent#
Requires: platform key or token · scope platform_embed:read.
resolveEmbedIntent(intent: String!): EmbedIntent!
| Argument | Type | |
|---|---|---|
intent | String! |
platformEventCatalog#
Requires: platform key or token · scope events:read.
platformEventCatalog(platformId: ID): [PlatformEventType!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformEvents#
Requires: platform key or token · scope events:read.
platformEvents(filter: PlatformEventFilter, after: String, first: Int!, platformId: ID): PlatformEventConnection!
| Argument | Type | |
|---|---|---|
filter | PlatformEventFilter | |
after | String | |
first | Int! | |
platformId | ID |
platformEvent#
Requires: platform key or token · scope events:read.
platformEvent(id: ID!, platformId: ID): PlatformEvent
| Argument | Type | |
|---|---|---|
id | ID! | |
platformId | ID |
platformWebhookEndpoints#
Requires: platform key or token · scope webhooks:read.
platformWebhookEndpoints(platformId: ID): [PlatformWebhookEndpoint!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformWebhookDeliveries#
Requires: platform key or token · scope webhooks:read.
platformWebhookDeliveries(endpointId: ID!, filter: PlatformDeliveryFilter, after: String, first: Int!, platformId: ID): PlatformWebhookDeliveryConnection!
| Argument | Type | |
|---|---|---|
endpointId | ID! | |
filter | PlatformDeliveryFilter | |
after | String | |
first | Int! | |
platformId | ID |
bankTransactionBookings#
Requires: platform key or token · feature banking.
bankTransactionBookings(company: CompanyRef!, externalIds: [String!]!): [BankTransactionBooking!]!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
externalIds | [String!]! |
dataSources#
Requires: platform key or token · scope data_sources:read.
dataSources: [DataSource!]!
dataSource#
Requires: platform key or token · scope data_sources:read.
dataSource(key: String!): DataSource
| Argument | Type | |
|---|---|---|
key | String! |
feedHealth#
Requires: platform key or token · scope data_sources:read.
feedHealth(status: [FeedHealthStatus!], first: Int!, after: String): FeedAccountConnection!
| Argument | Type | |
|---|---|---|
status | [FeedHealthStatus!] | |
first | Int! | |
after | String |
dataSourceFiles#
Requires: platform key or token · scope data_sources:read.
dataSourceFiles(key: String!, first: Int!, after: String): DataSourceFileConnection!
| Argument | Type | |
|---|---|---|
key | String! | |
first | Int! | |
after | String |
payoutTransferMatches#
Requires: platform key or token · scope monetary_accounts:read.
payoutTransferMatches(source: String!, company: CompanyRef!, payouts: [String!]!): [PayoutTransferMatch!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
payouts | [String!]! | externalIds of payouts (at most 500). |
platformObjectByExternalId#
Requires: platform key or token.
platformObjectByExternalId(company: CompanyRef!, type: PlatformObjectType!, externalId: String!): PlatformObjectRef
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
type | PlatformObjectType! | |
externalId | String! |
platformBulkJob#
Requires: platform key or token · scope bulk:read.
platformBulkJob(id: ID!): PlatformBulkJob
| Argument | Type | |
|---|---|---|
id | ID! |
platformBulkJobs#
Requires: platform key or token · scope bulk:read.
platformBulkJobs(first: Int!, after: String, status: [PlatformBulkJobStatus!]): PlatformBulkJobConnection!
| Argument | Type | |
|---|---|---|
first | Int! | |
after | String | |
status | [PlatformBulkJobStatus!] |
policySchemas#
JSON Schema per policy kind (portal forms, SDK types).
Requires: platform key or token · scope platform_policies:read.
policySchemas(platformId: ID): JSONObject!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformPolicies#
Requires: platform key or token · scope platform_policies:read.
platformPolicies(platformId: ID, kind: PolicyKind, status: PolicyStatus): [PlatformPolicyVersion!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
kind | PolicyKind | |
status | PolicyStatus |
effectivePolicy#
Requires: platform key or token · scope platform_policies:read.
effectivePolicy(platformId: ID, kind: PolicyKind!, companyId: ID!): JSONObject!
| Argument | Type | |
|---|---|---|
platformId | ID | |
kind | PolicyKind! | |
companyId | ID! |
companyPolicyOverrides#
Requires: platform key or token · scope platform_policies:read.
companyPolicyOverrides(platformId: ID, companyId: ID!): [CompanyPolicyOverride!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! |
platformCustomActions#
Requires: platform key or token · scope platform_extensions:read.
platformCustomActions(platformId: ID): [PlatformCustomAction!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
customActions#
The actions to show at a placement for one object, resolved on the server.
Requires: platform key or token · scope platform_extensions:read.
customActions(platformId: ID, placement: String!, contextType: String!, contextId: ID!, locale: String): [ResolvedCustomAction!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
placement | String! | |
contextType | String! | |
contextId | ID! | |
locale | String |
platformLinkTemplates#
Requires: platform key or token · scope platform_extensions:read.
platformLinkTemplates(platformId: ID): [PlatformLinkTemplate!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
partnerLinks#
Links from a FinBaze object to the same object in your own system.
Requires: platform key or token · scope platform_extensions:read.
partnerLinks(platformId: ID, objectType: String!, objectId: ID!, locale: String): [PartnerLink!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
objectType | String! | |
objectId | ID! | |
locale | String |
customFieldDefinitions#
Requires: platform key or token · scope platform_extensions:read.
customFieldDefinitions(platformId: ID, entityType: String!): [CustomFieldDefinition!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
entityType | String! |
customFieldValues#
Requires: platform key or token · scope platform_extensions:read.
customFieldValues(platformId: ID, entityType: String!, entityId: ID!): JSONObject!
| Argument | Type | |
|---|---|---|
platformId | ID | |
entityType | String! | |
entityId | ID! |
fieldControls#
Requires: platform key or token · scope platform_extensions:read.
fieldControls(platformId: ID, view: String!, companyId: ID): [FieldControl!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
view | String! | |
companyId | ID |
platformRecordTypes#
Requires: platform key or token · scope custom_records:read.
platformRecordTypes(platformId: ID): [PlatformRecordType!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
customRecords#
Requires: platform key or token · scope custom_records:read.
customRecords(company: CompanyRef!, type: String!, status: [String!], first: Int!, after: String): CustomRecordConnection!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
type | String! | |
status | [String!] | |
first | Int! | |
after | String |
customRecord#
Requires: platform key or token · scope custom_records:read.
customRecord(company: CompanyRef!, type: String!, externalId: String!): CustomRecord
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
type | String! | |
externalId | String! |
flowTemplates#
Requires: platform key or token · scope custom_records:read.
flowTemplates(platformId: ID, key: String): [FlowTemplate!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String |
flowRuns#
Requires: platform key or token · scope custom_records:read.
flowRuns(platformId: ID, status: [String!], first: Int!, after: String): FlowRunConnection!
| Argument | Type | |
|---|---|---|
platformId | ID | |
status | [String!] | |
first | Int! | |
after | String |
platformReport#
Requires: platform key or token · scope reports:read.
platformReport(company: CompanyRef!, input: PlatformReportInput!): PlatformReport!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
input | PlatformReportInput! |
platformReportDocument#
Requires: platform key or token · scope reports:read.
platformReportDocument(company: CompanyRef!, input: PlatformReportInput!, format: ReportFormat!): CompanyDocument!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
input | PlatformReportInput! | |
format | ReportFormat! |
companyDocument#
Requires: platform key or token · scope documents:read.
companyDocument(company: CompanyRef!, kind: CompanyDocumentKind!, object: ObjectRef, params: JSON): CompanyDocument!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
kind | CompanyDocumentKind! | |
object | ObjectRef | |
params | JSON |
platformExportDestinations#
Requires: platform key or token · scope exports:read.
platformExportDestinations(platformId: ID): [PlatformExportDestination!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformExportSchedules#
Requires: platform key or token · scope exports:read.
platformExportSchedules(platformId: ID): [PlatformExportSchedule!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformExportRun#
Requires: platform key or token · scope exports:read.
platformExportRun(platformId: ID, id: ID!): PlatformExportRun
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
companyExports#
The company's recent exports, newest first: audit files in any state, and reports that are still downloadable.
Requires: platform key or token.
companyExports(platformId: ID, companyId: ID!, first: Int): [CompanyExport!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
first | Int |
platformProviders#
Requires: platform key or token · scope platform_payments:read.
platformProviders: [PlatformProvider!]!
paymentRequests#
Requires: platform key or token · scope platform_payments:read.
paymentRequests(company: CompanyRef, status: [PaymentRequestStatus!], first: Int, after: String): PaymentRequestConnection!
| Argument | Type | |
|---|---|---|
company | CompanyRef | |
status | [PaymentRequestStatus!] | |
first | Int | |
after | String |
paymentRequest#
Requires: platform key or token · scope platform_payments:read.
paymentRequest(id: ID!): PaymentRequest
| Argument | Type | |
|---|---|---|
id | ID! |
taxReservationAdvice#
Requires: platform key or token · scope platform_payments:read.
taxReservationAdvice(company: CompanyRef!): [TaxReservationAdvice!]!
| Argument | Type | |
|---|---|---|
company | CompanyRef! |
stepUpChallenge#
Requires: platform key or token.
stepUpChallenge(id: ID!): StepUpChallenge
| Argument | Type | |
|---|---|---|
id | ID! |
platformUsage#
Requires: platform key or token · scope platform_usage:read.
platformUsage(platformId: ID, month: String): PlatformUsage!
| Argument | Type | |
|---|---|---|
platformId | ID | |
month | String |
platformContract#
Requires: platform key or token · scope platform_usage:read.
platformContract(platformId: ID): PlatformContractView
| Argument | Type | |
|---|---|---|
platformId | ID |
testClocks#
Requires: platform key or token · scope platform_companies:read.
testClocks(platformId: ID): [TestClock!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
companyClosingChecklist#
Requires: platform key or token · scope platform_companies:read.
companyClosingChecklist(companyId: ID!, platformId: ID, effectiveDate: String): [ClosingChecklistItem!]!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
effectiveDate | String | Preview for an active company: what closing on this day would need. |
companyTransferStatement#
Requires: platform key or token · scope platform_companies:read.
companyTransferStatement(companyId: ID!, target: CompanyTransferTarget!, locale: String): CompanyTransferStatement!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
target | CompanyTransferTarget! | |
locale | String |
companyTransfers#
Requires: platform key or token · scope platform_companies:read.
companyTransfers(companyId: ID!): [CompanyTransfer!]!
| Argument | Type | |
|---|---|---|
companyId | ID! |
platformAuditLogs#
Requires: platform key or token · scope audit:read.
platformAuditLogs(platformId: ID, filter: PlatformAuditLogFilter, first: Int, after: String): PlatformAuditLogConnection!
| Argument | Type | |
|---|---|---|
platformId | ID | |
filter | PlatformAuditLogFilter | |
first | Int | |
after | String |
platformSupportSettings#
Requires: platform key or token · scope support:read.
platformSupportSettings(platformId: ID): PlatformSupportSettings!
| Argument | Type | |
|---|---|---|
platformId | ID |
supportEscalations#
Requires: platform key or token · scope support:read.
supportEscalations(platformId: ID, status: [SupportEscalationStatus!], first: Int, after: String): [SupportEscalation!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
status | [SupportEscalationStatus!] | |
first | Int | |
after | String |
supportAccessGrants#
Requires: platform key or token · scope support:read.
supportAccessGrants(platformId: ID, companyId: ID!, includeEnded: Boolean): [SupportAccessGrant!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
includeEnded | Boolean |
platformRequestLogs#
Requires: platform key or token · scope request_logs:read.
platformRequestLogs(platformId: ID, filter: PlatformRequestLogFilter, first: Int, after: String): PlatformRequestLogConnection!
| Argument | Type | |
|---|---|---|
platformId | ID | |
filter | PlatformRequestLogFilter | |
first | Int | |
after | String |
platformOverview#
Requires: platform key or token · scope platform_usage:read.
platformOverview(platformId: ID, month: String): PlatformOverview!
| Argument | Type | |
|---|---|---|
platformId | ID | |
month | String |
platformAlerts#
Open or resolved alerts of the platform, newest first.
Requires: platform key or token · scope request_logs:read.
platformAlerts(platformId: ID, status: PlatformAlertStatus, first: Int): [PlatformAlert!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
status | PlatformAlertStatus | |
first | Int |
platformDataSourceHealth#
Per data source: companies, last event, lag, gaps, error rate, backfill status and the last errors.
Requires: platform key or token · scope data_sources:read.
platformDataSourceHealth(platformId: ID, key: String): [PlatformDataSourceHealth!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String |
Mutations#
createPlatformKey#
Requires: platform key or token.
createPlatformKey(input: CreatePlatformKeyInput!): PlatformKeyWithSecret!
| Argument | Type | |
|---|---|---|
input | CreatePlatformKeyInput! |
rollPlatformKey#
Requires: platform key or token.
rollPlatformKey(platformId: ID, id: ID!, expireOldInSeconds: Int): PlatformKeyWithSecret!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! | |
expireOldInSeconds | Int |
revokePlatformKey#
Requires: platform key or token.
revokePlatformKey(platformId: ID, id: ID!): PlatformKey!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
createPlatformCompany#
Requires: platform key or token · scope platform_companies:write.
createPlatformCompany(input: CreatePlatformCompanyInput!): PlatformCompanyResult!
| Argument | Type | |
|---|---|---|
input | CreatePlatformCompanyInput! |
updatePlatformCompany#
Requires: platform key or token · scope platform_companies:write.
updatePlatformCompany(input: UpdatePlatformCompanyInput!): PlatformCompany!
| Argument | Type | |
|---|---|---|
input | UpdatePlatformCompanyInput! |
upsertPlatformUser#
Requires: platform key or token · scope platform_users:write.
upsertPlatformUser(input: UpsertPlatformUserInput!): PlatformUser!
| Argument | Type | |
|---|---|---|
input | UpsertPlatformUserInput! |
setPlatformUserAccess#
Requires: platform key or token · scope platform_users:write.
setPlatformUserAccess(input: SetPlatformUserAccessInput!): PlatformUserAccess!
| Argument | Type | |
|---|---|---|
input | SetPlatformUserAccessInput! |
removePlatformUserAccess#
Requires: platform key or token · scope platform_users:write.
removePlatformUserAccess(platformId: ID, userId: ID!, profileId: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
userId | ID! | |
profileId | ID! |
revokePlatformUserTokens#
Refuses every token issued to the user so far and ends their embed sessions. The user and their access stay; the platform mints new tokens as usual.
Requires: platform key or token · scope platform_users:write.
revokePlatformUserTokens(platformId: ID, userId: ID!): PlatformUser!
| Argument | Type | |
|---|---|---|
platformId | ID | |
userId | ID! |
disablePlatformUser#
Requires: platform key or token · scope platform_users:write.
disablePlatformUser(platformId: ID, userId: ID!): PlatformUser!
| Argument | Type | |
|---|---|---|
platformId | ID | |
userId | ID! |
requestUserAccessChange#
Asks the platform to invite someone, change a role or remove access (webhook user.invite_requested, user.role_change_requested, user.removal_requested). Company admins only. Nothing is created or sent by FinBaze; returns the event name.
Requires: platform key or token.
requestUserAccessChange(platformId: ID, companyId: ID!, input: UserAccessRequestInput!): String!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
input | UserAccessRequestInput! |
createPlatformUserToken#
Requires: platform key or token · scope platform_tokens:write.
createPlatformUserToken(input: CreatePlatformUserTokenInput!): PlatformUserToken!
| Argument | Type | |
|---|---|---|
input | CreatePlatformUserTokenInput! |
setPlatformPortalRole#
Requires: platform key or token.
setPlatformPortalRole(input: SetPlatformPortalRoleInput!): PlatformPortalMember!
| Argument | Type | |
|---|---|---|
input | SetPlatformPortalRoleInput! |
seedTestCompany#
Creates a demo company from a template (sandbox only). Seeding the same externalId again returns the existing company.
Requires: platform key or token · scope platform_companies:write.
seedTestCompany(input: SeedTestCompanyInput!): PlatformCompany!
| Argument | Type | |
|---|---|---|
input | SeedTestCompanyInput! |
updatePlatformSandboxSettings#
Requires: platform key or token · scope platform_companies:write.
updatePlatformSandboxSettings(input: UpdatePlatformSandboxSettingsInput!): PlatformSandboxSettings!
| Argument | Type | |
|---|---|---|
input | UpdatePlatformSandboxSettingsInput! |
resetPlatformSandbox#
Deletes every sandbox company that is not marked preserve, deletes empty test clocks and seeds the configured templates again.
Requires: platform key or token · scope platform_companies:write.
resetPlatformSandbox(platformId: ID): SandboxResetResult!
| Argument | Type | |
|---|---|---|
platformId | ID |
bootstrapSampleApp#
Sandbox only. Sets up a sample app: a restricted test key and publishable key, a webhook endpoint at webhookUrl and its demo company. Portal sign-in only; 5 per day.
Requires: platform key or token.
bootstrapSampleApp(sample: String!, webhookUrl: String): SampleAppBootstrap!
| Argument | Type | |
|---|---|---|
sample | String! | |
webhookUrl | String |
setPlatformFeatureLimit#
Requires: platform key or token · scope platform_features:write.
setPlatformFeatureLimit(input: SetPlatformFeatureLimitInput!): PlatformFeatureLimit!
| Argument | Type | |
|---|---|---|
input | SetPlatformFeatureLimitInput! |
clearPlatformFeatureLimit#
Requires: platform key or token · scope platform_features:write.
clearPlatformFeatureLimit(platformId: ID, key: String!, profileId: ID): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
profileId | ID |
registerPlatformMobileApp#
Requires: platform key or token · scope platform_embed:write.
registerPlatformMobileApp(platformId: ID, input: PlatformMobileAppInput!): PlatformMobileApp!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | PlatformMobileAppInput! |
removePlatformMobileApp#
Requires: platform key or token · scope platform_embed:write.
removePlatformMobileApp(platformId: ID, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
createEmbedSession#
Requires: platform key or token.
createEmbedSession(input: CreateEmbedSessionInput!): CreateEmbedSessionResult!
| Argument | Type | |
|---|---|---|
input | CreateEmbedSessionInput! |
revokeEmbedSession#
Requires: platform key or token.
revokeEmbedSession(id: ID!): EmbedSession!
| Argument | Type | |
|---|---|---|
id | ID! |
revokeEmbedSessionsForUser#
Revokes every open or exchanged session of the user (optionally for one company). Returns the count.
Requires: platform key or token · scope platform_embed:write.
revokeEmbedSessionsForUser(platformUserId: ID!, companyId: ID): Int!
| Argument | Type | |
|---|---|---|
platformUserId | ID! | |
companyId | ID |
exchangeEmbedSession#
exchangeEmbedSession(input: ExchangeEmbedSessionInput!): EmbedToken!
| Argument | Type | |
|---|---|---|
input | ExchangeEmbedSessionInput! |
addPlatformAllowedOrigin#
Requires: platform key or token · scope platform_embed:write.
addPlatformAllowedOrigin(platformId: ID, origin: String!, kind: PlatformOriginKind!): PlatformAllowedOrigin!
| Argument | Type | |
|---|---|---|
platformId | ID | |
origin | String! | |
kind | PlatformOriginKind! |
removePlatformAllowedOrigin#
Requires: platform key or token · scope platform_embed:write.
removePlatformAllowedOrigin(platformId: ID, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
updatePlatformEmbedSettings#
Requires: platform key or token · scope platform_embed:write.
updatePlatformEmbedSettings(platformId: ID, input: UpdatePlatformEmbedSettingsInput!): PlatformEmbedSettings!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | UpdatePlatformEmbedSettingsInput! |
acknowledgeMessageIntent#
Requires: platform key or token.
acknowledgeMessageIntent(id: ID!, outcome: MessageIntentOutcome!): AcknowledgedMessageIntent!
| Argument | Type | |
|---|---|---|
id | ID! | |
outcome | MessageIntentOutcome! |
createPlatformWebhookEndpoint#
Requires: platform key or token · scope webhooks:write.
createPlatformWebhookEndpoint(input: CreatePlatformWebhookEndpointInput!, platformId: ID): PlatformWebhookEndpointWithSecret!
| Argument | Type | |
|---|---|---|
input | CreatePlatformWebhookEndpointInput! | |
platformId | ID |
updatePlatformWebhookEndpoint#
Requires: platform key or token · scope webhooks:write.
updatePlatformWebhookEndpoint(id: ID!, input: UpdatePlatformWebhookEndpointInput!, platformId: ID): PlatformWebhookEndpoint!
| Argument | Type | |
|---|---|---|
id | ID! | |
input | UpdatePlatformWebhookEndpointInput! | |
platformId | ID |
rotatePlatformWebhookSecret#
Requires: platform key or token · scope webhooks:write.
rotatePlatformWebhookSecret(id: ID!, keepPreviousHours: Int!, platformId: ID): PlatformWebhookEndpointWithSecret!
| Argument | Type | |
|---|---|---|
id | ID! | |
keepPreviousHours | Int! | |
platformId | ID |
deletePlatformWebhookEndpoint#
Requires: platform key or token · scope webhooks:write.
deletePlatformWebhookEndpoint(id: ID!, platformId: ID): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! | |
platformId | ID |
pingPlatformWebhookEndpoint#
Requires: platform key or token · scope webhooks:write.
pingPlatformWebhookEndpoint(id: ID!, platformId: ID): PlatformWebhookDelivery!
| Argument | Type | |
|---|---|---|
id | ID! | |
platformId | ID |
sendPlatformTestEvent#
Posts a signed example event of an available type to the endpoint and reports the answer. Nothing is stored.
Requires: platform key or token · scope webhooks:write.
sendPlatformTestEvent(endpointId: ID!, type: String!, platformId: ID): PlatformWebhookDelivery!
| Argument | Type | |
|---|---|---|
endpointId | ID! | |
type | String! | |
platformId | ID |
replayPlatformWebhookDelivery#
Requires: platform key or token · scope webhooks:write.
replayPlatformWebhookDelivery(id: ID!, platformId: ID): PlatformWebhookDelivery!
| Argument | Type | |
|---|---|---|
id | ID! | |
platformId | ID |
replayPlatformWebhookDeliveries#
Requires: platform key or token · scope webhooks:write.
replayPlatformWebhookDeliveries(endpointId: ID!, filter: PlatformDeliveryFilter!, platformId: ID): PlatformReplayJob!
| Argument | Type | |
|---|---|---|
endpointId | ID! | |
filter | PlatformDeliveryFilter! | |
platformId | ID |
resendPlatformEvent#
Requires: platform key or token · scope webhooks:write.
resendPlatformEvent(eventId: ID!, endpointId: ID!, platformId: ID): PlatformWebhookDelivery!
| Argument | Type | |
|---|---|---|
eventId | ID! | |
endpointId | ID! | |
platformId | ID |
registerDataSource#
Requires: platform key or token · scope data_sources:write.
registerDataSource(input: RegisterDataSourceInput!): DataSource!
| Argument | Type | |
|---|---|---|
input | RegisterDataSourceInput! |
updateDataSource#
Requires: platform key or token · scope data_sources:write.
updateDataSource(key: String!, input: UpdateDataSourceInput!): DataSource!
| Argument | Type | |
|---|---|---|
key | String! | |
input | UpdateDataSourceInput! |
retireDataSource#
Requires: platform key or token · scope data_sources:write.
retireDataSource(key: String!): DataSource!
| Argument | Type | |
|---|---|---|
key | String! |
attachDataSource#
Requires: platform key or token · scope data_sources:write.
attachDataSource(key: String!, company: CompanyRef!, backfillFrom: String): DataSourceAttachment!
| Argument | Type | |
|---|---|---|
key | String! | |
company | CompanyRef! | |
backfillFrom | String |
pauseDataSourceAttachment#
Requires: platform key or token · scope data_sources:write.
pauseDataSourceAttachment(key: String!, company: CompanyRef!): DataSourceAttachment!
| Argument | Type | |
|---|---|---|
key | String! | |
company | CompanyRef! |
detachDataSource#
Requires: platform key or token · scope data_sources:write.
detachDataSource(key: String!, company: CompanyRef!): DataSourceAttachment!
| Argument | Type | |
|---|---|---|
key | String! | |
company | CompanyRef! |
upsertFeedBankAccount#
Requires: platform key or token · scope monetary_accounts:write.
upsertFeedBankAccount(source: String!, company: CompanyRef!, account: BankAccountFeedInput!): FeedAccount!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
account | BankAccountFeedInput! |
ingestBankTransactions#
Requires: platform key or token · feature banking.
ingestBankTransactions(source: String!, company: CompanyRef!, account: String!, transactions: [BankTransactionFeedInput!]!): [FeedIngestResult!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
account | String! | |
transactions | [BankTransactionFeedInput!]! |
reportBankBalances#
Requires: platform key or token · scope monetary_accounts:write.
reportBankBalances(source: String!, company: CompanyRef!, account: String!, balances: [BankBalanceInput!]!): [BankBalanceAssertion!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
account | String! | |
balances | [BankBalanceInput!]! |
reportFeedWatermark#
Requires: platform key or token · scope monetary_accounts:write.
reportFeedWatermark(source: String!, company: CompanyRef!, account: String, completeThrough: String!): Boolean!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
account | String | |
completeThrough | String! |
ingestWorkedHours#
Requires: platform key or token · scope payroll:write · feature payroll.
ingestWorkedHours(source: String!, company: CompanyRef!, entries: [WorkedHoursFeedInput!]!): [FeedIngestResult!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
entries | [WorkedHoursFeedInput!]! |
ingestPayoutTransactions#
Requires: platform key or token · scope monetary_accounts:write.
ingestPayoutTransactions(source: String!, company: CompanyRef!, account: String!, payouts: [PayoutFeedInput!]!): [FeedIngestResult!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
account | String! | externalId of the PSP account the payouts leave. |
payouts | [PayoutFeedInput!]! |
ingestSalesInvoices#
Requires: platform key or token · feature sales_invoices.
ingestSalesInvoices(source: String!, company: CompanyRef!, invoices: [SalesInvoiceFeedInput!]!): [FeedIngestResult!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
invoices | [SalesInvoiceFeedInput!]! |
ingestPurchaseInvoices#
Requires: platform key or token · feature purchase_invoices.
ingestPurchaseInvoices(source: String!, company: CompanyRef!, invoices: [PurchaseInvoiceFeedInput!]!): [FeedIngestResult!]!
| Argument | Type | |
|---|---|---|
source | String! | |
company | CompanyRef! | |
invoices | [PurchaseInvoiceFeedInput!]! |
upsertRelation#
Requires: platform key or token · feature relations.
upsertRelation(input: UpsertRelationInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertRelationInput! |
upsertProduct#
Requires: platform key or token · feature products.
upsertProduct(input: UpsertProductInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertProductInput! |
upsertProject#
Requires: platform key or token · feature projects.
upsertProject(input: UpsertProjectInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertProjectInput! |
upsertCostCenter#
Requires: platform key or token · feature cost_centers.
upsertCostCenter(input: UpsertCostCenterInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertCostCenterInput! |
upsertSalesInvoice#
Requires: platform key or token · feature sales_invoices.
upsertSalesInvoice(input: UpsertSalesInvoiceInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertSalesInvoiceInput! |
upsertPurchaseInvoice#
Requires: platform key or token · feature purchase_invoices.
upsertPurchaseInvoice(input: UpsertPurchaseInvoiceInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertPurchaseInvoiceInput! |
upsertQuote#
Requires: platform key or token · feature quotes.
upsertQuote(input: UpsertQuoteInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertQuoteInput! |
upsertJournalEntry#
Requires: platform key or token.
upsertJournalEntry(input: UpsertJournalEntryInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertJournalEntryInput! |
upsertEmployee#
Requires: platform key or token · feature payroll.
upsertEmployee(input: UpsertEmployeeInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertEmployeeInput! |
upsertEmployment#
Requires: platform key or token · feature payroll.
upsertEmployment(input: UpsertEmploymentInput!): UpsertPayload!
| Argument | Type | |
|---|---|---|
input | UpsertEmploymentInput! |
setObjectMetadata#
Requires: platform key or token.
setObjectMetadata(type: PlatformObjectType!, id: ID!, metadata: JSON!): Boolean!
| Argument | Type | |
|---|---|---|
type | PlatformObjectType! | |
id | ID! | |
metadata | JSON! |
cancelPlatformBulkJob#
Requires: platform key or token · scope bulk:write.
cancelPlatformBulkJob(id: ID!): PlatformBulkJob!
| Argument | Type | |
|---|---|---|
id | ID! |
createPolicyDraft#
Requires: platform key or token · scope platform_policies:write.
createPolicyDraft(platformId: ID, kind: PolicyKind!, payload: JSONObject!): PlatformPolicyVersion!
| Argument | Type | |
|---|---|---|
platformId | ID | |
kind | PolicyKind! | |
payload | JSONObject! |
activatePolicyVersion#
Requires: platform key or token · scope platform_policies:write.
activatePolicyVersion(platformId: ID, id: ID!): PlatformPolicyVersion!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
setCompanyPolicyOverride#
Requires: platform key or token · scope platform_policies:write.
setCompanyPolicyOverride(platformId: ID, companyId: ID!, kind: PolicyKind!, payload: JSONObject!): JSONObject!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
kind | PolicyKind! | |
payload | JSONObject! |
clearCompanyPolicyOverride#
Requires: platform key or token · scope platform_policies:write.
clearCompanyPolicyOverride(platformId: ID, companyId: ID!, kind: PolicyKind!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
kind | PolicyKind! |
applyChartTemplate#
Adds the platform chart template to an existing company: new accounts and hidden accounts. Never removes an account.
Requires: platform key or token · scope platform_policies:write.
applyChartTemplate(platformId: ID, companyId: ID!): ChartTemplateApplied!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! |
promotePlatformPolicies#
Sandbox only. Snapshots the active policies and returns a bundle id for production.
Requires: platform key or token.
promotePlatformPolicies(platformId: ID, kinds: [PolicyKind!]): String!
| Argument | Type | |
|---|---|---|
platformId | ID | |
kinds | [PolicyKind!] |
previewPolicyImport#
Production only. Fetches the sandbox bundle, verifies it and shows what would change.
Requires: platform key or token.
previewPolicyImport(platformId: ID, bundleId: String!): PolicyImportPreview!
| Argument | Type | |
|---|---|---|
platformId | ID | |
bundleId | String! |
confirmPolicyImport#
Requires: platform key or token.
confirmPolicyImport(platformId: ID, importId: ID!): [PlatformPolicyVersion!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
importId | ID! |
upsertCustomAction#
Requires: platform key or token · scope platform_extensions:write.
upsertCustomAction(platformId: ID, input: UpsertCustomActionInput!): PlatformCustomAction!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | UpsertCustomActionInput! |
deleteCustomAction#
Requires: platform key or token · scope platform_extensions:write.
deleteCustomAction(platformId: ID, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
invokeCustomAction#
A user clicked a custom action. Emits custom_action.invoked when the action delivers by webhook.
Requires: platform key or token · scope platform_extensions:read.
invokeCustomAction(platformId: ID, key: String!, contextType: String!, contextId: ID!): InvokedCustomAction!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
contextType | String! | |
contextId | ID! |
invokeSlotItem#
A user clicked an item in a slot you rendered (headerActions, rowActions, ...). Same path as a custom action: emits custom_action.invoked.
Requires: platform key or token · scope platform_extensions:read.
invokeSlotItem(platformId: ID, slot: String!, key: String!, contextType: String!, contextId: ID!): InvokedCustomAction!
| Argument | Type | |
|---|---|---|
platformId | ID | |
slot | String! | |
key | String! | |
contextType | String! | |
contextId | ID! |
upsertLinkTemplate#
Requires: platform key or token · scope platform_extensions:write.
upsertLinkTemplate(platformId: ID, input: UpsertLinkTemplateInput!): PlatformLinkTemplate!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | UpsertLinkTemplateInput! |
deleteLinkTemplate#
Requires: platform key or token · scope platform_extensions:write.
deleteLinkTemplate(platformId: ID, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
upsertCustomFieldDefinition#
Requires: platform key or token · scope platform_extensions:write.
upsertCustomFieldDefinition(platformId: ID, input: UpsertCustomFieldDefinitionInput!): CustomFieldDefinition!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | UpsertCustomFieldDefinitionInput! |
archiveCustomFieldDefinition#
Requires: platform key or token · scope platform_extensions:write.
archiveCustomFieldDefinition(platformId: ID, id: ID!): CustomFieldDefinition!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
setCustomFieldValues#
Merges values into the object’s custom fields; null removes a key.
Requires: platform key or token · scope platform_extensions:write.
setCustomFieldValues(platformId: ID, entityType: String!, entityId: ID!, values: JSONObject!): JSONObject!
| Argument | Type | |
|---|---|---|
platformId | ID | |
entityType | String! | |
entityId | ID! | |
values | JSONObject! |
setFieldControl#
Requires: platform key or token · scope platform_extensions:write.
setFieldControl(platformId: ID, input: SetFieldControlInput!): FieldControl!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | SetFieldControlInput! |
clearFieldControl#
Requires: platform key or token · scope platform_extensions:write.
clearFieldControl(platformId: ID, view: String!, field: String!, companyId: ID): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
view | String! | |
field | String! | |
companyId | ID |
definePlatformRecordType#
Requires: platform key or token · scope custom_records:write.
definePlatformRecordType(platformId: ID, input: DefineRecordTypeInput!): PlatformRecordType!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | DefineRecordTypeInput! |
upsertCustomRecord#
Requires: platform key or token · scope custom_records:write.
upsertCustomRecord(input: UpsertCustomRecordInput!): UpsertCustomRecordPayload!
| Argument | Type | |
|---|---|---|
input | UpsertCustomRecordInput! |
deleteCustomRecord#
Requires: platform key or token · scope custom_records:write.
deleteCustomRecord(company: CompanyRef!, type: String!, externalId: String!): Boolean!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
type | String! | |
externalId | String! |
saveFlowTemplate#
Requires: platform key or token · scope custom_records:write.
saveFlowTemplate(platformId: ID, source: String!, format: FlowTemplateFormat!): FlowTemplate!
| Argument | Type | |
|---|---|---|
platformId | ID | |
source | String! | |
format | FlowTemplateFormat! |
activateFlowTemplate#
Requires: platform key or token · scope custom_records:write.
activateFlowTemplate(platformId: ID, key: String!, version: Int!): FlowTemplate!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
version | Int! |
retireFlowTemplate#
Requires: platform key or token · scope custom_records:write.
retireFlowTemplate(platformId: ID, key: String!): FlowTemplate!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! |
testFlowTemplate#
Requires: platform key or token · scope custom_records:write.
testFlowTemplate(platformId: ID, source: String!, format: FlowTemplateFormat!, records: [JSON!]!, company: CompanyRef): FlowTemplateTestResult!
| Argument | Type | |
|---|---|---|
platformId | ID | |
source | String! | |
format | FlowTemplateFormat! | |
records | [JSON!]! | |
company | CompanyRef |
retryFlowRun#
Requires: platform key or token · scope custom_records:write.
retryFlowRun(platformId: ID, id: ID!): FlowRun!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
requestXafExport#
Requires: platform key or token · scope exports:write.
requestXafExport(company: CompanyRef!, financialYear: Int, from: String, to: String, version: String): PlatformExportRun!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
financialYear | Int | |
from | String | |
to | String | |
version | String | Auditfile Financieel version: "4.0" (default; the only version the Belastingdienst accepts from 2027) or "3.2". |
requestAuditLogExport#
Requires: platform key or token · scope exports:write.
requestAuditLogExport(filter: PlatformAuditLogFilter): PlatformExportRun!
| Argument | Type | |
|---|---|---|
filter | PlatformAuditLogFilter |
createPlatformExportDestination#
Requires: platform key or token · scope exports:write.
createPlatformExportDestination(platformId: ID, input: CreateExportDestinationInput!): PlatformExportDestination!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | CreateExportDestinationInput! |
updatePlatformExportDestinationCredentials#
Requires: platform key or token · scope exports:write.
updatePlatformExportDestinationCredentials(platformId: ID, key: String!, credentials: JSON!, credentialsExpireAt: DateTime): PlatformExportDestination!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
credentials | JSON! | |
credentialsExpireAt | DateTime |
deletePlatformExportDestination#
Requires: platform key or token · scope exports:write.
deletePlatformExportDestination(platformId: ID, key: String!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! |
createPlatformExportSchedule#
Requires: platform key or token · scope exports:write.
createPlatformExportSchedule(platformId: ID, input: CreateExportScheduleInput!): PlatformExportSchedule!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | CreateExportScheduleInput! |
updatePlatformExportSchedule#
Requires: platform key or token · scope exports:write.
updatePlatformExportSchedule(platformId: ID, key: String!, input: UpdateExportScheduleInput!): PlatformExportSchedule!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
input | UpdateExportScheduleInput! |
runPlatformExportNow#
Requires: platform key or token · scope exports:write.
runPlatformExportNow(platformId: ID, key: String!, companies: [CompanyRef!]): PlatformExportRun!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
companies | [CompanyRef!] | Limit this run to these companies (within the schedule's own scope). Watermarks of the other companies stay where they are, so their next run still carries their changes. |
requestCompanyExport#
Starts an export of the company for a calendar year: the audit file (XAF, built in the background; poll companyExports) or the profit and loss as PDF or Excel (ready at once).
Requires: platform key or token.
requestCompanyExport(platformId: ID, companyId: ID!, kind: CompanyExportKind!, financialYear: Int): CompanyExport!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
kind | CompanyExportKind! | |
financialYear | Int |
upsertPlatformProvider#
Requires: platform key or token · scope platform_payments:write.
upsertPlatformProvider(input: UpsertPlatformProviderInput!): PlatformProvider!
| Argument | Type | |
|---|---|---|
input | UpsertPlatformProviderInput! |
createTaxPaymentRequest#
Requires: platform key or token · scope platform_payments:write.
createTaxPaymentRequest(company: CompanyRef!, taxFilingId: ID!): PaymentRequest!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
taxFilingId | ID! |
createPaymentRequestFromBatch#
Requires: platform key or token · scope platform_payments:write.
createPaymentRequestFromBatch(company: CompanyRef!, paymentBatchId: ID!): PaymentRequest!
| Argument | Type | |
|---|---|---|
company | CompanyRef! | |
paymentBatchId | ID! |
reportPaymentRequestStatus#
Requires: platform key or token · scope platform_payments:write.
reportPaymentRequestStatus(input: ReportPaymentRequestStatusInput!): PaymentRequest!
| Argument | Type | |
|---|---|---|
input | ReportPaymentRequestStatusInput! |
cancelPaymentRequest#
Requires: platform key or token · scope platform_payments:write.
cancelPaymentRequest(id: ID!): PaymentRequest!
| Argument | Type | |
|---|---|---|
id | ID! |
providePaymentLink#
Requires: platform key or token · scope platform_payments:write · feature online_payments.
providePaymentLink(requestId: ID!, url: String!, expiresAt: DateTime): PaymentLinkRequest!
| Argument | Type | |
|---|---|---|
requestId | ID! | |
url | String! | |
expiresAt | DateTime |
reportTaxReservation#
Requires: platform key or token · scope platform_payments:write.
reportTaxReservation(adviceId: ID!, reservedMinor: Int!, accountRef: String): TaxReservationAdvice!
| Argument | Type | |
|---|---|---|
adviceId | ID! | |
reservedMinor | Int! | |
accountRef | String |
completeStepUpChallengeWithDeviceAssertion#
Requires: platform key or token.
completeStepUpChallengeWithDeviceAssertion(challengeId: ID!): StepUpChallenge!
| Argument | Type | |
|---|---|---|
challengeId | ID! |
approvePaymentRequest#
Requires: platform key or token.
approvePaymentRequest(id: ID!): PaymentRequest!
| Argument | Type | |
|---|---|---|
id | ID! |
previewPlatformPromotion#
Production only. Fetches the sandbox config, validates it against the production allowance.
Requires: platform key or token.
previewPlatformPromotion(platformId: ID!): PlatformPromotionPreview!
| Argument | Type | |
|---|---|---|
platformId | ID! |
applyPlatformPromotion#
Requires: platform key or token.
applyPlatformPromotion(platformId: ID!, previewId: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID! | |
previewId | ID! |
createTestClock#
Requires: platform key or token · scope platform_companies:write.
createTestClock(name: String!, frozenTime: DateTime!, platformId: ID): TestClock!
| Argument | Type | |
|---|---|---|
name | String! | |
frozenTime | DateTime! | |
platformId | ID |
advanceTestClock#
Moves the clock to to, day by day, running the per-company jobs. Returns at once; the platform webhooks test_clock.ready and test_clock.failed report the end.
Requires: platform key or token · scope platform_companies:write.
advanceTestClock(id: ID!, to: DateTime!, options: AdvanceTestClockOptionsInput, platformId: ID): TestClock!
| Argument | Type | |
|---|---|---|
id | ID! | |
to | DateTime! | |
options | AdvanceTestClockOptionsInput | |
platformId | ID |
deleteTestClock#
Deletes the clock and its companies.
Requires: platform key or token · scope platform_companies:write.
deleteTestClock(id: ID!, platformId: ID): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! | |
platformId | ID |
suspendPlatformCompany#
Requires: platform key or token · scope platform_companies:write.
suspendPlatformCompany(companyId: ID!, platformId: ID, reason: String, displayMessage: String): PlatformCompany!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
reason | String | |
displayMessage | String |
reactivatePlatformCompany#
Requires: platform key or token · scope platform_companies:write.
reactivatePlatformCompany(companyId: ID!, platformId: ID): PlatformCompany!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
closePlatformCompany#
Requires: platform key or token · scope platform_companies:write.
closePlatformCompany(companyId: ID!, platformId: ID, effectiveDate: String!, reason: String): PlatformCompany!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
effectiveDate | String! | YYYY-MM-DD: the day the company stops trading. |
reason | String |
reopenPlatformCompany#
Requires: platform key or token · scope platform_companies:write.
reopenPlatformCompany(companyId: ID!, platformId: ID): PlatformCompany!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
archivePlatformCompany#
Requires: platform key or token · scope platform_companies:write.
archivePlatformCompany(companyId: ID!, platformId: ID): PlatformCompany!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
platformId | ID | Portal callers: the platform. Tokens: omit. |
createCompanyTransfer#
Requires: platform key or token.
createCompanyTransfer(companyId: ID!, target: CompanyTransferTarget!, email: String, statementVersion: String!, statementHash: String!, stepUpAssertionId: ID): CompanyTransferCreated!
| Argument | Type | |
|---|---|---|
companyId | ID! | |
target | CompanyTransferTarget! | |
email | String | |
statementVersion | String! | |
statementHash | String! | |
stepUpAssertionId | ID |
cancelCompanyTransfer#
Requires: platform key or token · scope platform_companies:write.
cancelCompanyTransfer(transferId: ID!): CompanyTransfer!
| Argument | Type | |
|---|---|---|
transferId | ID! |
acceptCompanyTransfer#
Requires: platform key or token · scope platform_companies:write.
acceptCompanyTransfer(code: String!, externalId: String): PlatformCompany!
| Argument | Type | |
|---|---|---|
code | String! | |
externalId | String |
deprovisionPlatformUser#
Requires: platform key or token · scope platform_users:write.
deprovisionPlatformUser(userId: ID!, anonymise: Boolean): Boolean!
| Argument | Type | |
|---|---|---|
userId | ID! | |
anonymise | Boolean |
updatePlatformSupportSettings#
Requires: platform key or token · scope support:write.
updatePlatformSupportSettings(input: PlatformSupportSettingsInput!): PlatformSupportSettings!
| Argument | Type | |
|---|---|---|
input | PlatformSupportSettingsInput! |
createSupportEscalation#
Requires: platform key or token · scope support:write.
createSupportEscalation(platformId: ID, input: CreateSupportEscalationInput!): SupportEscalation!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | CreateSupportEscalationInput! |
requestPlatformSupport#
Requires: platform key or token.
requestPlatformSupport(platformId: ID, companyId: ID!, screen: String, requestIds: [String!], componentVersion: String): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
companyId | ID! | |
screen | String | |
requestIds | [String!] | |
componentVersion | String |
addSupportEscalationComment#
Requires: platform key or token · scope support:write.
addSupportEscalationComment(platformId: ID, escalationId: ID!, body: String!): SupportEscalationComment!
| Argument | Type | |
|---|---|---|
platformId | ID | |
escalationId | ID! | |
body | String! |
decideSupportAccess#
Requires: platform key or token · scope support:write.
decideSupportAccess(platformId: ID, grantId: ID!, approve: Boolean!, attestation: String, stepUpAssertionId: ID): SupportAccessGrant!
| Argument | Type | |
|---|---|---|
platformId | ID | |
grantId | ID! | |
approve | Boolean! | |
attestation | String | |
stepUpAssertionId | ID | Informational: the step-up proof travels in the FinBaze-Step-Up header (Wave 4.5). |
revokeSupportAccess#
Requires: platform key or token · scope support:write.
revokeSupportAccess(platformId: ID, grantId: ID!): SupportAccessGrant!
| Argument | Type | |
|---|---|---|
platformId | ID | |
grantId | ID! |
setPlatformDataSourceStatus#
Pause or resume a data source (portal).
Requires: platform key or token · scope data_sources:write.
setPlatformDataSourceStatus(platformId: ID, key: String!, status: String!): PlatformDataSourceHealth!
| Argument | Type | |
|---|---|---|
platformId | ID | |
key | String! | |
status | String! |
requestPlatformDataSourceResync#
Asks the platform to deliver a period of one company again: the attachment goes back to backfill pending and a data_source.resync_requested event is sent.
Requires: platform key or token · scope data_sources:write.
requestPlatformDataSourceResync(input: RequestDataSourceResyncInput!): PlatformDataSourceHealth!
| Argument | Type | |
|---|---|---|
input | RequestDataSourceResyncInput! |