Versions Compared

Key

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

...

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

...

Element

Data Type

Required?Default

Description

Sample Data

BillingCycleId

Int32

On Update: No

On Insert: No

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


BillingCycleName

String (50)

On Update: Yes (if BillingCycleUid is not supplied)

On Insert: Yes (if BillingCycleUid is not supplied)

One of BillingCycleName or BillingCycleUid is required


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

Monthly

BillingCycleUid

Int64

On Update: Yes (if BillingCycleName is not supplied)

On Insert: Yes (if BillingCycleName is not supplied) 

See BillingCycleName


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

1152921504606853180


Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <b:BillingCycleIdentity>
<PwsBillingCycleRef>                         <BillingCycleId>6204</BillingCycleId><b:BillingCycleId i:nil="true"/>
                        <BillingCycleName>Monthly<<b:BillingCycleName>Monthly</b:BillingCycleName>
                      <BillingCycleUid>1152921504606853180</BillingCycleUid>  <b:BillingCycleUid>1152921504606853180</b:BillingCycleUid>
                     </PwsBillingCycleRef>b:BillingCycleIdentity>