Award interface
Award details for milestone completion
Properties
| balance |
Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. |
| credit | Credit amount to be awarded |
| duration | Duration for which the benefit is active. Will be in format P{int}M or P{int}Y. Any values representing up to 12 years are valid. Upper limit examples: P144M, P12Y. |
| end |
End date when the credit expires |
| resource |
Resource ID for the awarded credit. |
| start |
Start date when the credit becomes effective |
| system |
This is the globally unique identifier of the credit which will not change for its lifetime. |
Property Details
balanceVersion
Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created.
balanceVersion?: number
Property Value
number
credit
duration
Duration for which the benefit is active. Will be in format P{int}M or P{int}Y. Any values representing up to 12 years are valid. Upper limit examples: P144M, P12Y.
duration?: string
Property Value
string
endAt
End date when the credit expires
endAt?: Date
Property Value
Date
resourceId
Resource ID for the awarded credit.
resourceId?: string
Property Value
string
startAt
Start date when the credit becomes effective
startAt?: Date
Property Value
Date
systemId
This is the globally unique identifier of the credit which will not change for its lifetime.
systemId?: string
Property Value
string