Obter o demonstrativo de recebimento da faturaGet invoice receipt statement

Aplica-se aApplies To

  • Partner CenterPartner Center

Recupera uma instrução de recebimento de nota fiscal usando a ID da nota fiscal e a ID do recibo.Retrieves an invoice receipt statement using invoice ID and the receipt ID.

Importante

Esse recurso só é aplicável a confirmações de impostos de Taiwan.This feature is only applicable to Taiwan tax receipts.

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Este cenário dá suporte somente à autenticação com credenciais de aplicativo + de usuário.This scenario supports authentication with App+User credentials only.

  • Uma ID de fatura válida e uma ID de recebimento correspondente.A valid Invoice ID and a corresponding receipt ID.

C#C#

Para obter uma instrução de recebimento de fatura por ID, começando com o SDK do Partner Center v 1.12.0, use sua coleção IPartner. faturas e chame o método ById () usando a ID da nota fiscal e, em seguida, chame a coleção confirmações e chame ById () e chame os métodos Documents () e Statement () para acessar a instrução de recebimento de nota fiscal.To get an invoice receipt statement by ID, starting with Partner Center SDK v1.12.0, use your IPartner.Invoices collection and call the ById() method using the invoice ID, then call the Receipts collection and call ById() then call the Documents() and Statement() methods to access the invoice receipt statement. Por fim, chame os métodos Get () ou getasync () .Finally, call the Get() or GetAsync() methods.

// IPartner scopedPartnerOperations;
// string selectedInvoiceId;

var invoiceStatement = scopedPartnerOperations.Invoices.ById(selectedInvoiceId).Receipts.ById(selectedReceipt).Documents.Statement.Get();

Exemplo: aplicativo de teste do console.Sample: Console test app. Projeto: classePartnerSDK. FeatureSample: GetInvoiceReceiptStatement.csProject: PartnerSDK.FeatureSample Class: GetInvoiceReceiptStatement.cs

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET {baseURL}/v1/invoices/{Invoice-ID}/Receipts/{Receipt-ID}/Documents/Statement http/1.1{baseURL}/v1/invoices/{invoice-id}/receipts/{receipt-id}/documents/statement HTTP/1.1

Parâmetro do URIURI parameter

Use o parâmetro de consulta a seguir para obter a instrução de recebimento de nota fiscal.Use the following query parameter to get the invoice receipt statement.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
ID da faturainvoice-id stringstring SimYes O valor é uma ID de nota fiscal que permite ao revendedor filtrar os resultados de uma determinada fatura.The value is an invoice-id that allows the reseller to filter the results for a given invoice.
ID de recebimentoreceipt-id stringstring SimYes O valor é uma ID de recebimento que permite que o revendedor filtre os recibos de uma determinada fatura.The value is a receipt-id that allows the reseller to filter the receipts for a given invoice.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

NenhumNone

Exemplo de solicitaçãoRequest example

GET https://api.partnercenter.microsoft.com/v1/invoices/<invoice-id>/receipts/<receipt-id>/documents/statement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 8ac25aa5-9537-4b6d-b782-aa0c8e979e99
MS-CorrelationId: 57eb2ca7-755f-450f-9187-eae1e75a0114

Resposta RESTREST response

Se for bem-sucedido, esse método retornará um fluxo em PDF no corpo da resposta.If successful, this method returns a pdf stream in the response body.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de Erro.For the full list, see Error Codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 195556
Content-Type: application/pdf
MS-CorrelationId: a1d6ab41-5a30-4643-898b-b30d65d3a0a1
MS-RequestId: cc1ba6db-ab26-404a-9196-712b6395f518
Date: Tue, 05 Feb 2019 04:08:23 GMT

{
    _content    {System.Net.Http.ByteArrayContent}    System.Net.Http.HttpContent {System.Net.Http.ByteArrayContent}
    _content    {byte[195556]}    byte[]
    _headers    {Content-Type: application/pdf Content-Disposition: attachment; filename=E-Tax-8602768.pdf}
}