Pobieranie kolekcji faktur
Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA
Jak pobrać kolekcję faktur partnera.
Wymagania wstępne
- Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
C#
Aby uzyskać kolekcję wszystkich dostępnych faktur, użyj właściwości Faktury, aby uzyskać interfejs do operacji na fakturze, a następnie wywołaj metodę Get lub GetAsync, aby pobrać kolekcję.
Aby uzyskać stronicowaną kolekcję faktur, najpierw wywołaj metodę BuildIndexedQuery i przekaż jej rozmiar strony, aby utworzyć obiekt IQuery. Następnie użyj właściwości Invoices, aby pobrać interfejs do operacji na fakturze, a następnie przekazać obiekt IQuery do metody Query lub QueryAsync, aby wysłać żądanie i pobrać pierwszą stronę.
Następnie użyj właściwości Moduły wyliczające, aby uzyskać interfejs do kolekcji obsługiwanych modułów wyliczających kolekcji zasobów, a następnie wywołaj metodę Invoices.Create, aby utworzyć moduł wyliczający umożliwiający przechodzenie do kolekcji faktur. Na koniec użyj modułu wyliczającego, aby pobrać każdą stronę faktur i pracować z nimi, jak pokazano w poniższym przykładzie kodu. Każde wywołanie metody Next wysyła żądanie dla następnej strony faktur na podstawie rozmiaru strony.
// IAggregatePartner partnerOperations;
// int invoicePageSize;
// Is this an unpaged or paged request?
bool isUnpaged = (this.invoicePageSize <= 0);
// If the scenario is unpaged, get all the invoices, otherwise get the first page.
var invoicesPage = (isUnpaged)
? partnerOperations.Invoices.Get()
: partnerOperations.Invoices.Query(QueryFactory.Instance.BuildIndexedQuery(this.invoicePageSize));
// Create an invoice enumerator for traversing the invoice pages.
var invoicesEnumerator = partnerOperations.Enumerators.Invoices.Create(invoicesPage);
int lineCounter = 1;
while (invoicesEnumerator.HasValue)
{
// Print the current invoice results page.
var invoices = invoicesEnumerator.Current.Items;
foreach (var i in invoices)
{
Console.WriteLine(String.Format("{0,3}. {1} {2} {3,16:C2}",
lineCounter++,
i.Id,
i.InvoiceDate.ToString("yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z'"),
i.TotalCharges));
}
Console.WriteLine();
Console.Write("Press any key to retrieve the next invoices page");
Console.ReadKey();
// Get the next page of invoices.
invoicesEnumerator.Next();
}
Aby uzyskać nieco inny przykład, zobacz Przykład: aplikacja testowa konsoli. Projekt: Klasa przykładów zestawu SDK Centrum partnerskiego: GetPagedInvoices.cs
Uwaga
Ten sam interfejs API jest używany dla wszystkich nowoczesnych zakupów komercyjnych, a także 145p i licencji pakietu Office. Rozmiar i przesunięcie są uwzględniane tylko w przypadku starszych faktur. W przypadku wszystkich nowoczesnych zakupów komercyjnych rozmiar strony i przesunięcie zostaną zignorowane.
Żądanie REST
Składnia żądania
| Method | Identyfikator URI żądania |
|---|---|
| GET | {baseURL}/v1/invoices?size={size}&offset={offset} HTTP/1.1 |
| GET | {baseURL}/v1/invoices?size={size}&offset={offset}&filter={"LeftFilter":{"Field":{field},"Value":{value},"Operator":{operator}},"RightFilter":{"Field":{field},"Value":{value},"Operator":{operator}},"Operator":{operator}} HTTP/1.1 |
Parametry identyfikatora URI
Podczas tworzenia żądania użyj następujących parametrów zapytania.
| Nazwisko | Type | Wymagania | opis |
|---|---|---|---|
| size | int | Nie. | Liczba zasobów faktury, które mają być zwracane w odpowiedzi. Ten parametr jest opcjonalny. |
| offset | int | Nie. | Indeks na podstawie zera pierwszej faktury do zwrócenia. |
| filtr | string | Nie | Niestandardowe kryteria filtrowania oparte na tekście w celu zmniejszenia zasobów faktury w odpowiedzi. Użyj tego warunku, aby zapobiec błędowi przekroczenia limitu czasu. Zobacz , jak używać warunku filtru |
Jak używać warunku filtru
Przykład warunku filtru:
/v1/invoices?size=10&offset=0&filter={"LeftFilter":{"Field":"InvoiceDate","Value":"01/01/2023","Operator":"greater_than_or_equals"},"RightFilter":{"Field":"InvoiceDate","Value":"12/31/2023","Operator":"less_than_or_equals"},"Operator":"and"}
Kryteria filtrowania składają się z trzech części:
LeftFilter: pierwsza konstrukcja filtru, w której określasz pole, wartość i operator po lewej stronie wyrażenia filtru.
Pole: atrybut, który ma być używany do filtrowania. Wartość: wartość atrybutu
Na przykład "LeftFilter": {"Field":"InvoiceDate","Value":"01/01/2023","Operator":"greater_than_or_equals"} oznacza, że chcesz filtrować faktury, które mają datę faktury w dniu 1 stycznia 2023 r.
RightFilter: druga konstrukcja filtru, w której określasz pole, wartość i operator dla prawej strony wyrażenia filtru.
Na przykład "RightFilter":{"Field":"InvoiceDate","Value":"12/31/2023","Operator":"less_than_or_equals"} oznacza, że chcesz filtrować faktury, które mają datę faktury w dniu lub przed 31 grudnia 2023 r.
Operator: operator logiczny łączący filtry po lewej i prawej stronie. Możesz użyć operatora "i" lub "lub".
Na przykład "Operator": "and" oznacza, że chcesz filtrować faktury spełniające kryteria filtrowania zarówno po lewej, jak i prawej stronie.
Aby użyć pojedynczego filtru, wystarczy wprowadzić nazwę pola, wartość i operator. Nie ma potrzeby tworzenia konstrukcji "LeftFilter" ani "RightFilter".
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak
Przykład żądania
GET https://api.partnercenter.microsoft.com/v1/invoices?size=200&offset=0 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: de894e18-f027-4ac0-8b5a-34f0c222af0c
X-Locale: en-US
MS-PartnerCenter-Application: Partner Center .NET SDK Samples
Host: api.partnercenter.microsoft.com
Ważne
Od czerwca 2023 r. najnowsza wersja zestawu .NET SDK Centrum partnerskiego 3.4.0 jest teraz archiwizowana. Możesz pobrać wersję zestawu SDK z usługi GitHub wraz z plikiem readme zawierającym przydatne informacje.
Zachęcamy partnerów do dalszego korzystania z interfejsów API REST Centrum partnerskiego.
Odpowiedź REST
W przypadku powodzenia treść odpowiedzi zawiera kolekcję zasobów faktury .
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.
Przykład odpowiedzi
HTTP/1.1 200 OK
Content-Length: 256
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 57eb2ca7-755f-450f-9187-eae1e75a0114
MS-RequestId: a45e6643-1caf-4429-8f90-07c03d85bc2b
Date: Thu, 24 Mar 2016 05:21:01 GMT
{
"totalCount": 2,
"items": [
{
"id": "D02005YFHI",
"invoiceDate": "2017-01-21T00:00:00Z",
"totalCharges": 24606.35,
"paidAmount": 1000,
"currencyCode": "GBP",
"currencySymbol": "£",
"pdfDownloadLink": "/invoices/D02005YFHI/documents/statement",
"taxReceipts": [
{
"id": "123456",
"taxReceiptPdfDownloadLink": "/invoices/D02005YFHI/receipts/123456/documents/statement"
}
],
"invoiceDetails": [
{
"invoiceLineItemType": "billing_line_items",
"billingProvider": "office",
"links": {
"self": {
"uri": "/invoices/Recurring-D02005YFHI/lineitems/Office/BillingLineItems",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "InvoiceDetail"
}
}
],
"documentType": "invoice",
"invoiceType": "Recurring",
"links": {
"self": {
"uri": "/invoices/Recurring-D02005YFHI",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Invoice"
}
},
{
"id": "G000024130",
"invoiceDate": "2018-02-08T01:22:47.603895Z",
"totalCharges": 586366,
"paidAmount": 0,
"currencyCode": "CHF",
"currencySymbol": "CHF",
"pdfDownloadLink": "/invoices/G000024130/documents/statement",
"taxReceipts": [
{
"id": "234567",
"taxReceiptPdfDownloadLink": "/invoices/G000024130/receipts/234567/documents/statement"
}
],
"invoiceDetails": [
{
"invoiceLineItemType": "billing_line_items",
"billingProvider": "one_time",
"links": {
"self": {
"uri": "/invoices/OneTime-G000024130/lineitems/OneTime/BillingLineItems",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "InvoiceDetail"
}
}
],
"amendments": [
{
"id": "G000024131",
"invoiceDate": "2018-02-08T18:44:37.5381456Z",
"totalCharges": 107661.12,
"paidAmount": 0,
"currencyCode": "CHF",
"currencySymbol": "CHF",
"invoiceDetails": [
{
"invoiceLineItemType": "billing_line_items",
"billingProvider": "one_time",
"attributes": {
"objectType": "InvoiceDetail"
}
}
],
"documentType": "adjustment_note",
"amendsOf": "G000024130",
"invoiceType": "OneTime",
"attributes": {
"objectType": "Invoice"
}
}
],
"documentType": "void_note",
"invoiceType": "OneTime",
"links": {
"self": {
"uri": "/invoices/OneTime-G000024130",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Invoice"
}
}
],
"links": {
"self": {
"uri": "/invoices?size=2&offset=0",
"method": "GET",
"headers": []
},
"next": {
"uri": "/invoices?size=2&offset=2",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}