Visão geral dos dados de faturamento #
O recurso de faturamento fornece acesso para baixar faturas e dados de faturamento de ~.Dimensions.~.
/{VERSÃO}/billingdata
Esquema de detalhes da fatura #
Os clientes representam um locatário no sistema ao qual os usuários finais podem ser atribuídos por meio do API.
| Chave | Descrição | Tipo | Disponibilidade |
|---|---|---|---|
| inquilino | O id da conta de revendedor principal | string | Tudo |
| ID da fatura | Um número exclusivo para identificar uma fatura específica | string | Tudo |
| Número da fatura | O número da fatura exibido no PDF fatura | string | Tudo |
| nome da conta | O nome da empresa para a conta de revendedor principal | string | Tudo |
| BillingPeriodStart | A data de início do período de faturação | string | Tudo |
| billingperiodend | A data de término do período de faturamento | string | Tudo |
| valor da fatura | O valor total da fatura | duplo | Tudo |
| itens da fatura | Uma coleção de itens de fatura | array(Item da fatura | Obter detalhes da fatura Apenas |
Esquema de item de fatura #
Cada entrada nos dados de faturamento fornece os parâmetros listados abaixo.
| Chave | Descrição | Tipo |
|---|---|---|
| ID | O id da conta de revendedor principal | string |
| Quantidade | A quantidade utilizada | duplo |
| valor | O custo do item | duplo |
| a partir da data | A data a partir da qual o item está sendo cobrado | string |
| até à data | A data a partir da qual o item está sendo cobrado para | string |
| ordem de cálculo | Número sequencial que indica a ordem em que os itens da fatura devem ser processados | Int |
| UsuárioUsado | Indica como o valor do item da fatura está sendo aplicado à fatura | Operador de item de fatura |
| operatorvalueused | Indica o valor do operador ADJUSTPERCENTAGE | duplo |
| producttagname | O nome do recurso/produto para o qual o Item de Fatura se destina. Este será no formato '{PRODUCT_NAME} #{PART_NUMBER}' | string |
| billingoutputtags | Indicação se o Item da Fatura é para uma compra ou é um campo de resumo | matriz(string) |
| stringvalues | Fornece informações sobre o cliente e o usuário final para o qual a compra se destina | KeyValuePair< string,string> |
| valores numéricos | Fornece informações sobre o cliente e o usuário final para o qual a compra se destina | KeyValuePair< string, duplo> |
Operadores de item de fatura #
O operador de cada item indica como o item está sendo aplicado à fatura. PurchaseResult terá um PREÇO para identificar o custo do item. Os itens com outras tags de saída indicarão se estão somando o valor da fatura ou aplicando um valor percentual aos itens anteriores, como o imposto sobre vendas.
| Rubricas | Descrição |
|---|---|
| PREÇO | Indica que o item da fatura está mostrando o preço unitário de um item |
| SOMA | Indica que o Item da Fatura está mostrando um total de vários itens |
| PERCENTAGEM DE AJUSTAMENTO | Indica que o item da fatura está mostrando um ajuste percentual para a SOMA, isso geralmente indica que o IVA está sendo aplicado |
Itens de etiqueta de saída de faturamento #
As etiquetas de saída de faturação são utilizadas para indicar se a entrada de dados está relacionada com uma compra ou se é uma entrada resumida que fornece informações sobre toda a fatura.
| Rubricas | Descrição |
|---|---|
| CompraResultado | Indica que o item da fatura é uma compra exigível |
| Resumo | Indica que o Item da Fatura é um resumo das compras, fornecendo informações sobre o total da fatura. Quando por si só sem as etiquetas 'TotalVAT' ou 'TotalInclVAT', indica o total da fatura antes de o IVA ser adicionado. |
| TotalInclIVA | Indica que o item da fatura está mostrando o total da fatura, incluindo qualquer IVA aplicável |
| IVA total | Indica que o Item da Fatura está mostrando o IVA total aplicável para a fatura |
Itens de valor de cadeia de caracteres #
Os itens de valor de cadeia de caracteres fornecem informações específicas para o cliente e o usuário final do item comprado.
| Chave | Descrição | |
|---|---|---|
| TenantCode1 | O ID do locatário do cliente | |
| TenantCodeext1 | A referência do revendedor para o cliente | |
| TenantName1 | O nome do cliente | string |
| Código do revendedor | ID do locatário do revendedor | |
| ResellerCodeExt2 | A referência estendida para o revendedor | |
| Nome do Revendedor | O nome do revendedor | |
| Id do usuário | O id do usuário | |
| Nome de utilizador | O nome de usuário do usuário | |
| Função | A chave de função para o item faturado |
Itens de valor numérico #
Os itens de valor numérico fornecem informações específicas para o cliente e usuário final do item comprado.
| Chave | Descrição |
|---|---|
| customer_licence_count | O número total dessas licenças que o cliente tem |
Interfaces disponíveis #
| Interface | Descrição |
|---|---|
| Obter tudo | Devolve uma coleção de todas as faturas. |
| Obter fatura | Devolve os detalhes de uma fatura específica. |
| Obter detalhes da fatura | Devoluções JSON e CSV saída de dados de uma fatura específica em um arquivo ZIP. |
| Obter resumo da fatura | Devolve o PDF saída de dados de uma fatura específica. |
-
Os campos 'TenantCode', 'TenantCodeExt' e 'TenantName' são preenchidos com informações sobre a conta do cliente. ↩︎
-
O ResellerCodeExt será preenchido com o número de referência que foi configurado em relação ao revendedor. Isto pode ser atualizado conforme necessário através do Portal Empresarial ou através do Cliente API, para permitir a vinculação de registros de revendedor a sistemas externos. ↩︎