PwsBillingCycleRef

Overview


This structure represents the unique key fields associated with identifying a billing cycle. Billing Cycles are used to determine when and how often clients should be invoiced. Each client and engagement can be assigned a billing cycle, and users can choose to create invoices only for engagements with a particular billing cycle. Billing cycles can be identified by BillingCycleName or BillingCycleUid. When specifying a PwsBillingCycleRef as an input to a web service, you may specify one or both the BillingCycleName and/or BillingCycleUid. However, if you do specify both, they must both refer to the same billing cycle or the billing cycle reference will not be considered valid. When a PwsBillingCycleRef is returned in the response to a web service, both the BillingCycleName and BillingCycleUid will be populated, and guaranteed to refer to a single billing cycle.

Format


PwsBillingCycleRef
  • PwsBillingCycleRef
    • BillingCycleId: Int32
    • BillingCycleName: String (50)
    • BillingCycleUid: Int64

Elements


Element

Data Type

Required?

Description

Sample Data

BillingCycleId

Int32

No

The billing cycle Id is a unique identifier for a billing cycle. For internal use only.


BillingCycleName

String (50)

One of BillingCycleName or BillingCycleUid is required


The billing cycle name is a unique identifier for a billing cycle

Monthly

BillingCycleUid

Int64

See BillingCycleName


The billing cycle Uid is a unique and immutable identifier for a billing cycle

1152921504606853180


Usage Example(s)


Example 01
                     <b:BillingCycleIdentity>
                        <b:BillingCycleId i:nil="true"/>
                        <b:BillingCycleName>Monthly</b:BillingCycleName>
                        <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                     </b:BillingCycleIdentity>