PayloadError

A PayloadError is an error in the response payload of a query or mutation.

PayloadError has the following properties (all optional):

• A list of 'fieldErrors' (validation errors specific to a particular field in the input).
• A 'message', possibly something we'd show to the user.
• A 'code' that can be used to respond with a certain behavior on the client.

Different calls can decide how to use these fields, but the presence of ANY field implies some error happened during execution.

type PayloadError {
  code: ErrorCode
  fieldErrors: [FieldError!]
  message: String
}

Fields

PayloadError.code ● ErrorCode enum

PayloadError.fieldErrors ● [FieldError!] list object

PayloadError.message ● String scalar

Member Of

ApplyStripeCancelDiscountOffer object ● ArchiveGoal object ● ArchiveSavingsGoal object ● AssignTaxScheduleCategoryMapping object ● AssignTransactionToStream object ● BulkDeleteTransactionsMutation object ● BulkUpdateTransactionsMutation object ● CancelDataProviderSwitchMutation object ● CancelSponsorship object ● CancelStripeSubscriptionMutation object ● ChangeStripeSubscriptionMutation object ● ClearBudgetMutation object ● ClearHoldingClassification object ● ClearSecurityClassification object ● CompleteRetailSync object ● ConfirmDataProviderSwitchMappingsMutation object ● ConfirmSavingsGoalMigration object ● ConfirmTOTPDevice object ● ConvertEmployeeTrial object ● CopySnapshots object ● CreateAccountsFromPlaidToken object ● CreateAdditionalRecurringTransactionStreamMutation object ● CreateAdvisorStripeSubscriptionMutation object ● CreateAIReport object ● CreateBudgetMutation object ● CreateBulkRetailSync object ● CreateCategoryPayload object ● CreateCoinbaseAccountMutation object ● CreateEquityAccountMutation object ● CreateEquityAccountWithGrantsMutation object ● CreateEquityGrantMutation object ● CreateFeedbackEvent object ● CreateFinancialInsightExclusion object ● CreateFinicityConnectFixUrlMutation object ● CreateFinicityConnectUrlMutation object ● CreateFinicityCredentialsMutation object ● CreateForecastScenarioMutation object ● CreateGoal object ● CreateGoalAccountAllocation object ● CreateGoalAccountInitialContributions object ● CreateGoals object ● CreateHouseholdAccessGrant object ● CreateInstitutionIssueReportMutationPayload object ● CreateManualAccountMutation object ● CreateManualHolding object ● CreateManualInvestmentsAccount object ● CreateManualTaxLot object ● CreateMXConnectFixUrlMutation object ● CreateMXConnectUrlMutation object ● CreateMXCredentialsMutation object ● CreateOrUpdateGoalPlannedContribution object ● CreatePaycheck object ● CreatePaycheckEmployer object ● CreatePromoCodeCheckoutSession object ● CreateReportConfiguration object ● CreateRetailSync object ● CreateSavingsGoal object ● CreateSavingsGoalContribution object ● CreateSavingsGoals object ● CreateSavingsGoalWithdrawal object ● CreateSpinwheelAccountMappingMutation object ● CreateSpinwheelTokenMutation object ● CreateSponsorshipInvites object ● CreateStripeCheckoutSession object ● CreateStripeSubscriptionMutation object ● CreateSyncedRealEstateAccount object ● CreateSyncedVehicleAccount object ● CreateTransactionFilterSetMutation object ● CreateTransactionMutation object ● CreateTransactionRuleV2Mutation object ● CreateTransactionTag object ● CreateTrustedReceiptSender object ● CreateUnconfirmedTOTPDevice object ● DeleteAccountLogoMutation object ● DeleteAccountMutation object ● DeleteAllHouseholdTransactionTags object ● DeleteAllMessageThreads object ● DeleteAllReconciliationRecordsForHousehold object ● DeleteAllTransactionRules object ● DeleteBusinessEntity object ● DeleteBusinessEntityLogo object ● DeleteCategoryGroupMutation object ● DeleteCategoryMutation object ● DeleteCredentialMutation object ● DeleteEquityGrantMutation object ● DeleteFinancialInsightExclusion object ● DeleteForecastAccountMutation object ● DeleteForecastScenarioMutation object ● DeleteGoal object ● DeleteGoalAccountAllocation object ● DeleteGoalReconciliationRecordsForTransaction object ● DeleteHolding object ● DeleteHouseholdMutation object ● DeleteMerchantLogoMutation object ● DeletePaycheck object ● DeletePaycheckEmployer object ● DeleteReceipt object ● DeleteReportConfiguration object ● DeleteSavingsGoal object ● DeleteSyncedSnapshotsMutation object ● DeleteSyncedTransactionsMutation object ● DeleteTaxLot object ● DeleteTaxLotsBulk object ● DeleteTaxScheduleCategoryMapping object ● DeleteTOTPDevice object ● DeleteTransactionAttachmentMutation object ● DeleteTransactionFilterSetMutation object ● DeleteTransactionMutation object ● DeleteTransactionRuleV2Mutation object ● DeleteTransactionsMutation object ● DeleteTransactionTag object ● DeleteTrustedReceiptSender object ● DeleteUnmatchedRetailSync object ● DeleteUserFromHouseholdMutation object ● DeleteUserProfilePicture object ● DetectRecurrenceGroups object ● DisableCredentialAndDeleteFromDataProviderMutation object ● DisconnectSpinwheel object ● DispatchSavingsGoalMigration object ● DuplicateForecastScenarioMutation object ● EndBrowserAutomation object ● ExtendFreeTrialForSevenDaysMutation object ● FixCoinbaseCredentialMutation object ● ForceRefreshAccountMutation object ● ForceRefreshAccountsMutation object ● ForceRefreshAllAccountsMutation object ● GetLogoCloudinaryUploadInfoMutation object ● GetMerchantLogoCloudinaryUploadInfoMutation object ● GetTransactionAttachmentUploadInfoMutation object ● GetUserProfilePictureCloudinaryUploadInfoMutation object ● GiveEmployeeInfinitePlusAccess object ● GiveEmployeeInfinitePremiumAccess object ● InitScheduleCDefaultMappings object ● InviteUserToHouseholdMutation object ● LinkTransactionToGoal object ● MarkAdviceItemTaskComplete object ● MarkAdviceItemTaskCompleteV2 object ● MarkAdviceItemTaskIncomplete object ● MarkAdviceItemTaskIncompleteV2 object ● MarkDataProviderSwitchConnectedMutation object ● MarkGoalComplete object ● MarkGoalIncomplete object ● MarkStreamAsNotRecurringMutation object ● MatchRetailTransaction object ● MigrateHouseholdToSavingsGoals object ● MoveMoneyMutation object ● MoveTransactions object ● PopulateBusinessEntityDemo object ● PopulateMultiRecurrenceDemo object ● ReactivateStripeSubscriptionMutation object ● ReconcileAccountGoalSpendingForTransactions object ● ReconcileExternalSpending object ● RedeemTrustAndWillMutation object ● ReleasePendingStripeCheckoutSession object ● RemoveEmployeeEntitlements object ● ReplaceForecastEventsMutation object ● ResendReferralRewardEmail object ● ResendTrustedReceiptSenderVerification object ● ResetAndSyncAccountMutation object ● ResetBudgetMutation object ● ResetBudgetRolloverMutation object ● ResetCategorizationMemoryMutation object ● ResetEmployeeAndSubscribe object ● ResetEmployeeToNoSubscription object ● ResetForecastDataMutation object ● ResetRecapMutation object ● RestoreCategoryMutation object ● ReviewRecurringStreamMutation object ● RevokeConnectedApp object ● RevokeInviteToHouseholdMutation object ● RevokeSponsorshipInvite object ● RunBrowserAgent object ● SaveDebtPaydownProjectionToBudget object ● SaveForecastAccountsMutation object ● SaveForecastParticipantOverridesMutation object ● SaveForecastPriorityRulesMutation object ● SaveForecastScenarioKpisMutation object ● SetAccountLogoMutation object ● SetDebtPaydownBudgetAmount object ● SetEmployeeActiveSubscription object ● SetEmployeeBillingIssue object ● SetEmployeeCancellationDiscountUsed object ● SetEmployeeExpiredTrial object ● SetEmployeePlusTrialFields object ● SetEmployeeSubscriptionEnded object ● SetFinancialInsightsEnabled object ● SetHoldingClassification object ● SetMerchantLogoMutation object ● SetSavingsGoalBudgetAmount object ● SetSecurityClassification object ● SetTransactionTags object ● SetUserProfilePictureMutation object ● SoftDeleteFinancialInsight object ● SpendFromGoal object ● StartBrowserAutomation object ● StartDataProviderSwitchMutation object ● StartRetailSync object ● StartSavingsGoalMigration object ● SubmitProductFeedback object ● SyncAppleFinanceKitAccountInfo object ● SyncCredentialAfterReconnectMutation object ● SyncEmployeeSubscription object ● TransactionAddAttachmentMutation object ● TransferAccountDataAsyncMutation object ● TransferAccountDataMutation object ● UnarchiveGoal object ● UnarchiveSavingsGoal object ● UndeleteAccountMutation object ● UndoHouseholdSavingsGoalsMigration object ● UnmatchRetailTransaction object ● UpdateAccountGroupOrderMutation object ● UpdateAccountIncludeInGoals object ● UpdateAccountMutation object ● UpdateAccountsMutation object ● UpdateAllNotificationPreferencesForPlatform object ● UpdateBillAmountMutation object ● UpdateBillingPostalCodeMutation object ● UpdateBillPaidMutation object ● UpdateCategoryPayload object ● UpdateCompanyMutation object ● UpdateCredentialMutation object ● UpdateDashboardConfigMutation object ● UpdateEquityGrantMutation object ● UpdateFinancialInsightStatus object ● UpdateForecastScenarioComparison object ● UpdateForecastScenarioMutation object ● UpdateForecastScenarioOrderMutation object ● UpdateGoal object ● UpdateGoalAccountAllocation object ● UpdateGoalPriorities object ● UpdateGoals object ● UpdateHolding object ● UpdateHouseholdProfile object ● UpdateMe object ● UpdateMerchantMutation object ● UpdateMyHousehold object ● UpdateNotificationPreferences object ● UpdateOrCreateBudgetItemMutation object ● UpdateOrCreateFlexBudgetItemMutation object ● UpdateOrCreateStripePaymentMethodMutation object ● UpdatePaycheck object ● UpdatePaycheckEmployer object ● UpdateRecurringTransactionStreamMutation object ● UpdateReportConfiguration object ● UpdateRetailOrder object ● UpdateRetailVendorSettings object ● UpdateReviewCheckinMutation object ● UpdateSavingsGoal object ● UpdateSavingsGoalsPriorities object ● UpdateSponsor object ● UpdateSponsorshipInvite object ● UpdateTaxLot object ● UpdateTransactionMutation object ● UpdateTransactionRuleV2Mutation object ● UpdateTransactionSplitMutation object ● UpdateTransactionTag object ● UpdateTransactionTagOrder object ● UpdateUserFinancialProfile object ● UpdateUserProfile object ● UpsertBusinessEntity object ● UpsertCreditScoreSnapshotMutation object ● VerifyTrustedReceiptSender object ● WithdrawAllGoalContributionsFromAccount object