GET vendorusage/{vendor}/{bid}/{invoiceNumber}

Get vendor usage by invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
vendor	Vendor Identifier 0 – Avaya 1 – Cisco	VendorType	Required
bid	Billing ID	unsigned integer	Required
invoiceNumber	Invoice Number	unsigned integer	Required

Body Parameters

None.

Response Information

Resource Description

Vendor Usage Response

VendorUsageResponse

Name	Description	Type	Additional information
InvoiceHeaders	Array of InvoiceHeaders	Collection of VendorUsageInvoiceHeader	None.
ConsolidatedUses	Array of Consolidated Usage	Collection of VendorConsolidatedUsage	None.
Errors	Errors array	Collection of Error	None.

Response Formats

application/json, text/json

Sample:

{
  "InvoiceHeaders": [
    {
      "SubscriptionID": "sample string 1",
      "SKU": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "Rate": 5.0,
      "Amount": 6.0,
      "ConsumptionStartDate": "2021-05-08T06:17:12.0159914-04:00",
      "ConsumptionEndDate": "2021-05-08T06:17:12.0159914-04:00",
      "BillToNumber": "sample string 9",
      "CustomerNumber": "sample string 10",
      "CustomerName": "sample string 11",
      "Currency": "sample string 12",
      "InvoiceDate": "2021-05-08T06:17:12.0159914-04:00",
      "InvoiceNumber": 14,
      "LineNumber": 15,
      "ChargeType": "sample string 16",
      "EndCustomerName": "sample string 17",
      "EndCustomerID": 18
    },
    {
      "SubscriptionID": "sample string 1",
      "SKU": "sample string 2",
      "Description": "sample string 3",
      "Quantity": 4.0,
      "Rate": 5.0,
      "Amount": 6.0,
      "ConsumptionStartDate": "2021-05-08T06:17:12.0159914-04:00",
      "ConsumptionEndDate": "2021-05-08T06:17:12.0159914-04:00",
      "BillToNumber": "sample string 9",
      "CustomerNumber": "sample string 10",
      "CustomerName": "sample string 11",
      "Currency": "sample string 12",
      "InvoiceDate": "2021-05-08T06:17:12.0159914-04:00",
      "InvoiceNumber": 14,
      "LineNumber": 15,
      "ChargeType": "sample string 16",
      "EndCustomerName": "sample string 17",
      "EndCustomerID": 18
    }
  ],
  "ConsolidatedUses": [
    {
      "UsageType": "sample string 1",
      "SKU": "sample string 2",
      "Description": "sample string 3",
      "SubscriptionId": "sample string 4",
      "ConsumptionStartDate": "2021-05-08T06:17:12.0159914-04:00",
      "ConsumptionEndDate": "2021-05-08T06:17:12.0159914-04:00",
      "SiteName": "sample string 7",
      "ConferenceID": 8,
      "Ports": "sample string 9",
      "OverageQuantity": 10,
      "Rate": 11.0,
      "Amount": 12.0,
      "FootnoteFlag": "sample string 13",
      "MeetingDate": "2021-05-08T06:17:12.0159914-04:00",
      "MeetingTimeZone": "sample string 15",
      "MeetingStartTime": "sample string 16",
      "MeetingEndTime": "sample string 17",
      "IntervalStartTime": "sample string 18",
      "IntervalEndTime": "sample string 19",
      "DialStartTime": "sample string 20",
      "DialEndTime": "sample string 21",
      "PhoneNumber": "sample string 22",
      "Country": "sample string 23",
      "RatedUnitPrice": 24.0,
      "GrossAmount": 25.0,
      "HostName": "sample string 26",
      "SystemRatingTimeStamp": "2021-05-08T06:17:12.0159914-04:00",
      "UniqueRecordID": 28,
      "InvoiceNumberLineNumber": "sample string 29",
      "UnitListPrice": 30.0,
      "EffectiveQuantity": 31,
      "CommitmentSku": "sample string 32",
      "TrackingCode1": "sample string 33",
      "TrackingCode2": "sample string 34",
      "TrackingCode3": "sample string 35",
      "TrackingCode4": "sample string 36",
      "TrackingCode5": "sample string 37",
      "TrackingCode6": "sample string 38",
      "TrackingCode7": "sample string 39",
      "TrackingCode8": "sample string 40",
      "TrackingCode9": "sample string 41",
      "TrackingCode10": "sample string 42",
      "ConferenceType": "sample string 43",
      "Recorded": "sample string 44",
      "Package": "sample string 45",
      "AmountAgainstCommitment": 46.0,
      "HostEmail": "sample string 47"
    },
    {
      "UsageType": "sample string 1",
      "SKU": "sample string 2",
      "Description": "sample string 3",
      "SubscriptionId": "sample string 4",
      "ConsumptionStartDate": "2021-05-08T06:17:12.0159914-04:00",
      "ConsumptionEndDate": "2021-05-08T06:17:12.0159914-04:00",
      "SiteName": "sample string 7",
      "ConferenceID": 8,
      "Ports": "sample string 9",
      "OverageQuantity": 10,
      "Rate": 11.0,
      "Amount": 12.0,
      "FootnoteFlag": "sample string 13",
      "MeetingDate": "2021-05-08T06:17:12.0159914-04:00",
      "MeetingTimeZone": "sample string 15",
      "MeetingStartTime": "sample string 16",
      "MeetingEndTime": "sample string 17",
      "IntervalStartTime": "sample string 18",
      "IntervalEndTime": "sample string 19",
      "DialStartTime": "sample string 20",
      "DialEndTime": "sample string 21",
      "PhoneNumber": "sample string 22",
      "Country": "sample string 23",
      "RatedUnitPrice": 24.0,
      "GrossAmount": 25.0,
      "HostName": "sample string 26",
      "SystemRatingTimeStamp": "2021-05-08T06:17:12.0159914-04:00",
      "UniqueRecordID": 28,
      "InvoiceNumberLineNumber": "sample string 29",
      "UnitListPrice": 30.0,
      "EffectiveQuantity": 31,
      "CommitmentSku": "sample string 32",
      "TrackingCode1": "sample string 33",
      "TrackingCode2": "sample string 34",
      "TrackingCode3": "sample string 35",
      "TrackingCode4": "sample string 36",
      "TrackingCode5": "sample string 37",
      "TrackingCode6": "sample string 38",
      "TrackingCode7": "sample string 39",
      "TrackingCode8": "sample string 40",
      "TrackingCode9": "sample string 41",
      "TrackingCode10": "sample string 42",
      "ConferenceType": "sample string 43",
      "Recorded": "sample string 44",
      "Package": "sample string 45",
      "AmountAgainstCommitment": 46.0,
      "HostEmail": "sample string 47"
    }
  ],
  "Errors": [
    {
      "errorCode": "sample string 1",
      "errorMessage": "sample string 2"
    },
    {
      "errorCode": "sample string 1",
      "errorMessage": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<VendorUsageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InvoiceHeaders>
    <VendorUsageInvoiceHeader>
      <SubscriptionID>sample string 1</SubscriptionID>
      <SKU>sample string 2</SKU>
      <Description>sample string 3</Description>
      <Quantity>4</Quantity>
      <Rate>5</Rate>
      <Amount>6</Amount>
      <ConsumptionStartDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionStartDate>
      <ConsumptionEndDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionEndDate>
      <BillToNumber>sample string 9</BillToNumber>
      <CustomerNumber>sample string 10</CustomerNumber>
      <CustomerName>sample string 11</CustomerName>
      <Currency>sample string 12</Currency>
      <InvoiceDate>2021-05-08T06:17:12.0159914-04:00</InvoiceDate>
      <InvoiceNumber>14</InvoiceNumber>
      <LineNumber>15</LineNumber>
      <ChargeType>sample string 16</ChargeType>
      <EndCustomerName>sample string 17</EndCustomerName>
      <EndCustomerID>18</EndCustomerID>
    </VendorUsageInvoiceHeader>
    <VendorUsageInvoiceHeader>
      <SubscriptionID>sample string 1</SubscriptionID>
      <SKU>sample string 2</SKU>
      <Description>sample string 3</Description>
      <Quantity>4</Quantity>
      <Rate>5</Rate>
      <Amount>6</Amount>
      <ConsumptionStartDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionStartDate>
      <ConsumptionEndDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionEndDate>
      <BillToNumber>sample string 9</BillToNumber>
      <CustomerNumber>sample string 10</CustomerNumber>
      <CustomerName>sample string 11</CustomerName>
      <Currency>sample string 12</Currency>
      <InvoiceDate>2021-05-08T06:17:12.0159914-04:00</InvoiceDate>
      <InvoiceNumber>14</InvoiceNumber>
      <LineNumber>15</LineNumber>
      <ChargeType>sample string 16</ChargeType>
      <EndCustomerName>sample string 17</EndCustomerName>
      <EndCustomerID>18</EndCustomerID>
    </VendorUsageInvoiceHeader>
  </InvoiceHeaders>
  <ConsolidatedUses>
    <VendorConsolidatedUsage>
      <UsageType>sample string 1</UsageType>
      <SKU>sample string 2</SKU>
      <Description>sample string 3</Description>
      <SubscriptionId>sample string 4</SubscriptionId>
      <ConsumptionStartDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionStartDate>
      <ConsumptionEndDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionEndDate>
      <SiteName>sample string 7</SiteName>
      <ConferenceID>8</ConferenceID>
      <Ports>sample string 9</Ports>
      <OverageQuantity>10</OverageQuantity>
      <Rate>11</Rate>
      <Amount>12</Amount>
      <FootnoteFlag>sample string 13</FootnoteFlag>
      <MeetingDate>2021-05-08T06:17:12.0159914-04:00</MeetingDate>
      <MeetingTimeZone>sample string 15</MeetingTimeZone>
      <MeetingStartTime>sample string 16</MeetingStartTime>
      <MeetingEndTime>sample string 17</MeetingEndTime>
      <IntervalStartTime>sample string 18</IntervalStartTime>
      <IntervalEndTime>sample string 19</IntervalEndTime>
      <DialStartTime>sample string 20</DialStartTime>
      <DialEndTime>sample string 21</DialEndTime>
      <PhoneNumber>sample string 22</PhoneNumber>
      <Country>sample string 23</Country>
      <RatedUnitPrice>24</RatedUnitPrice>
      <GrossAmount>25</GrossAmount>
      <HostName>sample string 26</HostName>
      <SystemRatingTimeStamp>2021-05-08T06:17:12.0159914-04:00</SystemRatingTimeStamp>
      <UniqueRecordID>28</UniqueRecordID>
      <InvoiceNumberLineNumber>sample string 29</InvoiceNumberLineNumber>
      <UnitListPrice>30</UnitListPrice>
      <EffectiveQuantity>31</EffectiveQuantity>
      <CommitmentSku>sample string 32</CommitmentSku>
      <TrackingCode1>sample string 33</TrackingCode1>
      <TrackingCode2>sample string 34</TrackingCode2>
      <TrackingCode3>sample string 35</TrackingCode3>
      <TrackingCode4>sample string 36</TrackingCode4>
      <TrackingCode5>sample string 37</TrackingCode5>
      <TrackingCode6>sample string 38</TrackingCode6>
      <TrackingCode7>sample string 39</TrackingCode7>
      <TrackingCode8>sample string 40</TrackingCode8>
      <TrackingCode9>sample string 41</TrackingCode9>
      <TrackingCode10>sample string 42</TrackingCode10>
      <ConferenceType>sample string 43</ConferenceType>
      <Recorded>sample string 44</Recorded>
      <Package>sample string 45</Package>
      <AmountAgainstCommitment>46</AmountAgainstCommitment>
      <HostEmail>sample string 47</HostEmail>
    </VendorConsolidatedUsage>
    <VendorConsolidatedUsage>
      <UsageType>sample string 1</UsageType>
      <SKU>sample string 2</SKU>
      <Description>sample string 3</Description>
      <SubscriptionId>sample string 4</SubscriptionId>
      <ConsumptionStartDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionStartDate>
      <ConsumptionEndDate>2021-05-08T06:17:12.0159914-04:00</ConsumptionEndDate>
      <SiteName>sample string 7</SiteName>
      <ConferenceID>8</ConferenceID>
      <Ports>sample string 9</Ports>
      <OverageQuantity>10</OverageQuantity>
      <Rate>11</Rate>
      <Amount>12</Amount>
      <FootnoteFlag>sample string 13</FootnoteFlag>
      <MeetingDate>2021-05-08T06:17:12.0159914-04:00</MeetingDate>
      <MeetingTimeZone>sample string 15</MeetingTimeZone>
      <MeetingStartTime>sample string 16</MeetingStartTime>
      <MeetingEndTime>sample string 17</MeetingEndTime>
      <IntervalStartTime>sample string 18</IntervalStartTime>
      <IntervalEndTime>sample string 19</IntervalEndTime>
      <DialStartTime>sample string 20</DialStartTime>
      <DialEndTime>sample string 21</DialEndTime>
      <PhoneNumber>sample string 22</PhoneNumber>
      <Country>sample string 23</Country>
      <RatedUnitPrice>24</RatedUnitPrice>
      <GrossAmount>25</GrossAmount>
      <HostName>sample string 26</HostName>
      <SystemRatingTimeStamp>2021-05-08T06:17:12.0159914-04:00</SystemRatingTimeStamp>
      <UniqueRecordID>28</UniqueRecordID>
      <InvoiceNumberLineNumber>sample string 29</InvoiceNumberLineNumber>
      <UnitListPrice>30</UnitListPrice>
      <EffectiveQuantity>31</EffectiveQuantity>
      <CommitmentSku>sample string 32</CommitmentSku>
      <TrackingCode1>sample string 33</TrackingCode1>
      <TrackingCode2>sample string 34</TrackingCode2>
      <TrackingCode3>sample string 35</TrackingCode3>
      <TrackingCode4>sample string 36</TrackingCode4>
      <TrackingCode5>sample string 37</TrackingCode5>
      <TrackingCode6>sample string 38</TrackingCode6>
      <TrackingCode7>sample string 39</TrackingCode7>
      <TrackingCode8>sample string 40</TrackingCode8>
      <TrackingCode9>sample string 41</TrackingCode9>
      <TrackingCode10>sample string 42</TrackingCode10>
      <ConferenceType>sample string 43</ConferenceType>
      <Recorded>sample string 44</Recorded>
      <Package>sample string 45</Package>
      <AmountAgainstCommitment>46</AmountAgainstCommitment>
      <HostEmail>sample string 47</HostEmail>
    </VendorConsolidatedUsage>
  </ConsolidatedUses>
  <Errors>
    <Error>
      <errorCode>sample string 1</errorCode>
      <errorMessage>sample string 2</errorMessage>
    </Error>
    <Error>
      <errorCode>sample string 1</errorCode>
      <errorMessage>sample string 2</errorMessage>
    </Error>
  </Errors>
</VendorUsageResponse>