Bundul
Internal
Browse docs
Waiting for review

generated

Data model (53 collections, 15 embedded types)

Generated from the code on every merge. Do not edit it — fix the generator instead.

Written by the build · 2 September 2026

Data model (53 collections, 15 embedded types)

Generated from commit 2ebf341 on 2026-09-02 by tools/docs/generate.ts. Do not edit this file. Fix the generator instead.

A class counts as a collection only when a module registers it with MongooseModule.forFeature. The rest are embedded sub-documents that live inside another document.

Collections

Model Collection Fields Defined in
AccountInfo Mongoose default 6 plaid/schemas/plaid-account-info.schema.ts
AchDebitEscalation Mongoose default 6 payment/schemas/ach-debit-escalation.schema.ts
AdminAccount adminaccounts 17 admin-management/schemas/admin-account.schema.ts
AdminAuditLog adminauditlogs 8 admin-management/schemas/admin-audit-log.schema.ts
AirtableOtpRequest Mongoose default 2 airtable/triggers/schemas/airtable-otp-requests.schema.ts
AppConfig Mongoose default 4 app-config/schemas/app-config.schema.ts
Brand Mongoose default 13 logo-resolver/schemas/brand.schema.ts
BundleRun Mongoose default 17 bundle-run/schemas/bundle-run.schema.ts
BundleRunItem Mongoose default 20 bundle-run/schemas/bundle-run-item.schema.ts
BundleRunSetting Mongoose default 2 bundle-run/schemas/bundle-run-setting.schema.ts
BundulSummary Mongoose default 9 bundul-report/schemas/bundul-summary.schema.ts
BundulSupportedSubscription Mongoose default 11 subscriptions/schemas/subscription.schema.ts
CardEvent Mongoose default 5 webhook/schemas/card-event.schema.ts
CredentialRevealAudit Mongoose default 6 bundle-run/schemas/credential-reveal-audit.schema.ts
CronLock cronlocks 3 common/cron-lock/cron-lock.schema.ts
CustomerCashLedger Mongoose default 18 ledger/schemas/customer-cash-ledger.schema.ts
CustomerUtility Mongoose default 19 airtable/schemas/customer-utility.schema.ts
DiscountCode Mongoose default 15 promotions/schemas/discount-code.schema.ts
Doc docs 12 docs-store/schemas/doc.schema.ts
Feedback Mongoose default 7 feedback/schemas/feedback.schema.ts
InstitutionInfo Mongoose default 5 plaid/schemas/plaid-institution-info.schema.ts
JoinBeta Mongoose default 4 users/schemas/join-beta.schema.ts
MoneyMovement Mongoose default 21 ledger/schemas/money-movement.schema.ts
NotificationLog Mongoose default 9 notifications/schemas/notification-log.schema.ts
PassportPaymentRecord Mongoose default 9 payment/schemas/passport-payment-record.schema.ts
PendingConnection Mongoose default 6 automation/schemas/pending-connection.schema.ts
PlaidToken Mongoose default 4 users/schemas/user-plaid.schema.ts
PlatformPromotion platformpromotions 8 promotions/schemas/platform-promotion.schema.ts
Pricing Mongoose default 6 pricing/schemas/pricing.schema.ts
ProcessedLogo Mongoose default 6 logo-resolver/schemas/processed-logo.schema.ts
Promotion Mongoose default 15 promotions/schemas/promotion.schema.ts
PromotionReward Mongoose default 12 promotions/schemas/promotion-reward.schema.ts
PushNotificationLog pushnotificationlogs 15 push-notification/schemas/push-notification-log.schema.ts
ReferralCode Mongoose default 11 promotions/schemas/referral-code.schema.ts
RefreshToken Mongoose default 9 users/schemas/refresh-token.schema.ts
RepricingEvaluation Mongoose default 9 utility-insights/schemas/repricing-evaluation.schema.ts
SupportTicket Mongoose default 10 feedback/schemas/support-ticket.schema.ts
TransactionCursor Mongoose default 4 plaid/schemas/transaction-cursor.schema.ts
TrueUpRecord Mongoose default 29 trueup/schemas/trueup-record.schema.ts
User Mongoose default 40 users/schemas/user.schema.ts
UserBundulSupportedSubscription Mongoose default 6 subscriptions/schemas/user-supported-subscription.schema.ts
UserEmailMailAccess Mongoose default 17 email-parser/schemas/email-access.schema.ts
UserPassportSubscription Mongoose default 39 payment/schemas/user-passport-sub.schema.ts
UserPlaidRecurringTransactions Mongoose default 20 users/schemas/user-recurring-transactions.schema.ts
UserPlaidTransactions Mongoose default 11 users/schemas/user-transactions.schema.ts
UserSubscription Mongoose default 39 subscriptions/schemas/user-subscription.schema.ts
UtilityBill Mongoose default 25 utility-insights/schemas/utility-bill.schema.ts
UtilityBillInsight Mongoose default 23 utility-insights/schemas/utility-bill-insight.schema.ts
UtilityInsightSetting Mongoose default 7 utility-insights/schemas/utility-insight-setting.schema.ts
UtilityPriceChange Mongoose default 24 utility-insights/schemas/utility-price-change.schema.ts
UtilityRefreshRun Mongoose default 12 subscriptions/schemas/utility-refresh-run.schema.ts
VirtualCard Mongoose default 13 virtual-card/schemas/virtual-card.schema.ts
VirtualCardLedgerEntry Mongoose default 12 virtual-card/schemas/virtual-card-ledger.schema.ts

Embedded types (15)

Not collections of their own — these are stored inside a parent document.

Type Fields Defined in
AccessTokenDetails 8 users/schemas/user-plaid.schema.ts
AchPaymentDetails 40 subscriptions/schemas/user-subscription.schema.ts
Amount 21 users/schemas/user-recurring-transactions.schema.ts
BundleRunChargePolicy 18 bundle-run/schemas/bundle-run.schema.ts
BundleRunItemHistoryEntry 23 bundle-run/schemas/bundle-run-item.schema.ts
Business 19 users/schemas/business.schema.ts
Category 24 users/schemas/user-recurring-transactions.schema.ts
CredentialRequirement 17 subscriptions/schemas/subscription.schema.ts
DocRevision 17 docs-store/schemas/doc.schema.ts
OneSubHistoryEntry 40 payment/schemas/user-passport-sub.schema.ts
QuarterPosition 30 utility-insights/schemas/utility-bill-insight.schema.ts
StripeMandateData 40 users/schemas/user.schema.ts
SubscriptionBreakdownItem 18 ledger/schemas/customer-cash-ledger.schema.ts
SubscriptionInfo 40 payment/schemas/user-passport-sub.schema.ts
UtilityInvoiceDetection 16 subscriptions/schemas/subscription.schema.ts

Fields

AccountInfo

Field Type
user Types.ObjectId
accessToken string
account_id string
name string
mask string
accountType string

AchDebitEscalation

Field Type
externalTransactionId string
eventType string
mappedUserId `Types.ObjectId
mappingMethod string
resolution string
actionable boolean

AdminAccount

Field Type
email string
password string
firstName string
lastName string
role Role
permissions string[]
adminStatus AdminStatus
invitedBy string
adminInviteTokenHash string
adminInviteExpiresAt Date
passwordSetAt Date
loginOtpHash string
loginOtpExpiresAt Date
loginOtpAttempts number
loginOtpSentAt Date
lastLogin Date
isDeleted boolean

AdminAuditLog

Field Type
action string
actorId string
actorIdentifier string
actorIsSuperAdmin boolean
targetAdminId string
targetEmail string
details Record<string, any>
ip string

AirtableOtpRequest

Field Type
subId string
status string

AppConfig

Field Type
minAndroidVersion string
minIosVersion string
androidStoreUrl string
iosStoreUrl string

Brand

Field Type
brandKey string
displayName string
domain string
aliases string[]
logoUrl string
format string
status BrandStatus
source BrandLogoSource
confidence number
attempts number
lastAttemptAt Date
nextRetryAt Date
manualLock boolean

BundleRun

Field Type
userId Types.ObjectId
trigger BundleRunTrigger
chargePolicy BundleRunChargePolicy
chargeType BundleRunChargeType
status BundleRunStatus
accountIdToPayWith string
paymentProcessId string
existingServicesSnapshot { name: string
existingMonthlyAmount number
claimedBy string
claimedAt Date
handledNote string
handledAt Date
handledBy string
customerOutcomeEmailedAt Date
isSplitPayment boolean
splitSecondPartStartDate Date

BundleRunItem

Field Type
runId Types.ObjectId
userSubscriptionId Types.ObjectId
serviceName string
fulfillmentMode FulfillmentMode
engine AutomationEngine
status BundleRunItemStatus
failureReason string
customerFacingReason string
paymentStatus BundleRunItemPaymentStatus
chargeType BundleRunChargeType
credsStatus BundleRunItemCredsStatus
customerProvidedOtp string
amountSnapshot number
bucket number
vcStableId string
liveUrl string
screenshotUrl string
attempts number
lastAttemptAt Date
history BundleRunItemHistoryEntry[]

BundleRunSetting

Field Type
key string
autoChargeOnFulfillment boolean

BundulSummary

Field Type
userId string
monthlyLoad number
paymentCount number
vulnerabilityWindow number
daysInMonth number
empathyText string
previousEmpathyTexts string[]
computedAt Date
hasInvalidConnections boolean

BundulSupportedSubscription

Field Type
name string
description string
logoUrl string
websiteUrl string
isActive boolean
type SubscriptionType
paymentMethod ServicePaymentMethod
billingClass `'arrears'
requiresManualAutomation boolean
credentialRequirements CredentialRequirement[]
invoiceDetection UtilityInvoiceDetection

CardEvent

Field Type
eventId string
amount number
virtualCardTransactionId string
status string
payload Record<string, any>

CredentialRevealAudit

Field Type
adminUsername string
runItemId Types.ObjectId
userSubscriptionId Types.ObjectId
fieldsRevealed string[]
revealedAt Date
ip string

CronLock

Field Type
key string
expiresAt Date
holder string

CustomerCashLedger

Field Type
userId Types.ObjectId
passportLedgerEntryId string
passportAccountId number
passportScheduleId string
billingPeriod string
entryDate Date
syncedAt Date
category CashLedgerCategory
direction `'credit'
amount number
passportStatus string
method string
subscriptionId Types.ObjectId
subscriptionName string
subscriptionBreakdown SubscriptionBreakdownItem[]
trueUpRecordId Types.ObjectId
trueUpQuarter string
passportRawEntry Record<string, any>

CustomerUtility

Field Type
customerId string
utilitySubId string
utilityService string
vcSid string
emailAccessId string
status string
lastDueDate Date
lastAmountDue number
nextDueDate Date
nextAmountDue number
invoiceLastFetched Date
paymentInitiated boolean
paymentInitiatedAt Date
paymentSettledAt Date
passportTransactionId string
additionalDetails string
isBunduled boolean
paymentDetails string
airtableRecordId string

DiscountCode

Field Type
id string
code string
stripeCode string
type DiscountType
value number
description string
isActive boolean
startDate Date
endDate Date
usageLimit number
usageCount number
applicableUserIds User[]
isSingleUsePerCustomer boolean
createdAt Date
updatedAt Date

Doc

Field Type
slug string
title string
section string
origin DocOrigin
body string
updatedBy string
sourceCommit string
owner string
lastReviewed string
revisions DocRevision[]
pending DocRevision
archived boolean

Feedback

Field Type
userId string
feedbackType FeedbackType
feedback string
suggestions string
customerId string
email string
airtableRecordId string

InstitutionInfo

Field Type
user Types.ObjectId
accessToken string
institution_id string
name string
logo string

JoinBeta

Field Type
firstName string
lastName string
email string
interest Interest[]

MoneyMovement

Field Type
eventKey string
source MovementSource
sourceId string
occurredAt Date
direction MovementDirection
amount number
status MovementStatus
rawStatus string
method string
category string
entityType MovementEntityType
userId Types.ObjectId
customerEmail string
customerName string
entityLabel string
subscriptionId string
subscriptionName string
trueUpRecordId string
passportTransactionId string
billingPeriod string
syncedAt Date

NotificationLog

Field Type
automationKey string
channel string
trigger string
recipients string[]
subject string
status string
relatedEntityId string
error string
meta Record<string, any>

PassportPaymentRecord

Field Type
transactionId string
externalId string
userId Types.ObjectId
type string
status string
amount number
accountId string
paymentProcessId string
retryCount number

PendingConnection

Field Type
userId Types.ObjectId
userBundulSupportedSubId Types.ObjectId
sessionId string
profileId string
liveUrl string
expiresAt Date

PlaidToken

Field Type
userId Types.ObjectId
accessTokenDetails AccessTokenDetails[]
processorToken string
lastSynced Date

PlatformPromotion

Field Type
name string
description string
status string
durationMonths number
startsAt Date
endsAt Date
createdBy string
notes string

Pricing

Field Type
bundulFee number
splitPaymentFee number
discount number
splitConversionCutoffDays number
splitConversionMinCycles number
updatedBy string

ProcessedLogo

Field Type
serviceName string
domain string
originalLogoUrl string
cdnUrl string
format string
s3Key string

Promotion

Field Type
name string
description string
rewardType RewardType
rewardAmount number
referrerClass UserClass
referredClass UserClass
referrerSplitPercentage number
referredSplitPercentage number
startDate Date
endDate Date
maxBeneficiaries number
currentBeneficiaries number
status PromotionStatus
excludedUserIds string[]
isActive boolean

PromotionReward

Field Type
promotion Promotion
referrerUser User
referredUser User
referralCode string
referrerRewardAmount number
referredRewardAmount number
referrerStatus RewardStatus
referredStatus RewardStatus
referrerRewardProcessedAt Date
referredRewardProcessedAt Date
referrerRewardTransactionId string
referredRewardTransactionId string

PushNotificationLog

Field Type
actorId string
actorIdentifier string
audienceKind string
audienceGroup string
category string
templateId string
serviceName string
targetUser string
title string
message string
deeplinkUrl string
recipientCount number
sentCount number
skippedNoServiceCount number
failedCount number

ReferralCode

Field Type
code string
userId string
promotion Promotion
isActive boolean
usageCount number
successfulSubs number
shareCount number
maxUsage number
expiresAt Date
usedBy ReferralUsage[]
description string

RefreshToken

Field Type
userId string
tokenHash string
familyId string
expiresAt Date
revokedAt Date
replacedByHash string
lastUsedAt Date
deviceId string
userAgent string

RepricingEvaluation

Field Type
utilitySubId string
userId Types.ObjectId
provider string
lastEvaluatedAt Date
lastCheckedAt Date
lastOutcome EvaluationOutcome
lastMonthsOfHistory number
lastGapPercent number
lastReason string

SupportTicket

Field Type
userId string
customerId string
email string
ticketNo string
issueTitle string
description string
reviewFeedback string
resolved boolean
updatedCustomer string
airtableRecordId string

TransactionCursor

Field Type
userId string
itemId string
cursor string
accessToken string

TrueUpRecord

Field Type
userId Types.ObjectId
quarter string
startDate Date
endDate Date
monthlyBreakdown TrueUpMonthBreakdown[]
totalPaid number
totalSpent number
delta number
direction TrueUpDirection
status TrueUpStatus
isManuallyEdited boolean
editedBy string
noExternalAccount boolean
approvalToken string
approvalTokenExpiresAt Date
scheduledFor Date
approvedAt Date
approvedBy string
declinedAt Date
declinedReason string
executedAt Date
passportTransactionId string
sweepTransactionId string
collectedAt Date
settledAt Date
passportStatus string
sweepStatus string
passportSyncedAt Date
airtableRecordId string

User

Field Type
firstName string
lastName string
email string
phone string
password string
discountCode string
isReferredFromMetaAd boolean
metaAdDetails StripeMandateData
profilePicture string
isActive boolean
isDeleted boolean
isSignedInWithGoogle boolean
verificationCode string
resetPasswordCode string
resetPasswordExpiresAt Date
userJoinedAt Date
codeReferredWith string
role Role
permissions string[]
adminStatus AdminStatus
invitedBy string
adminInviteTokenHash string
adminInviteExpiresAt Date
passwordSetAt Date
stripeMandateData StripeMandateData
passportAccountDetails PassportAccountDetails
pushNotificationToken string
hasSentNoSubscriptionsEmail boolean
hasLinkedEmailForMailParser boolean
oneSubDueDate Date
oneSubDueDateCategory OneSubDueDateCategory
selectedDueDateForWithdrawalOfExceess Date
hasUsedFreeMonth boolean
deactivationOTP string
deactivationOTPExpiresAt Date
deactivationRequestedAt Date
deactivationStatus `'pending'
deactivationRequestHistory Array<{
subscriptionsVersion number
plaidAccountsVersion number

UserBundulSupportedSubscription

Field Type
bundulSupportedSubscription Types.ObjectId
description string
price number
isActive boolean
user string
streamId string

UserEmailMailAccess

Field Type
userId string
email string
provider `'gmail'
accessToken string
refreshToken string
accessExpiresAt Date
accessTokenExpiresAt Date
requiresPeriodicReview boolean
lastReviewDate Date
tokenReminderSentAt Date
requiresReconnect boolean
reauthRequiredAt Date
imapHost string
imapPort number
imapSecure boolean
imapUser string
imapPassword string

UserPassportSubscription

Field Type
userId string
oneTimeChargeId `string
passportRecurringChargeId string
passportRecurringChargeStartDate Date
passportRecurringChargeNextDueDate Date
passportRecurringFeesChargeId `string
status string
amount number
isSplitPayment boolean
splitPaymentPart `number
subscriptions SubscriptionInfo[]
needsBundulFeeUpdate boolean
hasVcTemporaryFix boolean
originalRecurringAmount number
oneSubStartedAt Date
convertedFromSubId Types.ObjectId
splitGeneration number
fullRecurringAmount number
bundulFeeChargePending boolean
pendingBundulFeeAmount number
pendingBundulFeeStartDate string
isCancelled boolean
cancelledAt Date
cancelledRecurringChargeId string
cancelledBundulFeeChargeId string
servicesTotal number
bundulFee number
splitFee number
feeState string
feeStartsAt Date
history OneSubHistoryEntry[]
paymentStatus string
collectionFailureCount number
lastCollectionFailureAt Date
lastCollectionFailureReason string
lastCollectionFailureTransactionId string
lastCollectionFailureClass string
disbursementPaused boolean
disbursementPausedAt Date

UserPlaidRecurringTransactions

Field Type
user Types.ObjectId
account_id string
stream_id string
category_id string
merchant_name string
transaction_ids string[]
personal_finance_category Category
average_amount Amount
last_amount Amount
description string
status string
frequency string
is_active boolean
is_user_modified boolean
last_user_modified_datetime string
first_date string
last_date string
predicted_next_date string
accessToken string
itemId string

UserPlaidTransactions

Field Type
user Types.ObjectId
account_id string
transaction_id string
item_id string
amount number
date string
name string
merchant_name string
personal_finance_category Record<string, any>
accessToken string
cursor string

UserSubscription

Field Type
userBundulSupportedSubId Types.ObjectId
username string
password string
account_number string
zip_code string
phone_number string
customer_id string
email string
emailAccessId string
user Types.ObjectId
status `'pending'
automationError string
actionPerformed string
accountIdToPayWith string
bundul_type string
otp string
otpRequired boolean
hasBeenBunduled boolean
hasInvoice `boolean
invoiceStatus `
servicePaymentMethod ServicePaymentMethod
vcStableId string
achPaymentDetails AchPaymentDetails
browserUseProfileId string
aiLoginSessionId string
loginOtpHint string
loginOtpDeliveryMethod `'email'
loginOtpAttempts number
loginError string
loginLastAttemptAt Date
lastValidatedAt Date
cardSwapStatus `'completed'
lastCardSwapAt Date
previousCard { last4: string
newCard { last4: string
lastCardSwapLiveUrl string
lastCardSwapScreenshotUrl string
puppeteerCookies Array<Record<string, any>>
puppeteerOtpUrl string

UtilityBill

Field Type
userId Types.ObjectId
utilitySubId string
provider string
source BillSource
billMonth string
statementDate Date
dueDate Date
amountTotal number
serviceStart Date
serviceEnd Date
periodDays number
amountCurrentCharges number
priorBalance number
lateFees number
usageValue number
usageUnit string
isBudgetBilling boolean
priorYearUsageValue number
priorYearAmount number
sourceEmailId string
sourceTransactionId string
extractionModel string
extractionConfidence number
rawParsed Record<string, any>
firstSeenAt Date

UtilityBillInsight

Field Type
userId Types.ObjectId
utilitySubId string
utilityBillId Types.ObjectId
provider string
billAmount number
billMonth string
basis ComparisonBasis
confidence Confidence
expected `number
bandLow `number
bandHigh `number
deltaAmount `number
deltaPercent `number
explanations string[]
quarter QuarterPosition
billLineId BillLineId
quarterLineId QuarterLineId
title string
body string
sent boolean
sentAt Date
notSentReason string
isBacktest boolean

UtilityInsightSetting

Field Type
key string
sendEnabled boolean
allowlist string[]
thresholds {
copyOverrides Record<string, string>
updatedBy string
lastChangeNote string

UtilityPriceChange

Field Type
userId Types.ObjectId
utilitySubId string
userBundulSupportedSubId string
provider string
status PriceChangeStatus
currentPrice number
recommendedPrice number
targetPrice number
gapAmount number
gapPercent number
direction `'increase'
monthsOfHistory number
wasCapped boolean
reason string
basisBills Array<{ billMonth: string
decidedBy string
decidedAt Date
declineReason string
effectiveFrom Date
customerNotifiedAt Date
appliedAt Date
oneSubAmountBefore number
oneSubAmountAfter number
error string

UtilityRefreshRun

Field Type
status string
trigger string
triggeredBy string
onlyStale boolean
startedAt Date
lastHeartbeatAt Date
finishedAt Date
total number
processed number
succeeded number
failed number
error string

VirtualCard

Field Type
userId Types.ObjectId
subscriptionId Types.ObjectId
serviceName string
vcStableId string
cpxSupplierId string
cpxSupplierSid string
cpxCardIdForDetails string
cpxVcnReference string
cpxAccountId string
status string
cpxCardTid string
lastKnownBalance number
balanceUpdatedAt Date

VirtualCardLedgerEntry

Field Type
userId Types.ObjectId
virtualCardId Types.ObjectId
subscriptionId Types.ObjectId
serviceName string
entryType VirtualCardLedgerEntryType
amount number
referenceType string
referenceId string
cpxPaymentId string
cpxTransactionId string
metadata Record<string, any>
occurredAt Date

AccessTokenDetails (embedded)

Field Type
accessToken string
accounts LinkAccount[]
institution LinkInstitution
isAccessTokenValid boolean
userId Types.ObjectId
accessTokenDetails AccessTokenDetails[]
processorToken string
lastSynced Date

AchPaymentDetails (embedded)

Field Type
passportAccountId string
registeredAt Date
status `'active'
userBundulSupportedSubId Types.ObjectId
username string
password string
account_number string
zip_code string
phone_number string
customer_id string
email string
emailAccessId string
user Types.ObjectId
status `'pending'
automationError string
actionPerformed string
accountIdToPayWith string
bundul_type string
otp string
otpRequired boolean
hasBeenBunduled boolean
hasInvoice `boolean
invoiceStatus `
servicePaymentMethod ServicePaymentMethod
vcStableId string
achPaymentDetails AchPaymentDetails
browserUseProfileId string
aiLoginSessionId string
loginOtpHint string
loginOtpDeliveryMethod `'email'
loginOtpAttempts number
loginError string
loginLastAttemptAt Date
lastValidatedAt Date
cardSwapStatus `'completed'
lastCardSwapAt Date
previousCard { last4: string
newCard { last4: string
lastCardSwapLiveUrl string
lastCardSwapScreenshotUrl string

Amount (embedded)

Field Type
amount number
user Types.ObjectId
account_id string
stream_id string
category_id string
merchant_name string
transaction_ids string[]
personal_finance_category Category
average_amount Amount
last_amount Amount
description string
status string
frequency string
is_active boolean
is_user_modified boolean
last_user_modified_datetime string
first_date string
last_date string
predicted_next_date string
accessToken string
itemId string

BundleRunChargePolicy (embedded)

Field Type
autoChargeOnFulfillment boolean
userId Types.ObjectId
trigger BundleRunTrigger
chargePolicy BundleRunChargePolicy
chargeType BundleRunChargeType
status BundleRunStatus
accountIdToPayWith string
paymentProcessId string
existingServicesSnapshot { name: string
existingMonthlyAmount number
claimedBy string
claimedAt Date
handledNote string
handledAt Date
handledBy string
customerOutcomeEmailedAt Date
isSplitPayment boolean
splitSecondPartStartDate Date

BundleRunItemHistoryEntry (embedded)

Field Type
status string
at Date
note string
runId Types.ObjectId
userSubscriptionId Types.ObjectId
serviceName string
fulfillmentMode FulfillmentMode
engine AutomationEngine
status BundleRunItemStatus
failureReason string
customerFacingReason string
paymentStatus BundleRunItemPaymentStatus
chargeType BundleRunChargeType
credsStatus BundleRunItemCredsStatus
customerProvidedOtp string
amountSnapshot number
bucket number
vcStableId string
liveUrl string
screenshotUrl string
attempts number
lastAttemptAt Date
history BundleRunItemHistoryEntry[]

Business (embedded)

Field Type
businessName string
email string
password string
taxId string
phone string
addressStreet string
addressCity string
addressState string
addressCountry string
addressZip string
isVerified boolean
verificationToken `string
resetPasswordToken `string
resetPasswordExpires `Date
activationCode `string
apiToken `string
apiTokenExpiresAt `Date
apiTokenEnabled boolean
lastApiTokenGeneratedAt Date

Category (embedded)

Field Type
confidence_level string
detailed string
primary string
amount number
user Types.ObjectId
account_id string
stream_id string
category_id string
merchant_name string
transaction_ids string[]
personal_finance_category Category
average_amount Amount
last_amount Amount
description string
status string
frequency string
is_active boolean
is_user_modified boolean
last_user_modified_datetime string
first_date string
last_date string
predicted_next_date string
accessToken string
itemId string

CredentialRequirement (embedded)

Field Type
fields CredentialFieldKey[]
senderDomain string
subjectMarker string
senderName string
additionalFilter string
merchantMarkers string[]
name string
description string
logoUrl string
websiteUrl string
isActive boolean
type SubscriptionType
paymentMethod ServicePaymentMethod
billingClass `'arrears'
requiresManualAutomation boolean
credentialRequirements CredentialRequirement[]
invoiceDetection UtilityInvoiceDetection

DocRevision (embedded)

Field Type
body string
title string
updatedBy string
updatedAt Date
reason string
slug string
title string
section string
origin DocOrigin
body string
updatedBy string
sourceCommit string
owner string
lastReviewed string
revisions DocRevision[]
pending DocRevision
archived boolean

OneSubHistoryEntry (embedded)

Field Type
at Date
type string
servicesDelta number
feeApplied number
chargeAmountAfter number
reason string
chargeId string
userId string
oneTimeChargeId `string
passportRecurringChargeId string
passportRecurringChargeStartDate Date
passportRecurringChargeNextDueDate Date
passportRecurringFeesChargeId `string
status string
amount number
isSplitPayment boolean
splitPaymentPart `number
subscriptions SubscriptionInfo[]
needsBundulFeeUpdate boolean
hasVcTemporaryFix boolean
originalRecurringAmount number
oneSubStartedAt Date
convertedFromSubId Types.ObjectId
splitGeneration number
fullRecurringAmount number
bundulFeeChargePending boolean
pendingBundulFeeAmount number
pendingBundulFeeStartDate string
isCancelled boolean
cancelledAt Date
cancelledRecurringChargeId string
cancelledBundulFeeChargeId string
servicesTotal number
bundulFee number
splitFee number
feeState string
feeStartsAt Date
history OneSubHistoryEntry[]
paymentStatus string
collectionFailureCount number

QuarterPosition (embedded)

Field Type
quarter string
paidToDate number
spentToDate number
deltaToDate number
monthsRemaining number
projectedDelta `number
canProject boolean
userId Types.ObjectId
utilitySubId string
utilityBillId Types.ObjectId
provider string
billAmount number
billMonth string
basis ComparisonBasis
confidence Confidence
expected `number
bandLow `number
bandHigh `number
deltaAmount `number
deltaPercent `number
explanations string[]
quarter QuarterPosition
billLineId BillLineId
quarterLineId QuarterLineId
title string
body string
sent boolean
sentAt Date
notSentReason string
isBacktest boolean

StripeMandateData (embedded)

Field Type
ip_address string
user_agent string
firstName string
lastName string
email string
phone string
password string
discountCode string
isReferredFromMetaAd boolean
metaAdDetails StripeMandateData
profilePicture string
isActive boolean
isDeleted boolean
isSignedInWithGoogle boolean
verificationCode string
resetPasswordCode string
resetPasswordExpiresAt Date
userJoinedAt Date
codeReferredWith string
role Role
permissions string[]
adminStatus AdminStatus
invitedBy string
adminInviteTokenHash string
adminInviteExpiresAt Date
passwordSetAt Date
stripeMandateData StripeMandateData
passportAccountDetails PassportAccountDetails
pushNotificationToken string
hasSentNoSubscriptionsEmail boolean
hasLinkedEmailForMailParser boolean
oneSubDueDate Date
oneSubDueDateCategory OneSubDueDateCategory
selectedDueDateForWithdrawalOfExceess Date
hasUsedFreeMonth boolean
deactivationOTP string
deactivationOTPExpiresAt Date
deactivationRequestedAt Date
deactivationStatus `'pending'
deactivationRequestHistory Array<{

SubscriptionBreakdownItem (embedded)

Field Type
userId Types.ObjectId
passportLedgerEntryId string
passportAccountId number
passportScheduleId string
billingPeriod string
entryDate Date
syncedAt Date
category CashLedgerCategory
direction `'credit'
amount number
passportStatus string
method string
subscriptionId Types.ObjectId
subscriptionName string
subscriptionBreakdown SubscriptionBreakdownItem[]
trueUpRecordId Types.ObjectId
trueUpQuarter string
passportRawEntry Record<string, any>

SubscriptionInfo (embedded)

Field Type
subscriptionId string
subscriptionName string
subscriptionAmount number
subscriptionVCTransactionId string
nextDueDate Date
billingFrequency string
streamId string
at Date
type string
servicesDelta number
feeApplied number
chargeAmountAfter number
reason string
chargeId string
userId string
oneTimeChargeId `string
passportRecurringChargeId string
passportRecurringChargeStartDate Date
passportRecurringChargeNextDueDate Date
passportRecurringFeesChargeId `string
status string
amount number
isSplitPayment boolean
splitPaymentPart `number
subscriptions SubscriptionInfo[]
needsBundulFeeUpdate boolean
hasVcTemporaryFix boolean
originalRecurringAmount number
oneSubStartedAt Date
convertedFromSubId Types.ObjectId
splitGeneration number
fullRecurringAmount number
bundulFeeChargePending boolean
pendingBundulFeeAmount number
pendingBundulFeeStartDate string
isCancelled boolean
cancelledAt Date
cancelledRecurringChargeId string
cancelledBundulFeeChargeId string
servicesTotal number

UtilityInvoiceDetection (embedded)

Field Type
senderDomain string
subjectMarker string
senderName string
additionalFilter string
merchantMarkers string[]
name string
description string
logoUrl string
websiteUrl string
isActive boolean
type SubscriptionType
paymentMethod ServicePaymentMethod
billingClass `'arrears'
requiresManualAutomation boolean
credentialRequirements CredentialRequirement[]
invoiceDetection UtilityInvoiceDetection

This page is written by the build from the code, so there is nothing to edit here. If it is wrong, the generator is wrong.