Obter detalhes da fatura #
Obtenha um detalhamento detalhado de todos os itens que estão sendo faturados para uma fatura específica. Um arquivo ZIP é retornado a partir desta consulta que contém um JSON e um arquivo simplificado CSV arquivo. Cada arquivo contém um registro de cada transação na fatura.
GET /v1.0/billingdata/{INVOICE_ID}/detail
Exemplo #
Essa solicitação recuperará um detalhamento de itens para uma ID de fatura específica.
Solicitar #
GET /api/v1.0/billingdata/{INVOICE_ID}/detalhe HTTP/1.1
Autorização: Portador {TOKEN}Resposta #
HTTP/1.1 200 OK
Tipo de conteúdo: aplicação/fluxo de octeto; charset=utf-8
Conteúdo-Comprimento: xx
{
"status": "sucesso",
"carimbo de data/hora": "2019-01-01T10:00:00.2890319Z"
}Exemplo JSON Dados #
{
"tenantId": "00000000-0000-0000-0000-123456789123",
"invoiceId": "00000000000000000000000a",
"Número da fatura": "9000004",
"accountName": "Exemplo de Inquilino 1",
"billingPeriodStart": "2020-04-01T00:00:00.0000000",
"billingPeriodEnd": "2020-04-30T23:59:59.0000000",
"invoiceDate": "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,
"operadorUsado": "PREÇO",
"operatorValueUsed": 1.25,
"productTagName": "Utilizador Essencial #XDM00001",
"billingOutputTags": ["PurchaseResult"][ "PurchaseResult" ],
"stringValues": [
{
"nome": "Função",
"valor": "customer.user.pbx"
},
{
"nome": "ResellerCode",
"valor": "00000000-0000-0000-0000-000000000222"
},
{
"nome": "ResellerCodeExt",
"valor": "revendedor ref 1"
},
{
"nome": "ResellerName",
"valor": "Revendedor ABC"
},
{
"nome": "TenantCode",
"valor": "00000000-0000-0000-0000-000000000111"
},
{
"nome": "TenantCodeExt",
"valor": "ref personalizado 1"
},
{
"nome": "TenantName",
"value": "Cliente de exemplo 1"
},
{
"nome": "UserId",
"valor": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "Nome de Utilizador",
"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,
"operadorUsado": "PREÇO",
"operatorValueUsed": 15,00,
"productTagName": "Supervisor em Tempo Real #XDM00010",
"billingOutputTags": ["PurchaseResult"][ "PurchaseResult" ],
"stringValues": [
{
"nome": "Função",
"valor": "customer.user.supervisorl2"
},
{
"nome": "ResellerCode",
"valor": "00000000-0000-0000-0000-000000000222"
},
{
"nome": "ResellerCodeExt",
"valor": "revendedor ref 1"
},
{
"nome": "ResellerName",
"valor": "Revendedor ABC"
},
{
"nome": "TenantCode",
"valor": "00000000-0000-0000-0000-000000000111"
},
{
"nome": "TenantCodeExt",
"valor": "ref personalizado 1"
},
{
"nome": "TenantName",
"value": "Cliente de exemplo 1"
},
{
"nome": "UserId",
"valor": "00000000-0000-0000-0000-000000000001"
},
{
"nome": "Nome de Utilizador",
"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,
"operadorUsado": "SOMA",
"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,
"operadorUsado": "ADJUSTPERCENTAGE",
"operatorValueUsed": 0,0,
"productTagName": "Todos os Produtos",
"billingOutputTags": ["TotalInclVAT", "Resumo", "GL_Balance", "GL_Entry:2222; débito; 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,
"operadorUsado": "ADJUSTPERCENTAGE",
"operatorValueUsed": 0,0,
"productTagName": "Todos os Produtos",
"billingOutputTags": ["TotalIVA", "Sumário", "GL_VAT", "IVA:S", "GL_Entry:1111; crédito; IVA"][ "TotalVAT", "Summary", "GL_VAT", "VAT:S", "GL_Entry:1111;credit;VAT" ],
"stringValues": [][ ]
}
],
"Tipo de fatura": 0
}Exemplo CSV Dados #
id,quantidade,valor,fromdate,todate,productname,partnumber,tenantcode,tenantcodeext,tenantname,userid,username,resellercode,resellercodeext,resellername
00000000000000000000001,1,1.25,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Usuário Essencial,#XDM00001,00000000-0000-0000-0000-00000000111,ref personalizada 1,Exemplo Cliente 1,00000000-0000-0000-0000-000000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-0000-00000000222,revendedor ref 1,Revendedor ABC
00000000000000000000003,1,15,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Supervisor em Tempo Real,#XDM00010,00000000-0000-0000-0000-00000000111,ref personalizada 1,Exemplo de Cliente 1,00000000-0000-0000-0000-00000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-0000-00000000222,revendedor ref 1,Revendedor ABCErros #
Não autorizado #
Quando o token não é fornecido, inválido ou expirado
HTTP/1.1 401 Não autorizadoNão encontrado #
Quando não há faturas que tenham um ID de fatura correspondente
HTTP/1.1 404 Não encontrado
Data: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de conteúdo: application/json; charset=utf-8
Comprimento do conteúdo: 95
{
"erro": 404,
"message": "Não encontrado",
"status": "erro",
"carimbo de data/hora": "2020-02-06T12:46:58.7669535Z"
}