Recursos para faturação
Aplica-se a: Centro de Parceiros | Centro de Parceiros operado pela 21Vianet | Centro de Parceiros para a Nuvem Microsoft para o Governo dos EUA
Os seguintes recursos relacionados a faturas estão disponíveis por meio das APIs do Partner Center.
Fatura
| Propriedade | Tipo | Descrição |
|---|---|---|
| ID | String | O identificador da fatura. |
| data da fatura | string em formato de data-hora UTC | A data em que a fatura foi gerada. |
| faturamentoPeríodoStartDate | cadeia no formato de data-hora UTC | Data de início do período de faturação em UTC. |
| data de fim do período de faturação | string no formato de data e hora UTC | Data de término do período de faturamento em UTC. |
| encargos totais | número | Os encargos totais. Inclui encargos para transações e quaisquer ajustes. |
| valor pago | número | O valor pago pelo sócio. Negativo se um pagamento foi recebido. |
| código de moeda | string | Um código que indica a moeda usada para todos os valores e totais de itens da fatura. |
| símbolo de moeda | string | O símbolo de moeda usado para todos os valores e totais de itens da fatura. |
| pdfBaixarLink | string | Um link para descarregar a fatura em formato PDF. Esse link não é retornado como parte dos resultados da pesquisa e é preenchido somente se a fatura for acessada por ID. Este link expira automaticamente em 30 minutos. |
| detalhes da fatura | matriz de objetos InvoiceDetail | Os detalhes da fatura. |
| Alterações | matriz de objetos Invoice | As alterações a esta fatura. |
| Tipo de documento | string | O tipo de documento da fatura: "Nota de Crédito", "Fatura". |
| emendas de | string | O número de referência do documento de que o presente documento constitui uma alteração. |
| Tipo de fatura | string | O tipo de fatura: "recorrente", "one_time". |
| ligações | Ligações de Recursos | Os links de recursos. |
| atributos | ResourceAttributes | Os atributos de metadados. |
| coleção de resumos | matriz de objetos Recibo de Imposto | Obtém ou define o link de download do recibo de imposto. |
| Situação | string | Obtém o status da fatura, como "ativo", "nulo", etc. |
Detalhe da Fatura
Uma fatura contém uma coleção de itens faturados e cada item é representado por um recurso InvoiceDetail.
Item de Linha de Fatura
Cada cobrança individual dentro de uma fatura é representada como um InvoiceLineItem.
| Propriedade | Tipo | Descrição |
|---|---|---|
| invoiceLineItemType | cadeia de caracteres | O tipo de item de linha da fatura: "nenhum", "itens_de_linha_de_utilização", "itens_de_linha_de_faturamento". |
| billingProvider | string | O fornecedor de faturação: "Nenhum", "Office", "Azure", "OneTime". |
| atributos | AtributosDeRecurso | Os atributos de metadados. |
Resumo da fatura
Descreve um resumo do saldo e do total de encargos de uma fatura.
| Propriedade | Tipo | Descrição |
|---|---|---|
| valor do saldo | número | O saldo da fatura. Este é o valor total das contas não pagas. |
| código de moeda | string | Um código que indica a moeda usada para o valor do saldo. |
| símbolo da moeda | string | O símbolo de moeda usado. |
| contabilidadeData: | cadeia de caracteres no formato data-hora UTC | A data em que o valor do saldo foi atualizado pela última vez. |
| dataDeCriaçãoDaPrimeiraFatura | string em formato de data e hora UTC | A data em que a primeira fatura para o cliente foi criada. |
| dataDoÚltimoPagamento | string no formato data-hora do Tempo Universal Coordenado (UTC) | A data do último pagamento. |
| montante do último pagamento | número | O valor do último pagamento. |
| mais recenteData da fatura | string no formato de data e hora UTC | A data em que a última fatura do cliente foi criada. |
| detalhes | array de objetos InvoiceSummaryDetail | O detalhe do resumo da fatura. |
| ligações | Links de Recursos | Os links de recursos. |
| atributos | AtributosDeRecurso | Os atributos de metadados. |
FaturaResumoDetalhe
Representar um resumo dos detalhes individuais de um tipo de fatura (por exemplo, recorrente, one_time).
| Propriedade | Tipo | Descrição |
|---|---|---|
| Tipo de fatura | string | O tipo de fatura: "recorrente", "one_time". |
| Resumo | objeto InvoiceSummary | O resumo da fatura por tipo de fatura. |
Resumos de faturas
Represente uma coleção do tipo InvoiceSummary que contém os detalhes individuais de um tipo de fatura para cada moeda.
| Propriedade | Tipo | Descrição |
|---|---|---|
| coleçãoDeResumos | matriz de objetos InvoiceSummary | O resumo da fatura por tipo de fatura por moeda. |
ItemDeLinhaBaseadoEmLicença
Representa uma linha de cobrança na fatura para assinaturas baseadas em licença.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Montante | string | Obtém ou define o valor total. Montante total = preço unitário * quantidade. |
| atributos | string | Obtém os atributos. |
| billingCycleType | string | Obtém ou define o tipo de ciclo de faturamento. |
| billingProvider | string | Obtém o provedor de cobrança. |
| Data de Fim da Cobrança | string no formato data-hora UTC | Obtém ou define a data de término da cobrança. |
| dataDeInícioDaCobrança | string como formato de data-hora UTC | Obtém ou define a data de início da cobrança. |
| tipo de carga | string | Obtém ou define o tipo de cobrança. |
| moeda | string | Obtém ou define a moeda usada para esta linha de item. |
| ID do cliente | string | Obtém ou define o identificador exclusivo do cliente na plataforma de cobrança da Microsoft. |
| nome_do_cliente | cadeia no formato de data e hora UTC | Obtém ou define o nome do cliente. |
| nome_do_domínio | string | Obtém ou define o nome do domínio. |
| identificadorOfertaDurável | string | Obtém ou define o identificador único da oferta durável. |
| invoiceLineItemType | string | Obtém o tipo de item de linha da fatura. |
| ID do parceiro | número | Obtém ou define o ID do Parceiro associado a este item da linha. Para revendedores diretos, este é o PartnerID do revendedor. Para revendedores indiretos, este é o PartnerID do Revendedor de Valor Agregado (VAR). |
| offerId | sequência de caracteres | Obtém ou define o identificador único da oferta. |
| nomeOferta | string | Obtém ou define o nome da oferta. |
| ID do pedido | corda | Obtém ou define o identificador exclusivo do pedido. |
| ID do parceiro | string | Obtém ou define o ID de inquilino do Microsoft Entra do parceiro. |
| Quantidade | número | Obtém ou define o número de unidades associadas a este item de linha. |
| subscriçãoDescrição | string | Obtém ou define a descrição da assinatura. |
| data de fim da assinatura | cadeia de caracteres no formato data-hora UTC | Obtém ou define a data em que a assinatura expira. |
| ID de subscrição | string | Obtém ou define o identificador exclusivo da assinatura. |
| nome_da_assinatura | string | Obtém ou define o nome da assinatura. |
| data de início da assinatura | cadeia de caracteres no formato data-hora UTC | Obtém ou define a data de início da assinatura. |
| Subtotal | número | Obtém ou define o montante após o desconto. |
| NúmeroDeAssinaturaDoParceiroDeSindicação | string | Obtém ou define o número de assinatura do parceiro de distribuição. |
| imposto | número | Obtém ou define os impostos cobrados. |
| tier2MpnId | número | Obtém ou define o PartnerID do parceiro de Nível 2 associado a este item de linha. |
| totalParaCliente | número | Obtém ou define o valor total após desconto e imposto. |
| totalOutroDesconto | número | Obtém ou define o desconto associado a esta compra. |
| preço unitário | número | Obtém ou define o preço unitário. |
UsageBasedLineItem
Representa um item de linha de cobrança de fatura para assinaturas baseadas em uso.
| Propriedade | Tipo | Descrição |
|---|---|---|
| atributos | string | Obtém os atributos. |
| billingCycleType | string | Obtém ou define o tipo de ciclo de faturamento. |
| billingProvider | string | Obtém o provedor de cobrança. |
| chargeEndDate | string no formato de data e hora UTC | Obtém ou define a data de término da cobrança. |
| chargeStartDate | cadeia de texto no formato data-hora UTC | Obtém ou define a data de início da cobrança. |
| tipo de carga | string | Obtém ou define o tipo de cobrança. |
| quantidadeConsumida | número | Obtém ou define o total de unidades consumidas. |
| Desconto de Consumo | string | Obtém ou define o desconto no consumo. |
| consumoPreço | string | Obtém ou define o preço da quantidade consumida. |
| moeda | string | Obtém ou define a moeda associada aos preços. |
| nome_do_cliente | string | Obtém ou define o nome do cliente. |
| ID do cliente | cadeia de caracteres | Obtém ou define o identificador exclusivo do cliente. |
| Id do Item de Linha de Detalhe | número | Obtém ou define a ID do item de linha de detalhes. Identifica de forma única as linhas de itens para casos em que o cálculo difere para as unidades consumidas. Exemplo: Total consumido = 1338, 1024 é cobrado com uma taxa, 314 é cobrado com uma taxa diferente. |
| nome_do_domínio | string | Obtém ou define o nome do domínio. |
| quantidade incluída | número | Obtém ou define as unidades incluídas na ordem. |
| invoiceLineItemType | string | Obtém o tipo de linha de item da fatura. |
| Número da fatura | string | Obtém ou define o número da fatura. |
| preço de lista | número | Obtém ou define o preço de cada unidade. |
| ID do parceiro | número | Obtém ou define o ID do Parceiro associado a este item de linha. Para revendedores diretos, este é o PartnerID do revendedor. Para revendedores indiretos, este é o PartnerID do Revendedor de Valor Agregado (VAR). |
| ID do pedido | string | Obtém ou define o identificador exclusivo do pedido. |
| quantidadeExcedente | número | Obtém ou define a quantidade consumida acima do uso permitido. |
| ID da Conta Faturável do Parceiro | string | Obtém ou define o identificador da conta faturável do parceiro. |
| ID do parceiro | string | Obtém ou define o ID do locatário do parceiro Microsoft Entra. |
| Nome do parceiro | string | Obtém ou define o nome do parceiro. |
| taxaEfetivaPósImpostos | número | Obtém ou define o preço efetivo após impostos. |
| totalPósImposto | número | Obtém ou define o total de cobranças após impostos. Encargos antes de impostos + Valor do imposto |
| encargos antes de impostos | número | Obtém ou define o preço cobrado antes de impostos. |
| préTaxEffectiveRate | número | Obtém ou define o preço efetivo antes de impostos. |
| região | cadeia de caracteres | Obtém ou define a região associada à instância do recurso. |
| identificadorDeRecurso | string | Obtém ou define o identificador de recurso. |
| nome_do_recurso | string | Obtém ou define o nome do recurso. Exemplo: Banco de dados (GB/mês). |
| nome_do_serviço | string | Obtém ou define o nome do serviço. Exemplo: Azure Data Service. |
| Tipo de serviço | string | Obtém ou define o tipo de serviço. Exemplo: Azure SQL Azure DB. |
| SKU | string | Obtém ou define a SKU de serviço. |
| subscriçãoDescrição | string | Obtém ou define a descrição da assinatura. |
| ID de subscrição | string | Obtém ou define o identificador exclusivo da assinatura. |
| nome_da_assinatura | string | Obtém ou define o nome da assinatura. |
| valor do imposto | número | Obtém ou define o valor do imposto cobrado. |
| tier2MpnId | número | Obtém ou define o PartnerID do parceiro de Nível 2 associado a este item de linha. |
| unidade | string | Obtém ou define a unidade de medida para uso do Azure. |
Extrato de Fatura
Representa as operações disponíveis num extrato de fatura em aplicação/pdf.
| Propriedade | Tipo | Descrição |
|---|---|---|
| httpResponseMessage | objeto | ByteArrayContent com tipo de conteúdo = application/pdf. |
ItemDeLinhaDeFaturaÚnica
Representa uma linha de cobrança numa fatura para subscrições baseadas em licença.
| Propriedade | Tipo | Descrição |
|---|---|---|
| ID do parceiro | string | Obtém ou define a ID do locatário parceiro. |
| ID do Cliente | string | Obtém ou define a ID do locatário do cliente. |
| Nome do Cliente | string | Obtém ou define o nome do cliente. |
| NomeDeDomínioDoCliente | string | Obtém ou define o nome de domínio do cliente. |
| País do Cliente | string | Obtém ou define o país/região do cliente. |
| Número da fatura | string | Obtém ou define o número da fatura. |
| MpnId | string | Obtém ou define o ID do Parceiro associado a este item de linha. |
| RevendedorMpnId | Int | Obtém ou define o PartnerID do parceiro de Nível 2 associado a este item de linha. |
| Data da encomenda | Data e Hora | Obtém ou define a data em que a ordem foi criada. |
| OrderId | string | Identificador exclusivo de uma encomenda na plataforma de faturação da Microsoft. |
| ID do Produto | string | Obtém ou define o identificador exclusivo do produto. |
| SkuId | string | Obtém ou define o identificador exclusivo de SKU. |
| IdDisponibilidade | string | Obtém ou define o identificador exclusivo de disponibilidade. |
| Nome do Produto | string | Obtém ou define o nome do produto. |
| Nome do SKU | string | Obtém ou define o nome da SKU. |
| Tipo de Carga | string | Obtém ou define o tipo de cobrança. |
| Preço unitário | decimais | Obtém ou define o preço unitário. |
| Preço Unitário Eficaz | decimais | Obtém ou define o preço unitário efetivo. |
| Tipo de Unidade | string | Obtém ou define o tipo de unidade. |
| Quantidade | Int | Obtém ou define o número de unidades associadas a este item de linha. |
| Subtotal | decimais | Obtém ou define o valor após o desconto. |
| Total de Impostos | decimais | Obtém ou define os impostos cobrados. |
| TotalForCustomer | decimais | Obtém ou define o valor total após desconto e imposto. |
| Moeda | string | Obtém ou define a moeda usada para esta linha de item. |
| Nome do editor | string | Obtém ou define o nome da editora associado a esta compra. |
| PublisherId | sequência de caracteres | Obtém ou define o ID do editor associado a esta compra. |
| SubscriçãoDescrição | string | Obtém ou define a descrição da subscrição associada a esta compra. |
| ID de Subscrição | string | Obtém ou define o ID de subscrição associado a esta compra. |
| DataDeInícioDeCobrança | Data e Hora | Obtém ou define a data de início da cobrança associada a esta compra. |
| ChargeEndDate | Data e Hora | Obtém ou define a data de término da cobrança associada a esta compra. |
| Período e Ciclo de Cobrança | string | Obtém ou define o prazo e o ciclo de faturamento associados a essa compra. |
| AlternateId | string | Obtém ou define o ID alternativo (ID da citação). |
| Ajuste de Preço Descrição | string | Obtém ou define a descrição do ajuste de preço. |
| CódigoMotivoCrédito | string | Obtém ou define o código de motivo de crédito. |
| DescontoDetalhes | string | Preterido. Obtém ou define os detalhes do desconto associados a esta compra. |
| PreçoMoeda | string | Obtém ou define o código de moeda de fixação de preço. |
| PCToBCExchangeRate | decimais | Obtém ou define a moeda de precificação para a taxa de câmbio da moeda faturada. |
| PCToBCExchangeRateDate | Data/Hora | Define ou obtenha a data em que a taxa de câmbio da moeda de fixação de preços para a moeda de faturação foi determinada. |
| Quantidade Faturável | decimais | Obtém ou configura as unidades compradas. Para cada coluna de design denominada BillableQuantity. |
| Descrição do Medidor | string | Obtém ou define a descrição do medidor para o item de linha de consumo. |
| IdentificadorDePedidoDeReserva | string | Obtém ou define o identificador de ordem de reserva para uma Compra do Azure RI. |
| Frequência de Faturação | string | Obtém ou define a frequência de faturamento. |
| TipoDeItemDaLinhaDeFatura | TipoDeItemDeLinhaDeFatura | Retorna o tipo de item de linha da fatura. |
| BillingProvider | BillingProvider | Devolve o fornecedor de faturação. |
| Qualificadores de Produto | string | O identificador para saber as compras de complementos ou testes. |
| PromotionId | cadeia de caracteres | O identificador para recuperar informações de promoção. |
LinhaDeUsoDiárioClassificado
Representa itens de linha de reconciliação não faturados e faturados para utilização diária tarifada.
| Propriedade | Tipo | Descrição |
|---|---|---|
| Identificação do parceiro | string | Obtém ou define a ID do locatário parceiro. |
| Nome do parceiro | string | Obtém ou define o nome do parceiro. |
| ID do Cliente | fio | Obtém ou define o identificador do inquilino do cliente a que o uso pertence. |
| Nome do Cliente | string | Obtém ou define o nome da empresa cliente à qual o uso pertence. |
| NomeDeDomínioDoCliente | string | Obtém ou define o nome de domínio do cliente ao qual o uso pertence. |
| Número da fatura | string | Obtém ou define a ID da fatura à qual o uso pertence. |
| ProdutoId | string | Obtém ou define o identificador exclusivo do produto. |
| SkuId | string | Obtém ou define o identificador exclusivo de SKU. |
| Id de Disponibilidade | string | Obtém ou define o identificador exclusivo de disponibilidade. |
| SkuName | string | Obtém ou define o nome da SKU para o serviço. |
| Nome do Produto | string | Obtém ou define o nome do produto. |
| Nome do Editor | string | Obtém ou define o nome do(a) editor(a). |
| Identificador de Publicador | string | Obtém ou define o ID do editor. |
| SubscriptionId | string | Obtém ou define a ID da assinatura. |
| SubscriçãoDescrição | cadeia de caracteres | Obtém ou define a descrição da assinatura. |
| Data de Início da Cobrança | Data/Hora | Obtém ou define a data de início da cobrança. |
| ChargeEndDate | Data e Hora | Obtém ou define a data de término da cobrança. |
| Data de Utilização | Data/Hora | Obtém ou define a data de uso. |
| Tipo de Medidor | string | Obtém ou define o tipo de medidor. |
| Categoria de Medidor | string | Obtém ou define a categoria do medidor. |
| MeterId | cadeia de caracteres | Obtém ou define o ID do medidor (GUID). |
| Subcategoria do Medidor | string | Obtém ou define a subcategoria do medidor. |
| Nome do Medidor | string | Obtém ou define o nome do medidor. |
| MeterRegion | string | Obtém ou define a região do medidor. |
| Unidade de Medida | cadeia de caracteres | Obtém ou define a unidade de medida. |
| LocalizaçãoDoRecurso | string | Obtém ou define o local do recurso. |
| Serviço Consumido | cadeia de caracteres | Obtém ou define o nome do serviço consumido. |
| Grupo de Recursos | string | Obtém ou define o nome do grupo de recursos. |
| ResourceUri | string | Obtém ou define o uri da instância de recurso sobre a qual o uso se refere. |
| Etiquetas | sequência de caracteres | Obtém ou define as etiquetas adicionadas pelo cliente. |
| Informações adicionais | string | Obtém ou define os metadados específicos do serviço. Por exemplo, um tipo de imagem para uma máquina virtual. |
| ServiçoInfo1 | corda | Obtém ou define metadados internos do Serviço do Azure. |
| ServiceInfo2 | string | Obtém ou define informações de serviço, por exemplo, um tipo de imagem para uma máquina virtual e um nome de ISP para a Rota Expressa. |
| País do Cliente | string | Obtém ou define o país/região do cliente. |
| MpnId | string | Obtém ou define o ID de Parceiro associado a este item de linha. |
| RevendedorMpnId | string | Obtém ou define o Reseller PartnerID do parceiro de Nível 2 associado a este item de linha. |
| Tipo de Carga | string | Obtém ou define o tipo de cobrança. |
| Preço unitário | decimais | Obtém ou define o preço da unidade. |
| Quantidade | decimais | Obtém ou define a quantidade de uso. |
| Tipo de Unidade | string | Obtém ou define o tipo de unidade (como 1 hora). |
| FaturamentoPreTaxTotal | decimais | Obtém ou define o custo estendido ou o custo total antes de impostos na moeda local do cliente ou na moeda de cobrança. |
| Moeda de Faturação | string | Obtém ou define a moeda ISO na qual o medidor é cobrado na moeda local do cliente ou na moeda de cobrança. |
| PreçosAntesDeImpostosTotal | decimais | Obtém ou define o custo estendido ou o custo total antes de impostos em USD ou na moeda do catálogo usada para avaliação. |
| PreçoMoeda | string | Obtém ou define a moeda ISO na qual o medidor é cobrado, podendo ser em USD ou na moeda do catálogo utilizada para tarifação. |
| IdDeDireito | string | Obtém ou define a ID de subscrição (assinatura do Azure). |
| Descrição de Direitos | string | Obtém ou define a descrição dos direitos (assinatura do Azure). |
| PCToBCExchangeRate | string | Obtém ou define a taxa de câmbio entre a moeda de preço e a moeda de cobrança. |
| PCToBCExchangeRateDate | Data/Hora | Obtém ou define a data da taxa de câmbio entre a moeda de preço e a moeda de cobrança. |
| EffectiveUnitPrice | decimais | Obtém ou define o preço unitário efetivo. |
| TaxaDeCréditoGanhoDoParceiro | decimais | Obtém ou define a taxa de crédito ganho pelo parceiro. |
| ParceiroGanhouCrédito | Bool | Obtém ou define se o crédito ganho pelo parceiro é aplicado. |
| Taxa de Crédito | decimais | Obtém ou define a taxa de crédito para determinado tipo de crédito. |
| Tipo de Crédito | string | Obtém ou define o tipo de crédito. |
| TipoDeItemDeLinhaDeFatura | TipoDeItemDeLinhaDeFatura | Retorna o tipo de item de linha da fatura. |
| BillingProvider | BillingProvider | Devolve o fornecedor de faturação. |