Billing Breakdown

Get a billing breakdown per tenant details and customer details.

Headers

Property	Value
Request Type	GET
Content Type	application-json
URL	{{EnvironmentURL}}/api/services/app/Invoices/GetBillingBreakdownPerTenant

Please see Environments under Getting Started for test and production environment URLs.

Additional Headers

Property	Type	Value	Required
accountNumber	string	Account number for the partner. Partner name will not be used for extra security purposes.	✓

Request Parameters

Property	Type	Description	Required
customer	string	Filter for a specific customer. Will return all customers linked to your account if left blank.	✓
year	int	The year for the billing to retrieve.	✓
month	int	The month for the billing to retrieve.	✓

Sample Request

{
    "exportOptions":{"reportType":2},
    "year":2024,
    "month":5,
    "identifier":"0",
    "market":2
    }

Response Parameters

Property	Type	Description
customerName	string	Name of the customer.
invoiceType	string	Invoice type for Microsoft.
chargeType	string	How the billing will be charged.
productName	string	Name of the product invoiced.
chargeStartDate	string	Billing charge start date.
chargeEndDate	string	Billing charge end date.
quantity	int	Quantity for the product invoiced.
resellerName	string	Tenant name in Axiz Digital.
tier2MpnId	int	MpnId for the customer.
accountNumber	string	Tenant account number.
sellCurrency	string	Sell currency for the invoice.
billingCycle	string	Billing cycle which the billing will run.
microsoftInvoiceDate	string	Date for the Microsoft account.
microsoftCustomerId	string	Customer id on Microsoft account.
sellPrice	int	Sell price for the product.
roe	int	Rate of exchange (ROE) used for the conversion.
regionCode	string	Code of a region. Will be either MEA or WECA. See region codes under constants for designations.
productTypeName	string	Product type for the product bought (NCE etc).
microsoftInvoiceId	string	Invoice ID

Sample Response (1 cutomer)

{
    "result": [
        {
            "customerName": "KohdeTestAccountQA",
            "invoiceType": "ONETIME",
            "chargeType": "new",
            "productName": "Office 365 E1-new",
            "chargeStartDate": "2024-03-18T00:00:00",
            "chargeEndDate": "2024-04-17T00:00:00",
            "quantity": 1.00000000,
            "resellerName": "AXIZ PTY LTD-TEST ACCOUNT",
            "tier2MpnId": 1604043,
            "accountNumber": "SJAXI9986",
            "sellCurrency": "ZAR",
            "billingCycle": "OneTime",
            "microsoftInvoiceDate": "2024-04-06T05:05:23.4927984",
            "microsoftCustomerId": "eb0f51fc-86c2-4668-9729-75faa9789245",
            "sellPrice": 192.24,
            "roe": 19.25,
            "regionCode": "MEA",
            "productTypeName": "OnlineServicesNCE",
            "microsoftInvoiceId": null
        }
    ],
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}