Magidoc

FinanceRecurringSchedule
Object

Fields

#

_id

ID !
Non-null

workspaceId

ID !
Non-null

glCompanyId

ID

The GL company whose books the generated documents belong to. Null until companies exist.

documentType

FinanceRecurringDocumentType !
Non-null

billingAgreementId

ID

Agreement that owns this internal executor. Null for a user-authored schedule.

billingAgreementVersion

Int

name

String !
Non-null

recurrence

RecurrenceDefinitionBase !
Non-null

nextOccurrence

Date

The next occurrence owed, advanced forward-only. Null once the recurrence has no future left.

remainingCount

Int

Occurrences left to generate; null runs until someone stops it.

createAsApproved

Boolean !
Non-null

Post the generated document instead of leaving it a draft for someone to approve.

template

FinanceRecurringScheduleTemplate !
Non-null

active

Boolean !
Non-null

lastGeneratedAt

Date

lastGeneratedDocumentId

ID

lastError

String

Why the last occurrence could not be generated — a closed period reads here, and is retried.

lastErrorAt

Date

closeReason

String

Why the schedule stopped on its own, so a finished schedule does not read as an abandoned one.

createdAt

Date !
Non-null

createdBy

ID !
Non-null

modifiedAt

Date !
Non-null

modifiedBy

ID !
Non-null

Usages

#

References

#

  • Field getFinanceRecurringSchedules from Query
  • Field createFinanceRecurringSchedule from Mutation
  • Field updateFinanceRecurringSchedule from Mutation