Partner Account Usage Report (billing integration and reconciliation) Service

Available methods

Partner's:

GET /v1/api/accounts/{partnerID}/reports/usage 

GET /v1/api/accounts/{partnerID}/reports/usage

This method retrieves the Partner account usage report (report shows items sold to accounts by the Partner for a given period).

Note: this operation is applicable only to Partner account. The account usage report must be enabled for Partner. Please contact the support to enable it.

Input Parameters

 ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 partnerID path string Required

Identifies the Partner

2 from query date-time Required

Beginning date for the time span to build the report for.

Date in the following format: YYYY-MM-DD

3 to query date-time Required

Ending date for the time span to build the report for.

Date in the following format: YYYY-MM-DD

4 skip query integer Optional Pagination: Number of items to skip
5 take query integer Optional Pagination: Number of items to take

Output Parameters

PageV1Model [UsageReportV1Model]


PageV1Model[UsageReportV1Model] {
count (integer, optional): Pagination: Number of items retrieved,
total (integer, optional): Pagination: Total number of items, items (Array[UsageReportV1Model], optional): An array of items } UsageReportV1Model {accountID (string, optional): Account id, parentPartnerID (string, optional): Parent partner id, planName (string, optional): Billing plan name, itemName (string, optional): Billing item name, itemDescription (string, optional): Billing item description, amount (number, optional): Transaction amount, quantity (number, optional): Quantity of the items affected by transaction, proratedQuantity (number, optional): This is a quantity for services purchased during current month. For such services customers are charged not the full month price but only from day of purchase till the end of month. Prorated quantity for services purchased in the current month is a functional number, price (number, optional): Billing item price, vat (number, optional): Value Added Tax, partNumber (string, optional): Item part number, compositeSku (string, optional): The composite stock keeping unit (SKU), serviceTransactionDate (string, optional): Service transaction date, serviceTransactionDescription (string, optional): Service transaction description }

Response Class (Status 200)

Returns the Partner account usage report for the specified Partner, filtered according to the specified criteria.

Response example

Account usage data for the specified Partner is displayed (5 items, starting from the 4th (3 skipped))

  Response Body example  { "count": 5, "total": 8, "items": [ { "accountID": "af5c28db93f4428e93a5216509186808", "parentPartnerID": "b29279dec0744bd689c0e9f786c3d01f", "planName": "E2016_Collab_1", "itemName": "ActiveDirectory_usersStandard", "itemDescription": "Addtl Collaboration Plan Users - Without Outlook/Entourage Licensing", "amount": 3.6, "quantity": 1, "proratedQuantity": 0.3, "price": 12, "vat": 0, "partNumber": "PLN005NR", "compositeSku": "PLN005NR_12.00000000", "serviceTransactionDate": "2017-04-20T14:39:02.087+00:00", "serviceTransactionDescription": "Create mailbox: mbx3@imqa-gr-hop3.qaserverdata.net" }, { "accountID": "af5c28db93f4428e93a5216509186808", "parentPartnerID": "b29279dec0744bd689c0e9f786c3d01f", "planName": "E2016_Collab_1", "itemName": "ActiveDirectory_usersStandard", "itemDescription": "Addtl Collaboration Plan Users - Without Outlook/Entourage Licensing", "amount": 3.6, "quantity": 1, "proratedQuantity": 0.3, "price": 12, "vat": 0, "partNumber": "PLN005NR", "compositeSku": "PLN005NR_12.00000000", "serviceTransactionDate": "2017-04-20T14:39:02.16+00:00", "serviceTransactionDescription": "Create mailbox: mbx4@imqa-gr-hop3.qaserverdata.net" }, { "accountID": "af5c28db93f4428e93a5216509186808", "parentPartnerID": "b29279dec0744bd689c0e9f786c3d01f", "planName": "E2016_Collab_1", "itemName": "Owa_mailboxes", "itemDescription": "OWA-only mailbox", "amount": 0.75, "quantity": 1, "proratedQuantity": 0.3, "price": 2.5, "vat": 0, "partNumber": "OWA004NR", "compositeSku": "OWA004NR_2.50000000", "serviceTransactionDate": "2017-04-20T15:16:40.61+00:00", "serviceTransactionDescription": "Create OWA-Only mailbox: owa2@imqa-gr-hop3.qaserverdata.net" }, { "accountID": "af5c28db93f4428e93a5216509186808", "parentPartnerID": "b29279dec0744bd689c0e9f786c3d01f", "planName": "E2016_Collab_1", "itemName": "Owa_mailboxes", "itemDescription": "OWA-only mailbox", "amount": 0.75, "quantity": 1, "proratedQuantity": 0.3, "price": 2.5, "vat": 0, "partNumber": "OWA004NR", "compositeSku": "OWA004NR_2.50000000", "serviceTransactionDate": "2017-04-20T15:16:40.707+00:00", "serviceTransactionDescription": "Create OWA-Only mailbox: owa3@imqa-gr-hop3.qaserverdata.net" }, { "accountID": "af5c28db93f4428e93a5216509186808", "parentPartnerID": "b29279dec0744bd689c0e9f786c3d01f", "planName": "E2016_Collab_1", "itemName": "Owa_mailboxes", "itemDescription": "OWA-only mailbox", "amount": 0.75, "quantity": 1, "proratedQuantity": 0.3, "price": 2.5, "vat": 0, "partNumber": "OWA004NR", "compositeSku": "OWA004NR_2.50000000", "serviceTransactionDate": "2017-04-20T15:16:40.797+00:00", "serviceTransactionDescription": "Create OWA-Only mailbox: owa4@test.net" } ] }

Possible error response messages