Get invoice estimate links
Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government
You can get estimate links to help query details for unbilled reconciliation line items.
Prerequisites
Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
An invoice identifier. This identifies the invoice for which to retrieve the line items.
C#
The following example code shows how you can get the estimate links to query unbilled line items for a given currency. The response contains the estimate links for each period (for example, the current and previous month).
// IAggregatePartner partnerOperations;
// string curencyCode;
// all the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));
// read estimate links for currencycode
var estimateLinks = scopedPartnerOperations.Invoices.Estimates.Links.ByCurrency(curencyCode).Get();
For a similar example, see the following:
- Sample: Console test app
- Project: Partner Center SDK Samples
- Class: GetEstimatesLinks.cs
REST request
Request syntax
Method | Request URI |
---|---|
GET | {baseURL}/v1/invoices/estimates/links?currencycode={currencycode} HTTP/1.1 |
URI parameters
Use the following URI and query parameter when creating the request.
Name | Type | Required | Description |
---|---|---|---|
currencyCode | string | Yes | The currency code for the unbilled line items. |
Request headers
For more information, see Partner Center REST headers.
Request body
None.
Request example
GET https://api.partnercenter.microsoft.com/v1/invoices/estimates/links?currencycode=usd HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 1234ecb8-37af-45f4-a1a1-358de3ca2b9e
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com
Important
As of June 2023, the latest Partner Center .NET SDK release 3.4.0 is now archived. You can download the SDK release from GitHub, along with a readme file that contains useful information.
Partners are encouraged to continue to use the Partner Center REST APIs.
REST response
If successful, the response contains the links to retrieve unbilled estimates.
Response success and error codes
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Partner Center REST error codes.
Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/10.0
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 1b18689e-3fe3-4fdb-d09e-39d13941390b
X-Locale: en-US
X-SourceFiles: =?UTF-8?B?RDpcU291cmNlc1xSUEUuUGFydG5lci5TZXJ2aWNlLkJpbGxpbmdTZXJ2aWNlXHYxLjFcV2ViQXBpc1xCaWxsaW5nU2VydmljZS5WMi5XZWJcdjFcaW52b2ljZXNcZXN0aW1hdGVzXGxpbmtz?=
X-Powered-By: ASP.NET
Date: Thu, 14 Mar 2019 18:15:06 GMT
Content-Length: 1857
{
"totalCount": 4,
"items": [
{
"type": "daily_rated_usage",
"title": "Daily rated usage unbilled",
"description": "This invoice line items includes unbilled consumption based data only.",
"period": "Current",
"link": {
"uri": "/invoices/unbilled/lineitems?provider=Marketplace&invoicelineitemtype=UsageLineItems¤cycode=USD&period=current&size=2000",
"method": "GET",
"headers": []
}
},
{
"type": "daily_rated_usage",
"title": "Daily rated usage unbilled",
"description": "This invoice line items includes unbilled consumption based data only.",
"period": "Previous",
"link": {
"uri": "/invoices/unbilled/lineitems?provider=Marketplace&invoicelineitemtype=UsageLineItems¤cycode=USD&period=previous&size=2000",
"method": "GET",
"headers": []
}
},
{
"type": "non_consumption",
"title": "Unbilled reconciliation line items",
"description": "This includes reconciliation line items for unbilled data only.",
"period": "Current",
"link": {
"uri": "/invoices/unbilled/lineitems?provider=all&invoicelineitemtype=billinglineitems¤cycode=USD&period=current&size=2000",
"method": "GET",
"headers": []
}
},
{
"type": "non_consumption",
"title": "Unbilled reconciliation line items",
"description": "This includes reconciliation line items for unbilled data only.",
"period": "Previous",
"link": {
"uri": "/invoices/unbilled/lineitems?provider=all&invoicelineitemtype=billinglineitems¤cycode=USD&period=previous&size=2000",
"method": "GET",
"headers": []
}
}
],
"attributes": {
"objectType": "Collection"
}
}