Dados de faturamento JSON #
As informações abaixo fornecem detalhes do JSON dados fornecidos ao baixar os dados de uma fatura específica. O JSON Os dados fornecem o nível mais granular de informações, incluindo entradas para cada licença de usuário usada e entradas de resumo que fornecem informações sobre os totais da fatura e os impostos aplicáveis.
Esquema de detalhes da fatura #
O principal JSON fornece detalhes sobre o número, o período e a data da fatura. Ele também contém uma matriz de itens de fatura individuais relacionados a cada licença que está sendo faturada.
| Chave | Descrição | Tipo |
|---|---|---|
| ID do locatário | O ID da conta de revendedor pai | corda |
| ID da fatura | Um número exclusivo para identificar uma fatura específica | corda |
| Número da fatura | O número da fatura exibido no PDF fatura | corda |
| nome da conta | O nome da empresa para a conta de revendedor pai | corda |
| BillingPeriodStart | A data de início do período de cobrança | corda |
| faturamentoperíodofinal | A data em que termina o período de cobrança | corda |
| valor da fatura | O valor total da fatura | dobrar |
| invoiceitems | Uma coleção de itens de fatura | array(Item da fatura) |
JSON Esquema de item de fatura #
Cada entrada de item da fatura no JSON Os dados de faturamento fornecem os parâmetros listados abaixo. Eles se referem a um uso individual por um usuário com os intervalos de datas aplicáveis.
| Chave | Descrição | Tipo |
|---|---|---|
| id | Um ID exclusivo para a compra individual | corda |
| quantidade1 | 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ário2 | A ID do locatário do revendedor | |
| TenantCodeext2 | A referência do revendedor para o revendedor | |
| Nome do locatário2 | O nome do revendedor | corda |
| Código de revendedor | O ID de locatário do revendedor | |
| Código de revendedorExt | 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 |
Exemplo JSON Saída #
{
"tenantId": "00000000-0000-0000-0000-123456789123",
"invoiceId": "00000000000000000000000a",
"númeroDaFatura": "9000004",
"accountName": "Exemplo de locatário 1",
"billingPeriodStart": "2020-04-01T00:00:00.0000000",
"billingPeriodEnd": "2020-04-30T23:59:59.0000000",
"dataDafatura": "2020-04-09T00:00:00.0000000",
"invoiceValue": 17,50,
"invoiceItems": \[
{
"id": "000000000000000000000001",
"quantidade": 1,0,
"valor": 1,25,
"fromDate": "2020-04-01T00:00:00.000+00:00",
"toDate": "2020-04-30T23:59:59.000+00:00",
"calculationOrder": 1,
"operatorUsed": "PREÇO",
"operatorValueUsed": 1,25,
"productTagName": "#XDM00001 essencial do usuário",
"billingOutputTags": ["PurchaseResult"][ "PurchaseResult" ],
"stringValues": [
{
"name": "Função",
"valor": "cliente.usuário.pbx"
},
{
"name": "Código do Revendedor",
"valor": "00000000-0000-0000-0000-0000000000222"
},
{
"name": "ResellerCodeExt",
"valor": "revendedor ref 1"
},
{
"name": "ResellerName",
"value": "Revendedor ABC"
},
{
"name": "Código do inquilino",
"valor": "00000000-0000-0000-0000-0000000000111"
},
{
"nome": "TenantCodeExt",
"valor": "referência personalizada 1"
},
{
"name": "Nome do inquilino",
"value": "Exemplo de cliente 1"
},
{
"nome": "ID do usuário",
"valor": "00000000-0000-0000-0000-000000000001"
},
{
"name": "Nome de usuário",
"valor": "[email protected]"
}
][
{
"name": "Role",
"value": "customer.user.pbx"
},
{
"name": "ResellerCode",
"value": "00000000-0000-0000-0000-000000000222"
},
{
"name": "ResellerCodeExt",
"value": "reseller ref 1"
},
{
"name": "ResellerName",
"value": "ABC Reseller"
},
{
"name": "TenantCode",
"value": "00000000-0000-0000-0000-000000000111"
},
{
"name": "TenantCodeExt",
"value": "custom ref 1"
},
{
"name": "TenantName",
"value": "Example Customer 1"
},
{
"name": "UserId",
"value": "00000000-0000-0000-0000-000000000001"
},
{
"name": "UserName",
"value": "[email protected]"
}
],
"numericValues": [
{
"nome": "customer_licence_count",
"valor": 1
}
][
{
"name": "customer_licence_count",
"value": 1
}
]
},
{
"id": "000000000000000000000003",
"quantidade": 1,0,
"valor": 15,0,
"fromDate": "2020-04-01T00:00:00.000+00:00",
"toDate": "2020-04-30T23:59:59.000+00:00",
"calculationOrder": 3,
"operatorUsed": "PREÇO",
"operatorValueUsed": 15,00,
"productTagName": "Supervisor em tempo real #XDM00010",
"billingOutputTags": ["PurchaseResult"][ "PurchaseResult" ],
"stringValues": [
{
"name": "Função",
"valor": "cliente.usuário.supervisorl2"
},
{
"name": "Código do Revendedor",
"valor": "00000000-0000-0000-0000-0000000000222"
},
{
"name": "ResellerCodeExt",
"valor": "revendedor ref 1"
},
{
"name": "ResellerName",
"value": "Revendedor ABC"
},
{
"name": "Código do inquilino",
"valor": "00000000-0000-0000-0000-0000000000111"
},
{
"nome": "TenantCodeExt",
"valor": "referência personalizada 1"
},
{
"name": "Nome do inquilino",
"value": "Exemplo de cliente 1"
},
{
"nome": "ID do usuário",
"valor": "00000000-0000-0000-0000-000000000001"
},
{
"name": "Nome de usuário",
"valor": "[email protected]"
}
][
{
"name": "Role",
"value": "customer.user.supervisorl2"
},
{
"name": "ResellerCode",
"value": "00000000-0000-0000-0000-000000000222"
},
{
"name": "ResellerCodeExt",
"value": "reseller ref 1"
},
{
"name": "ResellerName",
"value": "ABC Reseller"
},
{
"name": "TenantCode",
"value": "00000000-0000-0000-0000-000000000111"
},
{
"name": "TenantCodeExt",
"value": "custom ref 1"
},
{
"name": "TenantName",
"value": "Example Customer 1"
},
{
"name": "UserId",
"value": "00000000-0000-0000-0000-000000000001"
},
{
"name": "UserName",
"value": "[email protected]"
}
],
"numericValues": [
{
"nome": "customer_licence_count",
"valor": 1
}
][
{
"name": "customer_licence_count",
"value": 1
}
]
},
{
"id": "000000000000000000000004",
"quantidade": 3.0,
"valor": 17,50,
"fromDate": "2020-04-01T00:00:00.000+00:00",
"toDate": "2020-04-30T23:59:59.000+00:00",
"calculationOrder": 4,
"operatorUsed": "SUM",
"operatorValueUsed": 0.0,
"productTagName": "Todos os produtos",
"billingOutputTags": ["Resumo", "Total", "GL", "GL_Entry:0000; crédito;"][ "Summary", "Total", "GL", "GL_Entry:0000;credit;" ],
"stringValues": [][ ]
},
{
"id": "000000000000000000000005",
"quantidade": 3.0,
"valor": 17,50,
"fromDate": "2020-04-01T00:00:00.000+00:00",
"toDate": "2020-04-30T23:59:59.000+00:00",
"calculationOrder": 5,
"operatorUsed": "ADJUSTPERCENTAGE",
"operatorValueUsed": 0.0,
"productTagName": "Todos os produtos",
"billingOutputTags": ["TotalInclVAT", "Resumo", "GL_Balance", "GL_Entry:2222; debitar; Devedores"][ "TotalInclVAT", "Summary", "GL_Balance", "GL_Entry:2222;debit;Debtors" ],
"stringValues": [][ ]
},
{
"id": "000000000000000000000006",
"quantidade": 345,0,
"valor": 0,0,
"fromDate": "2020-04-01T00:00:00.000+00:00",
"toDate": "2020-04-30T23:59:59.000+00:00",
"calculationOrder": 6,
"operatorUsed": "ADJUSTPERCENTAGE",
"operatorValueUsed": 0.0,
"productTagName": "Todos os produtos",
"billingOutputTags": ["TotalIVA", "Resumo", "GL_VAT", "IVA:S", "GL_Entry:1111; crédito; IVA"][ "TotalVAT", "Summary", "GL_VAT", "VAT:S", "GL_Entry:1111;credit;VAT" ],
"stringValues": [][ ]
}
],
"tipofatura": 0
}