Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. Invoices 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


Panel
titlePwsBillingCycleRef
  • PwsBillingCycleRef
    • BillingCycleId: Int32
    • BillingCycleName: String
    • BillingCycleUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

BillingCycleId

Int32


Billing Cycle ID. For internal use only.


6204

BillingCycleName

String


Billing Cycle Name


Monthly

BillingCycleUid

Int64


Billing Cycle Uid, a unique and immutable identifier for a Billing Cycle


1152921504606853180

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                    <PwsBillingCycleRef>  
                      <BillingCycleId>6204</BillingCycleId>
                      <BillingCycleName>Monthly</BillingCycleName>
                      <BillingCycleUid>1152921504606853180</BillingCycleUid>
                    </PwsBillingCycleRef>