In this article

CSV/XML Format: Billing Schedule Setup Data

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 Setup

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

Select Copy to copy the sample to the clipboard.

Copy

BillingScheduleSetup.txt sample

"Active","0","0","No","No","No","No","Adjust Schedule","None","DEFAULT"," Invoice Quantity","No",""," Annually"," Annually","DEFAULT"

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

BillingScheduleMaster.xml sample

<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<BSSISchedulesSetup>
    <BSSISchGroup>
        <BillingScheduleGroup>DEFAULT</BillingScheduleGroup>
        <BillingScheduleGroupName>Binary Stream Default</BillingScheduleGroupName>
        <PricingMethod>Standard</PricingMethod>
        <BillingFrequency> Monthly</BillingFrequency>
        <BillingType>Standard</BillingType>
        <Interval>1</Interval>
        <AutoRenewed>No</AutoRenewed>
        <InvoiceSeperately>No</InvoiceSeperately>
        <UsageReadingOption>Reading</UsageReadingOption>
        <LinesPerRenewal>1</LinesPerRenewal>
        <ContractNos.>ARCB</ContractNos.>
        <NumberofPeriods>12</NumberofPeriods>
        <CalculationMethod>X Days Before Start Date</CalculationMethod>
        <DayofInvoiceDate>15</DayofInvoiceDate>
    </BSSISchGroup>
    <BSSISchSetup>
        <BillingScheduleStatus>Active</BillingScheduleStatus>
        <NoticeGivenDays>0</NoticeGivenDays>
        <RenewInAdvance>0</RenewInAdvance>
        <ProRatePartialPeriod>No</ProRatePartialPeriod>
        <AlignToMonth>No</AlignToMonth>
        <ConsolidateByItem>No</ConsolidateByItem>
        <ConsolidateByCustomer>No</ConsolidateByCustomer>
        <TerminationType>Adjust Schedule</TerminationType>
        <UniqueSchType>None</UniqueSchType>
        <BillingSchGorup>DEFAULT</BillingSchGorup>
        <SupportandRenewalQuantity> Invoice Quantity</SupportandRenewalQuantity>
        <IncludeDiscount>No</IncludeDiscount>
        <SupportLevel />
        <SupportFrequency> Annually</SupportFrequency>
        <RenewalFrequency> Annually</RenewalFrequency>
        <RenewalScheduleGroup>DEFAULT</RenewalScheduleGroup>
    </BSSISchSetup>
</BSSISchedulesSetup>
Field Data Type Required Description
BSSISchGroup
BillingScheduleGroup String    
BillingScheduleGroupName String    
PricingMethod String   Options: Standard, Flat, Tier, Flat Tier.
BillingFrequency String  

Options: 

  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
  • Weekly
  • Daily
  • Miscellaneous
BillingType String    
Interval Integer    
AutoRenewed Enum   Yes/No
InvoiceSeperately Enum   Yes/No
UsageReadingOption String   Options: Reading, Consumption
LinesPerRenewal Integer    
ContractNos String    
NumberofPeriods Integer    
CalculationMethod String  

Options: 

  • X Days Before Start Date
  • X Day of Current Month
  • X Day of Next Month
  • End of Month
DayofInvoiceDate Date    
BSSISchSetup
BillingScheduleStatus String    
NoticeGivenDays Integer    
RenewInAdvance Integer    
ProRatePartialPeriod Enum   Yes/No
ConsolidateByItem Enum   Yes/No
ConsolidateByCustomer Enum   Yes/No
TerminationType String   Options: Adjust Schedule, Bill Remaining
UniqueSchType String    
BillingSchGroup String    
SupportandRenewalQuantity String   Options: 1, Invoice Qty
IncludeDiscount Enum   Yes/No
SupportLevel Integer    
SupportFrequency String  

Options: 

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

Options: 

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

Billing Schedule Group

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

Select Copy to copy the sample to the clipboard.

Copy

BillingScheduleGroup.txt sample

"DEFAULT","Binary Stream Default","Standard"," Monthly","Standard","1","No","No","Reading","1","ARCB","12","X Days Before Start Date","15"

Milestone Template

Milestone (XML)

Review the following table for the required content for importing data to the SBS ARCB Billing Milestone List and Template 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

MilestoneTemplate.xml sample

<?xml version="1.0" encoding="UTF-16" standalone="no"?>
<MilestoneInfo>
    <MilestoneHdr>
        <MSTemplateId>NEW TEMPLATE</MSTemplateId>
        <MSdescription>Description</MSdescription>
        <AllocationMethod>By Percentage</AllocationMethod>
        <MilestoneDetails>
            <LineNo.>1</LineNo.>
            <Type>Item</Type>
            <ItemNo.>1000</ItemNo.>
            <Allocation_Method>By Percentage</Allocation_Method>
            <Frequencey> Onetime</Frequencey>
            <CompleteInDays>1</CompleteInDays>
            <Percentage>50.00</Percentage>
            <Item_Description>Bicycle</Item_Description>
        </MilestoneDetails>
        <MilestoneDetails>
            <LineNo.>2</LineNo.>
            <Type>Item</Type>
            <ItemNo. />
            <Allocation_Method>By Percentage</Allocation_Method>
            <Frequencey> Onetime</Frequencey>
            <CompleteInDays>0</CompleteInDays>
            <Percentage>50.00</Percentage>
            <Item_Description />
        </MilestoneDetails>
        <MilestoneLinkedItem>
            <ItemNo />
            <ItemDesc />
        </MilestoneLinkedItem>
    </MilestoneHdr>
</MilestoneInfo>
Field Data Type Required Description
MilestoneHdr
MSTemplateId String Required  
MSdescription String    
AllocationMethod String Required  
MilestoneDetails
LineNo Integer    
Type String    
ItemNo String    
AllocationMethod String   Options: Percentage of Completion, By Percentage, Variable Amount, Equal Amount, By Quantity
Frequency String  

Options: 

  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
  • Weekly
  • Daily
  • Miscellaneous
CompletionInDays Integer    
Percentage Integer    
ItemDescription String    

Milestone (Header)

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

Select Copy to copy the sample to the clipboard.

Copy

MilestoneHeader.txt sample

"NEW TEMPLATE","Description","By Percentage"
Field Data Type Required Description
MSTemplateId String Required  
MSdescription String    
AllocationMethod String Required Options: Percentage of Completion, By Percentage, Variable Amount, Equal Amount, By Quantity

Milestone (Lines)

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

Select Copy to copy the sample to the clipboard.

Copy

MilestoneLines.txt sample

"NEW TEMPLATE","1","Item","1000","By Percentage"," Onetime","1","50.00","Bicycle"
"NEW TEMPLATE","2","Item","","By Percentage"," Onetime","0","50.00",""
Field Data Type Required Description
MSTemplateId String Required  
LineNo Integer    
Type String    
ItemNo String    
AllocationMethod String Required Options: Percentage of Completion, By Percentage, Variable Amount, Equal Amount, By Quantity
Frequency String  

Options: 

  • Monthly
  • Quarterly
  • Semi-Annual
  • Annual
  • One Time
  • Weekly
  • Daily
  • Miscellaneous
CompletionInDays Integer    
Percentage Integer    
ItemDescription String    

Milestone (Items)

Review the following table for the required content for importing data to the SBS ARCB Link Item(s) to Milestone page.

Select Copy to copy the sample to the clipboard.

Copy

MilestoneItems.txt sample

"TEST1","1","Item","1900-S","By Percentage"," Onetime","1","20.00","PARIS Guest Chair, black"
"TEST1","2","Item","1906-S","By Percentage"," Onetime","1","80.00","ATHENS Mobile Pedestal"