Visão geral dos dados de faturamento #
O recurso Faturamento fornece acesso para baixar faturas e dados de faturamento de ~.Dimensions.~.
/{VERSÃO}/dados de cobrança
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 |
|---|---|---|---|
| ID do locatário | O ID da conta de revendedor pai | corda | Todo |
| ID da fatura | Um número exclusivo para identificar uma fatura específica | corda | Todo |
| Número da fatura | O número da fatura exibido no PDF fatura | corda | Todo |
| nome da conta | O nome da empresa para a conta de revendedor pai | corda | Todo |
| BillingPeriodStart | A data de início do período de cobrança | corda | Todo |
| faturamentoperíodofinal | A data em que termina o período de cobrança | corda | Todo |
| valor da fatura | O valor total da fatura | dobrar | Todo |
| invoiceitems | Uma coleção de itens de fatura | array(Item da fatura | Obter detalhes da fatura Somente |
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 pai | corda |
| quantidade | A quantidade usada | dobrar |
| valor | O custo do item | dobrar |
| data de encontro | A data a partir da qual o item está sendo cobrado | corda |
| até o momento | A data a partir da qual o item está sendo faturado | corda |
| de cálculode ordem | 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 | dobrar |
| producttagname | O nome do recurso/produto para o qual o Item da Fatura se destina. Isso estará no formato '{PRODUCT_NAME} #{PART_NUMBER}' | corda |
| faturamentosaídatags | Indicação se o Item da Fatura é para uma compra ou é um campo de resumo | array(cadeia de caracteres) |
| stringvalues | Fornece informações sobre o cliente e o usuário final para o qual a compra se destina | KeyValuePair< string,string> |
| numericvalues | Fornece informações sobre o cliente e o usuário final para o qual a compra se destina | KeyValuePair< corda, duplo> |
Operadores de item de fatura #
O operador de cada item indica como o item está sendo aplicado à fatura. ResultadoDeCompra 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 a itens anteriores, como imposto sobre vendas.
| Itens | 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 |
| AJUSTARPORPORCENTAGEM | Indica que o Item da Fatura está mostrando um ajuste percentual na SUM, isso geralmente indica que o IVA está sendo aplicado |
Itens de tag de saída de faturamento #
As tags de saída de faturamento são usadas para indicar se a entrada de dados está relacionada a uma compra ou se é uma entrada de resumo que fornece informações sobre toda a fatura.
| Itens | Descrição |
|---|---|
| Resultado da compra | Indica que o Item da Fatura é uma compra passível de cobrança |
| Resumo | Indica que o Item da Fatura é um resumo das compras, fornecendo informações sobre o total da fatura. Quando sozinho, sem as tags "TotalVAT" ou "TotalInclVAT", ele indica o total da fatura antes da adição do IVA. |
| TotalInclVAT | Indica que o Item da Fatura está mostrando o total da fatura, incluindo qualquer IVA aplicável |
| TotalIVA | Indica que o Item da Fatura está mostrando o IVA total aplicável à 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 | |
|---|---|---|
| Código do locatário1 | A ID do locatário do cliente | |
| TenantCodeext1 | A referência do revendedor para o cliente | |
| Nome do locatário1 | O nome do cliente | corda |
| Código de revendedor | O ID de locatário do revendedor | |
| ResellerCodeExt2 | A referência estendida para o revendedor | |
| RevendedorName | O nome do revendedor | |
| ID do usuário | O id do usuário | |
| Nome de usuário | O nome de usuário do usuário | |
| papel | 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 | Retorna uma coleção de todas as faturas. |
| Obter fatura | Retorna os detalhes de uma fatura específica. |
| Obter detalhes da fatura | Devoluções JSON & CSV saída de dados de uma fatura específica em um arquivo ZIP. |
| Obter resumo da fatura | Retorna 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. Isso pode ser atualizado conforme necessário por meio do Portal Empresarial ou por meio do Cliente API, para permitir a vinculação de registros de revendedor a sistemas externos. ↩︎