ClientBillingScheduleItemDto

One planned charge on a client's billing schedule. Amounts are the effective values: the pinned
value where a user set one, otherwise the rule's current price and quantity.

Properties

Name	Type	Description
code	string	The unique code for this schedule item
The unique code for this schedule item
client	CodeAndNameDto
clientBillableService	CodeAndNameDto
servicePackage	CodeAndNameDto
kind	enum	Recurring SetupFee CatchUp AdHoc
Recurring SetupFee CatchUp AdHoc
periodStart	string	Start of the service period covered
Start of the service period covered
periodEnd	string	End of the service period covered
End of the service period covered
billingDate	string	Planned invoice date, already snapped to the client's invoice day
Planned invoice date, already snapped to the client's invoice day
quantity	number	The quantity this occurrence will bill (pinned, or the rule's current line quantity)
The quantity this occurrence will bill (pinned, or the rule's current line quantity)
unitPrice	number	The unit price this occurrence will bill at (pinned, or the rule's current effective price)
The unit price this occurrence will bill at (pinned, or the rule's current effective price)
amount	number	Quantity × unit price
Quantity × unit price
description	string	The description the invoice line will carry: the pinned description where one was set, otherwise the one derived from the rule's template, resolved as of the billing date
The description the invoice line will carry: the pinned description where one was set, otherwise the one derived from the rule's template, resolved as of the billing date
isOverridden	boolean	A user pinned the description, quantity or unit price on this occurrence, so it no longer follows the service's billing rule for them
A user pinned the description, quantity or unit price on this occurrence, so it no longer follows the service's billing rule for them
status	enum	Scheduled Billed Skipped
Scheduled Billed Skipped
displayStatus	enum	Scheduled Overdue Pending Approved Invoiced Cancelled Skipped
Scheduled Overdue Pending Approved Invoiced Cancelled Skipped
billingLineItemCode	string	The billing line created from this occurrence, once Billed
The billing line created from this occurrence, once Billed
isEdited	boolean	A user changed the date, amount or description of this occurrence
A user changed the date, amount or description of this occurrence
createdDate	string	When the item was created
When the item was created
updatedDate	string	When the item was last updated
When the item was last updated

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "clientBillableService": {
    "code": "string",
    "name": "string"
  },
  "servicePackage": {
    "code": "string",
    "name": "string"
  },
  "kind": "Recurring"
}

Used By Operations

Contained in Schemas

ClientBillingScheduleItemDtoPagedResult