Magidoc

AgreedBillingRule
Object

How an agreed line's money gets asked for — the writer's side of the rule the invoice generator already refuses a line for lacking.

One tagged shape rather than four, because GraphQL has no input unions and the stored type is a union: kind says which fields answer, and the server refuses a rule whose fields do not match the kind it declares. advanceDrawdown is a member of BillingRuleKind and NOT a rule any proposal can state — an advance bill is its own agreement — so stating it here is refused.

Fields

#

kind

BillingRuleKind !
Non-null

instalments

[AgreedBillingInstalment !]

Answers when kind is fixedSchedule.

milestones

[AgreedBillingMilestone !]

Answers when kind is milestones.

amount

MoneyValue

Answers when kind is retainer: the amount asked for each period.

cadence

RecurrenceDefinitionBase

How often we ask. Answers when kind is timeAndMaterials or retainer.

drawdown

AgreedRetainerDrawdown

Answers when kind is retainer.

rolloverUnused

Boolean

Answers when kind is retainer.

billableCategoryIds

[ID !]

Absent means every category is billable; present means only these are.

capAmount

MoneyValue

The agreed ceiling, or null for none. Answers when kind is timeAndMaterials.

capBehavior

BillingCapBehavior

Answers when kind is timeAndMaterials.

progressBasis

AgreedProgressBasis

Removed; always null.

budgetHours

Float

Removed; always null.

Usages

#

References

#