In this article

XML Format: Billing Schedule Data

Billing schedule information can be exported and then imported from the SBS ARCB Billing Schedule List page in the XML formats using the following actions: 

  • Billing schedule
  • Billing schedule price adjustment
  • Billing schedule usage items (import only)
  • Revenue Split Template (added from version 41.2 onwards)

General Workflow

To create or update billing schedule information, follow these general steps: 

  1. On the SBS ARCB Billing Schedule List, select the export action you want (Export > XML > Export).

    You can save the file to the default download location.

  2. Open the file in a text editor, and make changes as needed.
  3. Back on the SBS ARCB Billing Schedule List, select the import action for the same data type you exported (Import > XML > Import).
  4. When updating data, prompts asking whether you want to roll down the start and end dates, the frequency, and the interval, appear. Select Yes or No to the prompts.

The following tables provide information on the file formats for importing data. Every field is required to appear on the import file. However, not every field requires a value. In other words, the field column must appear in the file, but the value for the field in a row can be empty.

Tip: If you do not have a sample template and to ensure you have the latest format, execute the export action to save a file with the correct formatting.

Notes:

The following items provide information with respect to importing data: 

  • The header and line records can be combined into a single composite entity, which means it can be included in a single file. However, only XML files can be used with composite entities.
  • If a stubbing cutoff date exists, and the schedule details lines have a billing start date that is earlier than or the same as the stubbing cutoff date, the line is stubbed.
  • Each entity record is processed independently of all other entity records. As a result, when an import error occurs, only the line that has the error is rolled back. All other lines that are successfully imported are not affected.

    • For composite entities, the header and line are considered a single entity. If an import error occurs with the line, the header is not imported.

  • When price adjustment data is imported, the price adjustment line number is automatically generated.
  • When importing data, the ScheduleNumber is required. Also, the ScheduleLineNum is required for a billing schedule line, but optional for composite. For more information about the file format for the data, review the sample import file.

Billing Schedule Header & Lines

Review the following table for the required content for importing data to the SBS ARCB Billing Schedule List page.

Select Copy to copy the sample to the clipboard.

Note icon. Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.

Copy

Billing Schedule Header XML sample

<?xml version="1.0" encoding="UTF-16"?>
<BSSISchedules>
    <HeaderInfo>
    <BillingScheduleNumber>SCH000000</BillingScheduleNumber>
    <SellToCustomerNo>10000</SellToCustomerNo>
    <EndUser/>
    <BillingStartDate>07/01/21</BillingStartDate>
    <BillingEndDate>06/30/22</BillingEndDate>
    <BillingFrequency> Monthly</BillingFrequency>
    <Interval>1</Interval>
    <AutoRenewal>No</AutoRenewal>
    <Description/>
    <NoticeDays>0</NoticeDays>
    <RenewInAdvance>0</RenewInAdvance>
    <CurrencyCode/>
    <LocationCode/>
    <SalepersonCode>JO</SalepersonCode>
    <ResponsibilityCenter/>
    <PaymentTermscode>1M(8D)</PaymentTermscode>
    <BillToCustomerNo>10000</BillToCustomerNo>
    <BillToName>Adatum Corporation</BillToName>
    <BillToAddress>192 Market Square</BillToAddress>
    <BillToAddress2/>
    <BillToCIty>Atlanta</BillToCIty>
    <ShipToCode/>
    <ShipToName>Adatum Corporation</ShipToName>
    <ShipToAddress>192 Market Square</ShipToAddress>
    <ShipToAddress2/>
    <ShipToCity>Atlanta</ShipToCity>
    <BssiArcbDetailInvAmt>1,386.40</BssiArcbDetailInvAmt>
    <BillToPostalcode>31772</BillToPostalcode>
    <BillToCountry>GA</BillToCountry>
    <ShipToPostalCode>31772</ShipToPostalCode>
    <ShipToCountry/>
    <SellToCustomerName>Adatum Corporation</SellToCustomerName>
    <SellToAddress>192 Market Square</SellToAddress>
    <SellToAddress2/>
    <SellToCity>Atlanta</SellToCity>
    <SellToContact>Robert Townes</SellToContact>
    <SellToPostalCode>31772</SellToPostalCode>
    <SellToCountry>GA</SellToCountry>
    <AlignToMonth>No</AlignToMonth>
    <ProratePartialPeriod>No</ProratePartialPeriod>
    <ShipmentMethodcode/>
    <PkgTrackingNO/>
    <ShippingAgentServiceCode/>
    <ShippingAgentCode/>
    <ShipToCountry>GA</ShipToCountry>
    <ShipToPostcode>31772</ShipToPostcode>
    <ShipTOCountry>US</ShipTOCountry>
    <ShipToContact>Robert Townes</ShipToContact>
    <SellToContactNo/>
    <SellToCountry>US</SellToCountry>
    <SellToCustomerName2/>
    <YourRef/>
    <ExternalDocNo/>
    <BillToContact>Robert Townes</BillToContact>
    <BillToContactNo/>
    <BillToCountry>US</BillToCountry>
    <InvoiceSearately>No</InvoiceSearately>
    <TaxLiable>No</TaxLiable>
    <TaxAreaCode>ATLANTA, GA</TaxAreaCode>
    <BillingScheduleGroup>DEFAULT</BillingScheduleGroup>
    <SeriesNo>ARCB</SeriesNo>
    <BssiEstimatedQty>0</BssiEstimatedQty>
    <BillingScheduleLineInfo>
            <LineNo>10000</LineNo>
            <Type>Item</Type>
            <ItemNo>1896-S</ItemNo>
            <Description>ATHENS Desk</Description>
            <BillingType>Standard</BillingType>
            <LocationCode/>
            <UnitMeasureCode>PCS</UnitMeasureCode>
            <Price>1,000.80</Price>
            <Qty>1</Qty>
            <Amount>1,000.80</Amount>
            <BillingFrequency> Monthly</BillingFrequency>
            <BillingStartDate>07/01/21</BillingStartDate>
            <BillingEndDate>06/30/22</BillingEndDate>
            <Interval>1</Interval>
            <TaxGroupCode>FURNITURE</TaxGroupCode>
            <TaxLiable>No</TaxLiable>
            <TaxAreadCode>ATLANTA, GA</TaxAreadCode>
            <AutoRenewed>No</AutoRenewed>
            <UsageOption>Reading</UsageOption>
            <PricingMethod>Standard</PricingMethod>
            <UsageIdentifier/>
            <InitialReading>0.00</InitialReading>
            <RenewalLines>1</RenewalLines>
            <StubbedDate/>
            <RevenueSplit>No</RevenueSplit>
            <ParentAmount>0.00</ParentAmount>
            <BssiEstimatedQty>0</BssiEstimatedQty>
            <BssiTransactionType>Sales Invoice</BssiTransactionType>
            <BssiBillToCustomerForLine>10000</BssiBillToCustomerForLine>
            <BssiBillToCustomerNameForLine>Adatum Corporation</BssiBillToCustomerNameForLine>
            <BssiBillToAddressForLine>192 Market Square</BssiBillToAddressForLine>
            <BssiBillToAddress2ForLine/>
            <BssiBillToCityForLine>Atlanta</BssiBillToCityForLine>
            <BssiBillToContactForLine>Robert Townes</BssiBillToContactForLine>
            <BssiBillToContactNoForLine/>
            <BssiBillToCountryForLine/>
            <BssiBillToCountyForLine>GA</BssiBillToCountyForLine>
            <BssiBillToPostalForLine>31772</BssiBillToPostalForLine>
            <BillingScheduleLinePriceOptions>
                <FreeQuantity>0.00</FreeQuantity>
                <FreeResetNumberofPeriods>1</FreeResetNumberofPeriods>
                <MinMaxType>By Amount</MinMaxType>
                <MinimumValue>0.00</MinimumValue>
                <MaximumValue>0.00</MaximumValue>
                <MinMaxResetNumberofPeriods>1</MinMaxResetNumberofPeriods>
            </BillingScheduleLinePriceOptions>
            <BssiAredTransLineDeferral>
                <TransactionType>Sales Invoice</TransactionType>
                <DeferrableItem>No</DeferrableItem>
                <TransactionDate/>
                <Qty>0.00</Qty>
                <DeferralAmount>0.00</DeferralAmount>
                <EventTemplateNo/>
                <EventPerUnit>No</EventPerUnit>
                <EventAllocationType>Equal Amounts</EventAllocationType>
                <ExpirationAccount/>
                <RevenueDeferralAccount/>
                <RevenueRecognitionAccount/>
                <COGSDeferralAccount/>
                <COGSRecongitionAccount/>
                <DiscountDeferralAccount/>
                <DiscountRecognitionAccount/>
                <ScheduleType>Straight Line</ScheduleType>
                <TemplateNo/>
                <ConsolidatePriorPeriods>No</ConsolidatePriorPeriods>
                <EqualPerPeriod>No</EqualPerPeriod>
                <OverrideStartDate>No</OverrideStartDate>
                <DeferralStartDate/>
                <DeferralEndDate/>
                <ScheduleFromTemplate>No</ScheduleFromTemplate>
            </BssiAredTransLineDeferral>
            <BillingScheduleMERALine>
                <MEANumber/>
                <SSPOrigin>Base Sales Price</SSPOrigin>
                <StandaloneSellingPrice>0.00</StandaloneSellingPrice>
                <DeferredContractRevenueAccount/>
            </BillingScheduleMERALine>
        </BillingScheduleLineInfo>
        <BillingScheduleLineInfo>
            <LineNo>20000</LineNo>
            <Type>Item</Type>
            <ItemNo>1900-S</ItemNo>
            <Description>PARIS Guest Chair, black</Description>
            <BillingType>Standard</BillingType>
            <LocationCode/>
            <UnitMeasureCode>PCS</UnitMeasureCode>
            <Price>192.80</Price>
            <Qty>1</Qty>
            <Amount>192.80</Amount>
            <BillingFrequency> Monthly</BillingFrequency>
            <BillingStartDate>07/01/21</BillingStartDate>
            <BillingEndDate>06/30/22</BillingEndDate>
            <Interval>1</Interval>
            <TaxGroupCode>FURNITURE</TaxGroupCode>
            <TaxLiable>No</TaxLiable>
            <TaxAreadCode>ATLANTA, GA</TaxAreadCode>
            <AutoRenewed>No</AutoRenewed>
            <UsageOption>Reading</UsageOption>
            <PricingMethod>Standard</PricingMethod>
            <UsageIdentifier/>
            <InitialReading>0.00</InitialReading>
            <RenewalLines>1</RenewalLines>
            <StubbedDate/>
            <RevenueSplit>No</RevenueSplit>
            <ParentAmount>0.00</ParentAmount>
            <BssiEstimatedQty>0</BssiEstimatedQty>
            <BssiTransactionType>Sales Invoice</BssiTransactionType>
            <BssiBillToCustomerForLine>10000</BssiBillToCustomerForLine>
            <BssiBillToCustomerNameForLine>Adatum Corporation</BssiBillToCustomerNameForLine>
            <BssiBillToAddressForLine>192 Market Square</BssiBillToAddressForLine>
            <BssiBillToAddress2ForLine/>
            <BssiBillToCityForLine>Atlanta</BssiBillToCityForLine>
            <BssiBillToContactForLine>Robert Townes</BssiBillToContactForLine>
            <BssiBillToContactNoForLine/>
            <BssiBillToCountryForLine/>
            <BssiBillToCountyForLine>GA</BssiBillToCountyForLine>
            <BssiBillToPostalForLine>31772</BssiBillToPostalForLine>
            <BillingScheduleLinePriceOptions>
                <FreeQuantity>0.00</FreeQuantity>
                <FreeResetNumberofPeriods>1</FreeResetNumberofPeriods>
                <MinMaxType>By Amount</MinMaxType>
                <MinimumValue>0.00</MinimumValue>
                <MaximumValue>0.00</MaximumValue>
                <MinMaxResetNumberofPeriods>1</MinMaxResetNumberofPeriods>
            </BillingScheduleLinePriceOptions>
            <BssiAredTransLineDeferral>
                <TransactionType>Sales Invoice</TransactionType>
                <DeferrableItem>No</DeferrableItem>
                <TransactionDate/>
                <Qty>0.00</Qty>
                <DeferralAmount>0.00</DeferralAmount>
                <EventTemplateNo/>
                <EventPerUnit>No</EventPerUnit>
                <EventAllocationType>Equal Amounts</EventAllocationType>
                <ExpirationAccount/>
                <RevenueDeferralAccount/>
                <RevenueRecognitionAccount/>
                <COGSDeferralAccount/>
                <COGSRecongitionAccount/>
                <DiscountDeferralAccount/>
                <DiscountRecognitionAccount/>
                <ScheduleType>Straight Line</ScheduleType>
                <TemplateNo/>
                <ConsolidatePriorPeriods>No</ConsolidatePriorPeriods>
                <EqualPerPeriod>No</EqualPerPeriod>
                <OverrideStartDate>No</OverrideStartDate>
                <DeferralStartDate/>
                <DeferralEndDate/>
                <ScheduleFromTemplate>No</ScheduleFromTemplate>
                </BssiAredTransLineDeferral>
            <BillingScheduleMERALine>
                <MEANumber/>
                <SSPOrigin>Base Sales Price</SSPOrigin>
                <StandaloneSellingPrice>0.00</StandaloneSellingPrice>
                <DeferredContractRevenueAccount/>
            </BillingScheduleMERALine>
        </BillingScheduleLineInfo>
        <BillingScheduleLineInfo>
            <LineNo>30000</LineNo>
            <Type>Item</Type>
            <ItemNo>1908-S</ItemNo>
            <Description>LONDON Swivel Chair, blue</Description>
            <BillingType>Standard</BillingType>
            <LocationCode/>
            <UnitMeasureCode>PCS</UnitMeasureCode>
            <Price>190.10</Price>
            <Qty>1</Qty>
            <Amount>190.10</Amount>
            <BillingFrequency> Monthly</BillingFrequency>
            <BillingStartDate>07/01/21</BillingStartDate>
            <BillingEndDate>06/30/22</BillingEndDate>
            <Interval>1</Interval>
            <TaxGroupCode>FURNITURE</TaxGroupCode>
            <TaxLiable>No</TaxLiable>
            <TaxAreadCode>ATLANTA, GA</TaxAreadCode>
            <AutoRenewed>No</AutoRenewed>
            <UsageOption>Reading</UsageOption>
            <PricingMethod>Standard</PricingMethod>
            <UsageIdentifier/>
            <InitialReading>0.00</InitialReading>
            <RenewalLines>1</RenewalLines>
            <StubbedDate/>
            <RevenueSplit>No</RevenueSplit>
            <ParentAmount>0.00</ParentAmount>
            <BssiEstimatedQty>0</BssiEstimatedQty>
            <BssiTransactionType>Sales Invoice</BssiTransactionType>
            <BssiBillToCustomerForLine>10000</BssiBillToCustomerForLine>
            <BssiBillToCustomerNameForLine>Adatum Corporation</BssiBillToCustomerNameForLine>
            <BssiBillToAddressForLine>192 Market Square</BssiBillToAddressForLine>
            <BssiBillToAddress2ForLine/>
            <BssiBillToCityForLine>Atlanta</BssiBillToCityForLine>
            <BssiBillToContactForLine>Robert Townes</BssiBillToContactForLine>
            <BssiBillToContactNoForLine/>
            <BssiBillToCountryForLine/>
            <BssiBillToCountyForLine>GA</BssiBillToCountyForLine>
            <BssiBillToPostalForLine>31772</BssiBillToPostalForLine>
            <BillingScheduleLinePriceOptions>
                <FreeQuantity>0.00</FreeQuantity>
                <FreeResetNumberofPeriods>1</FreeResetNumberofPeriods>
                <MinMaxType>By Amount</MinMaxType>
                <MinimumValue>0.00</MinimumValue>
                <MaximumValue>0.00</MaximumValue>
            <MinMaxResetNumberofPeriods>1</MinMaxResetNumberofPeriods>
        </BillingScheduleLinePriceOptions>
            <BssiAredTransLineDeferral>
                <TransactionType>Sales Invoice</TransactionType>
                <DeferrableItem>No</DeferrableItem>
                <TransactionDate/>
                <Qty>0.00</Qty>
                <DeferralAmount>0.00</DeferralAmount>
                <EventTemplateNo/>
                <EventPerUnit>No</EventPerUnit>
                <EventAllocationType>Equal Amounts</EventAllocationType>
                <ExpirationAccount/>
                <RevenueDeferralAccount/>
                <RevenueRecognitionAccount/>
                <COGSDeferralAccount/>
                <COGSRecongitionAccount/>
                <DiscountDeferralAccount/>
                <DiscountRecognitionAccount/>
                <ScheduleType>Straight Line</ScheduleType>
                <TemplateNo/>
                <ConsolidatePriorPeriods>No</ConsolidatePriorPeriods>
                <EqualPerPeriod>No</EqualPerPeriod>
                <OverrideStartDate>No</OverrideStartDate>
                <DeferralStartDate/>
                <DeferralEndDate/>
                <ScheduleFromTemplate>No</ScheduleFromTemplate>
                </BssiAredTransLineDeferral>
            <BillingScheduleMERALine>
                <MEANumber/>
                <SSPOrigin>Base Sales Price</SSPOrigin>
                <StandaloneSellingPrice>0.00</StandaloneSellingPrice>
                <DeferredContractRevenueAccount/>
                </BillingScheduleMERALine>
        </BillingScheduleLineInfo>
        <BillingScheduleMERAHeader>
            <MEAType>None</MEAType>
            <MEANumber/>
            <DeferredContractRevenueAccount/>
        </BillingScheduleMERAHeader>
    </HeaderInfo>
</BSSISchedules>

The following table shows the columns for the XML: 

  • Action: Import/Export > XML > Import or Export > Billing Schedule
Field Name Data Type Required Description
HeaderInfo
BillingScheduleNumber String Required  
SellToCustomerNo String Required  
EndUser String    
BillingEndDate Date Required  
BillingEndDate Date Required  
BillingFrequency String  

Options: 

  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
  • Weekly
  • Daily
  • Miscellaneous

When this value is empty, the value is from the specified billing schedule group.

Interval Integer   When this value is empty, the value is from the specified billing schedule group.
AutoRenewal Boolean   Yes/No
Description String    
NoticeDays Integer    
RenewInAdvance Integer    
CurrencyCode String    
LocationCode String    
SalespersonCode String    
ResponsibilityCenter String    
PaymentTermsCode String    
BillToCustomerNo. String    
BillToName String    
BillToAddress String    
BillToAddress2 String    
BillToCity String    
ShipToCode String    
ShipToName String    
ShipToAddress String    
ShipToAddress2 String    
ShipToCity String    
BssiArcbDetailInvAmt Integer    
BillToPostalCode String    
BillToCountry String    
ShipToPostalCode String    
ShipToCountry String    
SellToCustomerName String    
SellToAddress String    
SellToAddress 2 String    
SellToCity String    
SellToContact String    
SellToPostalCode String    
SellToCounty String    
AlignToMonth Boolean   Yes/No
ProratePartialPeriod Boolean   Yes/No
ShipmentMethodCode String    
PackageTrackingNO String    
ShippingAgentServiceCode String    
ShippingAgentCode String    
ShipToCounty String    
ShipToPostCode String    
ShipToCountry/Region String    
ShipToContact String    
SellToContactNo String  
SellToCountry String    
SellToCustomerName2 String    
YourRef String    
ExternalDocNo String    
BillToContact String    
BillToContactNo String    
Bill-to Country/Region Code    
BssiInvoiceSeparately Boolean   Yes/No
TaxLiable Boolean   Yes/No
TaxAreaCode String    
BillingScheduleGroup String    
SeriesNo String    
BssiEstimateQty Real    
BillingScheduleLineInfo
LineNo String Required  
Type String    
ItemNo String Required  
Description String    
BillingType String    
LocationCode String   Location Code
UnitMeasureCode String    
Price Real    
Qty Integer    
Amount Real    
BillingFrequency String  

Options: 

  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
  • Weekly
  • Daily
  • Miscellaneous
BillingStartDate Date    
BillingEndDate Date    
Interval Integer    
TaxGroupCode String    
TaxLiable Boolean    
TaxAreaCode String    
AutoRenewal Boolean    
UsageOption String    
PricingMethod String    
UsageIdentifier String    
InitialReading Integer    
RenewalLines Integer    
StubbedDate Date    
RevenueSplit Enum   Yes/No
ParentAmount Real    
BssiEstimateQty Integer   Estimated usage quantity
BssiTransactionType String    
BssiBillToCustomerForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToCustomerNameForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToAddressForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToAddress2ForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToCityForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToContactForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToContactNoForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToCountryForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToCountyForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BssiBillToPostalForLine String Required

If this value is empty, an error occurs when an invoice is created.

Instead of leaving this value empty, use the sell-to customer details.

BillingScheduleLinePriceOptions
FreeQuantity Number    
FreeResetNumberofPeriods Number    
MinMaxType String    
MinimumValue Number    
MaximumValue Number    
MinMaxResetNumberofPeriods Number    
BssiAredTransLineDeferral      
TransactionType String    
DeferrableItem Enum   Yes/No
TransactionDate Date    
Qty Number    
DeferralAmount Number    
EventTemplateNo String    
EventPerUnit Enum   Yes/No
EventAllocationType String    
ExpirationAccount String    
RevenueDeferralAccount String    
RevenueRecognitionAccount String    
COGSDeferralAccount String    
COGSRecongitionAccount String    
DiscountDeferralAccount String    
DiscountRecognitionAccount String    
ScheduleType String    
TemplateNo String    
ConsolidatePriorPeriods Enum   Yes/No
EqualPerPeriod Enum   Yes/No
OverrideStartDate Enum   Yes/No
DeferralStartDate Date    
DeferralEndDate Date    
ScheduleFromTemplate Enum   Yes/No
BillingScheduleMERALine
MEANumber String    
SSPOrigin String    
StandaloneSellingPrice Number    
DeferredContractRevenueAccount String    
BillingScheduleMERAHeader
MEAType String    
MEANumber String    

Billing Schedule Price Adjustment

Review the following table for the required content for importing data to the SBS ARCB Billing Schedule List page.

Select Copy to copy the sample to the clipboard.

Note icon. Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.

Copy

Price Adjustment Details XML sample

<EscalationDetails>
    <EscalationDettails>
        <BssiArcbBillingScheduleNumber>SCH000005</BssiArcbBillingScheduleNumber>
        <BssiArcbBillingScheduleLineNo.>10000</BssiArcbBillingScheduleLineNo.>
        <LineNo.>10000</LineNo.>
        <Markdown>No</Markdown>
        <EscStartDate>09/15/21</EscStartDate>
        <EscEndDate/>
        <Frequency>None</Frequency>
        <Percentage>0.00</Percentage>
        <Amount>5.00</Amount>
        <CPIschedule/>
        <CPIIndexCalculation>Prior CPI</CPIIndexCalculation>
        <ImportfromHdr>No</ImportfromHdr>
    </EscalationDettails>
</EscalationDetails>

The following table shows the columns for the XML: 

  • Action: Import/Export > XML > Import or Export > Billing Schedule Price Adjustment
Column Name Data Type Required Description
PriceAdjustmentDetails
BssiArcbBillingScheduleNumber String Required Billing schedule number
BssiArcbBillingScheduleLineNo String Required  
LineNo. String Required  
Markdown String    
EscStartDate Date Required  
EscEndDate Date    
Frequency String  

Options: 

  • None
  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
Percentage Integer    
Amount Integer    
CPIschedule String    
CPIIndexCalculation String    
ImportfromHdr Enum   Yes/No

Billing Schedule Usage Items

Review the following table for the required content for importing data to the SBS ARCB Billing Schedule List page.

Select Copy to copy the sample to the clipboard.

Note icon. Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.

Copy

Usage Item XML sample

<?xml version="1.0" encoding="UTF-16" standalone="yes"?>
<BillingScheduleNumber>
    <DetailTable>
        <ScheduleNum>CONT083</ScheduleNum>
        <ItemNo.>1900-S</ItemNo.>
        <UsageOption>Reading</UsageOption>
        <CurrentReadingORQuantity>200</CurrentReadingORQuantity>
        <UsageIdentifier />
        <BillingStartDate>01/01/2020</BillingStartDate>
        <Comments />
    </DetailTable>
    <DetailTable>
        <ScheduleNum>CONT083</ScheduleNum>
        <ItemNo.>1900-S</ItemNo.>
        <UsageOption>Reading</UsageOption>
        <CurrentReadingORQuantity>300</CurrentReadingORQuantity>
        <UsageIdentifier />
        <BillingStartDate>02/01/2020</BillingStartDate>
        <Comments />
    </DetailTable>
</BillingScheduleNumber>

The following table shows the columns for the XML: 

  • Action: Import/Export > XML > Import or Export > Billing Schedule Usage Items
Column Name Data Type Required Description
ScheduleNum String Required  
ItemNo String Required  
UsageOption String   Options: Reading, Consumption
CurrentReadingORQuantity Integer    
UsageIdentifier String   Unique for each usage item with the same item no.
BillingStartDate Date Required The date the usage occurred.
Comments String    

CPI Schedule

Review the following table for the required content for importing data to the SBS ARCB Billing Schedule List page.

Select Copy to copy the sample to the clipboard.

Note icon. Note: Use the FireFox web browser when selecting Copy to ensure that the tab spaces in the code are copied correctly. With other web browsers, the tab spaces are copied as non-breaking spaces, which can cause the code to fail.

Copy

CPI Schedule XML sample

<?xml version="1.0" encoding="UTF-16"?>
<BSSICPISchedulesImpEXp>
    <BSSICPISchedulesHdr>
    <BssiArcbCPIScheduleNo>CAN</BssiArcbCPIScheduleNo>
    <BssiArcbCPIScheduleDesc>Canadian</BssiArcbCPIScheduleDesc>
    <BssiArcbCPILastRunDate/>
    <BssiArcbUserApplied>DEMO</BssiArcbUserApplied>
    <BSSICPISchedulesLine>
        <BssiArcbLineNo>10000</BssiArcbLineNo>
        <BssiArcbCPIDate>08/01/21</BssiArcbCPIDate>
        <BssiArcbCPIValue>0.00000</BssiArcbCPIValue>
    </BSSICPISchedulesLine>
    </BSSICPISchedulesHdr>
</BSSICPISchedulesImpEXp>

The following table shows the columns for the XML: 

  • Action: Import/Export > XML > Import or Export > CPI Schedule
Column Name Data Type Required Description
BSSICPISchedulesHdr
BssiArcbCPIScheduleNo String Required  
BssiArcbCPIScheduleDesc String    
BssiArcbCPILastRunDate Date Required  
BssiArcbUserApplied String    
BSSICPISchedulesLine
BssiArcbLineNo Number    
BssiArcbCPIDate Date    
BssiArcbCPIValue Number