ECGridOS API v3


Click here for a complete list of operations.

InvoiceCalculateLineItem

PENDING Calculate an Invoice Line Item Value for a Specific Month

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
NetworkID:
MailboxID:
ReportingMonth:
AccountReport:
MeasureField:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ECGridOS.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ecgridos.net/InvoiceCalculateLineItem"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InvoiceCalculateLineItem xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ReportingMonth>dateTime</ReportingMonth>
      <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
      <MeasureField>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</MeasureField>
    </InvoiceCalculateLineItem>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InvoiceCalculateLineItemResponse xmlns="http://ecgridos.net/">
      <InvoiceCalculateLineItemResult>
        <LineItemNumber>short</LineItemNumber>
        <LineDate>dateTime</LineDate>
        <PriceListID>int</PriceListID>
        <PriceListDescription>string</PriceListDescription>
        <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
        <SystemID>int</SystemID>
        <SystemName>string</SystemName>
        <Level>Minimum or Additional or OneTime or General or Developement or Level1 or Level2 or Level3 or Level4 or Level5 or Level6 or Level7 or Level8 or Level9 or Tier1 or Tier2 or Tier3 or Tier4 or Tier5 or Tier6 or Tier7 or Tier8 or Tier9</Level>
        <LevelName>string</LevelName>
        <Model>Simple or Tiered or Stacked</Model>
        <Schedule>
          <ScheduleID>int</ScheduleID>
          <Allowance>decimal</Allowance>
          <Minimum>int</Minimum>
          <Maximum>int</Maximum>
          <Block>decimal</Block>
          <Rate>decimal</Rate>
          <CatalogID>int</CatalogID>
          <Description>string</Description>
          <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
          <Measure>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</Measure>
          <SpecifiedNetworkID>int</SpecifiedNetworkID>
          <IncludeRootMailbox>boolean</IncludeRootMailbox>
        </Schedule>
        <Actual>decimal</Actual>
        <QuantityBilled>decimal</QuantityBilled>
        <Taxable>boolean</Taxable>
        <Amount>decimal</Amount>
      </InvoiceCalculateLineItemResult>
    </InvoiceCalculateLineItemResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ECGridOS.asmx HTTP/1.1
Host: ecgridos.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InvoiceCalculateLineItem xmlns="http://ecgridos.net/">
      <SessionID>string</SessionID>
      <NetworkID>int</NetworkID>
      <MailboxID>int</MailboxID>
      <ReportingMonth>dateTime</ReportingMonth>
      <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
      <MeasureField>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</MeasureField>
    </InvoiceCalculateLineItem>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InvoiceCalculateLineItemResponse xmlns="http://ecgridos.net/">
      <InvoiceCalculateLineItemResult>
        <LineItemNumber>short</LineItemNumber>
        <LineDate>dateTime</LineDate>
        <PriceListID>int</PriceListID>
        <PriceListDescription>string</PriceListDescription>
        <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
        <SystemID>int</SystemID>
        <SystemName>string</SystemName>
        <Level>Minimum or Additional or OneTime or General or Developement or Level1 or Level2 or Level3 or Level4 or Level5 or Level6 or Level7 or Level8 or Level9 or Tier1 or Tier2 or Tier3 or Tier4 or Tier5 or Tier6 or Tier7 or Tier8 or Tier9</Level>
        <LevelName>string</LevelName>
        <Model>Simple or Tiered or Stacked</Model>
        <Schedule>
          <ScheduleID>int</ScheduleID>
          <Allowance>decimal</Allowance>
          <Minimum>int</Minimum>
          <Maximum>int</Maximum>
          <Block>decimal</Block>
          <Rate>decimal</Rate>
          <CatalogID>int</CatalogID>
          <Description>string</Description>
          <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
          <Measure>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</Measure>
          <SpecifiedNetworkID>int</SpecifiedNetworkID>
          <IncludeRootMailbox>boolean</IncludeRootMailbox>
        </Schedule>
        <Actual>decimal</Actual>
        <QuantityBilled>decimal</QuantityBilled>
        <Taxable>boolean</Taxable>
        <Amount>decimal</Amount>
      </InvoiceCalculateLineItemResult>
    </InvoiceCalculateLineItemResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3.2/prod/ECGridOS.asmx/InvoiceCalculateLineItem?SessionID=string&NetworkID=string&MailboxID=string&ReportingMonth=string&AccountReport=string&MeasureField=string HTTP/1.1
Host: ecgridos.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LineItem xmlns="http://ecgridos.net/">
  <LineItemNumber>short</LineItemNumber>
  <LineDate>dateTime</LineDate>
  <PriceListID>int</PriceListID>
  <PriceListDescription>string</PriceListDescription>
  <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
  <SystemID>int</SystemID>
  <SystemName>string</SystemName>
  <Level>Minimum or Additional or OneTime or General or Developement or Level1 or Level2 or Level3 or Level4 or Level5 or Level6 or Level7 or Level8 or Level9 or Tier1 or Tier2 or Tier3 or Tier4 or Tier5 or Tier6 or Tier7 or Tier8 or Tier9</Level>
  <LevelName>string</LevelName>
  <Model>Simple or Tiered or Stacked</Model>
  <Schedule>
    <ScheduleID>int</ScheduleID>
    <Allowance>decimal</Allowance>
    <Minimum>int</Minimum>
    <Maximum>int</Maximum>
    <Block>decimal</Block>
    <Rate>decimal</Rate>
    <CatalogID>int</CatalogID>
    <Description>string</Description>
    <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
    <Measure>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</Measure>
    <SpecifiedNetworkID>int</SpecifiedNetworkID>
    <IncludeRootMailbox>boolean</IncludeRootMailbox>
  </Schedule>
  <Actual>decimal</Actual>
  <QuantityBilled>decimal</QuantityBilled>
  <Taxable>boolean</Taxable>
  <Amount>decimal</Amount>
</LineItem>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3.2/prod/ECGridOS.asmx/InvoiceCalculateLineItem HTTP/1.1
Host: ecgridos.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&NetworkID=string&MailboxID=string&ReportingMonth=string&AccountReport=string&MeasureField=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LineItem xmlns="http://ecgridos.net/">
  <LineItemNumber>short</LineItemNumber>
  <LineDate>dateTime</LineDate>
  <PriceListID>int</PriceListID>
  <PriceListDescription>string</PriceListDescription>
  <SystemObject>System or User or Network or Mailbox or ECGridID or Interconnect or Migration or Parcel or Interchange or CarbonCopy or CallBackEvent or AS2 or GISB or ParcelNotes or InterconnectNote or PriceList or Contract or Invoice</SystemObject>
  <SystemID>int</SystemID>
  <SystemName>string</SystemName>
  <Level>Minimum or Additional or OneTime or General or Developement or Level1 or Level2 or Level3 or Level4 or Level5 or Level6 or Level7 or Level8 or Level9 or Tier1 or Tier2 or Tier3 or Tier4 or Tier5 or Tier6 or Tier7 or Tier8 or Tier9</Level>
  <LevelName>string</LevelName>
  <Model>Simple or Tiered or Stacked</Model>
  <Schedule>
    <ScheduleID>int</ScheduleID>
    <Allowance>decimal</Allowance>
    <Minimum>int</Minimum>
    <Maximum>int</Maximum>
    <Block>decimal</Block>
    <Rate>decimal</Rate>
    <CatalogID>int</CatalogID>
    <Description>string</Description>
    <AccountReport>FixedRate or Statistics or TrafficAll or TrafficIntraNetwork or TrafficInterECGrid or TrafficOffNetwork or TrafficSpecial or TrafficKCInterchangeTiered</AccountReport>
    <Measure>Each or FixedRate or NewInterconnects or CurrentMailboxes or ActiveQIDs or ActiveTPs or TotalTrans or ToTrans or FromTrans or TotalKCs or ToKCs or FromKCs or RegisteredQIDs or RegisteredTPs or MigratedTPs or CreditPercentage or DebitPercentage or Subtotal or TieredKCIntCount or MonthlyMinimum or Credit</Measure>
    <SpecifiedNetworkID>int</SpecifiedNetworkID>
    <IncludeRootMailbox>boolean</IncludeRootMailbox>
  </Schedule>
  <Actual>decimal</Actual>
  <QuantityBilled>decimal</QuantityBilled>
  <Taxable>boolean</Taxable>
  <Amount>decimal</Amount>
</LineItem>