Obtener detalles de la factura

Obtener detalles de la factura #

Obtenga un desglose detallado de todos los artículos que se facturan para una factura específica. A partir de esta consulta se devuelve un archivo ZIP que contiene un archivo JSON archivo y un archivo simplificado CSV archivo. Cada archivo contiene un registro de cada transacción en la factura.

GET /v1.0/billingdata/{INVOICE_ID}/detail

Ejemplo #

Esta solicitud recuperará un desglose de los artículos para un ID de factura específico.

Pedir #

GET /api/v1.0/billingdata/{INVOICE_ID}/detail HTTP/1.1
Autorización: portador {TOKEN}

Respuesta #

HTTP/1.1 200 OK
Tipo de contenido: application/octet-stream; charset=utf-8
Longitud del contenido: xx
{
	"status": "éxito",
	"marca de tiempo": "2019-01-01T10:00:00.2890319Z"
}

Ejemplo JSON Datos #

{
	"tenantId": "00000000-0000-0000-0000-123456789123",
	"invoiceId": "00000000000000000000000a",
	"invoiceNumber": "9000004",
	"accountName": "Ejemplo 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",
			"cantidad": 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": "PRECIO",
			"operatorValueUsed": 1.25,
			"productTagName": "#XDM00001 de usuario esencial",
			"billingOutputTags": ["ResultadoCompra"][ "PurchaseResult" ],
			"stringValues": [
				{
					"name": "Rol",
					"valor": "cliente.usuario.pbx"
				},
				{
					"name": "ResellerCode",
					"valor": "00000000-0000-0000-0000-000000000222"
				},
				{
					"name": "ResellerCodeExt",
					"value": "reseller ref 1"
				},
				{
					"name": "ResellerName",
					"value": "ABC Reseller"
				},
				{
					"name": "TenantCode",
					"valor": "00000000-0000-0000-0000-000000000111"
				},
				{
					"name": "TenantCodeExt",
					"value": "Custom ref 1"
				},
				{
					"name": "TenantName",
					"value": "Ejemplo Cliente 1"
				},
				{
					"name": "UserId",
					"value": "00000000-0000-0000-0000-0000000000001"
				},
				{
					"name": "Nombre de usuario",
					"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": [
				{
					"name": "customer_licence_count",
					"valor": 1
				}
			][
				{
					"name": "customer_licence_count",
					"value": 1
				}
			]
		},
		{
			"id": "000000000000000000000003",
			"cantidad": 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": "PRECIO",
			"operatorValueUsed": 15.00,
			"productTagName": "Supervisor en tiempo real #XDM00010",
			"billingOutputTags": ["ResultadoCompra"][ "PurchaseResult" ],
			"stringValues": [
				{
					"name": "Rol",
					"value": "cliente.usuario.supervisorl2"
				},
				{
					"name": "ResellerCode",
					"valor": "00000000-0000-0000-0000-000000000222"
				},
				{
					"name": "ResellerCodeExt",
					"value": "reseller ref 1"
				},
				{
					"name": "ResellerName",
					"value": "ABC Reseller"
				},
				{
					"name": "TenantCode",
					"valor": "00000000-0000-0000-0000-000000000111"
				},
				{
					"name": "TenantCodeExt",
					"value": "Custom ref 1"
				},
				{
					"name": "TenantName",
					"value": "Ejemplo Cliente 1"
				},
				{
					"name": "UserId",
					"value": "00000000-0000-0000-0000-0000000000001"
				},
				{
					"name": "Nombre de usuario",
					"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": [
				{
					"name": "customer_licence_count",
					"valor": 1
				}
			][
				{
					"name": "customer_licence_count",
					"value": 1
				}
			]
		},
		{
			"id": "000000000000000000000004",
			"cantidad": 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": "SUMA",
			"operatorValueUsed": 0.0,
			"productTagName": "Todos los productos",
			"billingOutputTags": ["Resumen", "Total", "GL", "GL_Entry:0000; crédito;"][ "Summary", "Total", "GL", "GL_Entry:0000;credit;" ],
			"stringValues": [][ ]
		},
		{
			"id": "000000000000000000000005",
			"cantidad": 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": "AJUSTARPORCENTAJE",
			"operatorValueUsed": 0.0,
			"productTagName": "Todos los productos",
			"billingOutputTags": ["TotalInclIVA", "Resumen", "GL_Balance", "GL_Entry:2222; débito; Deudores"][ "TotalInclVAT", "Summary", "GL_Balance", "GL_Entry:2222;debit;Debtors" ],
			"stringValues": [][ ]
		},
		{
			"id": "000000000000000000000006",
			"cantidad": 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": "AJUSTARPORCENTAJE",
			"operatorValueUsed": 0.0,
			"productTagName": "Todos los productos",
			"billingOutputTags": ["IVA total", "Resumen", "GL_VAT", "IVA:S", "GL_Entry:1111; crédito; IVA"][ "TotalVAT", "Summary", "GL_VAT", "VAT:S", "GL_Entry:1111;credit;VAT" ],
			"stringValues": [][ ]
		}
	],
	"invoiceType": 0
}

Ejemplo CSV Datos #

id,cantidad,valor,fromdate,todate,productname,partnumber,tenantcode,tenantcodeext,tenantname,userid,username,resellercode,resellercodeext,resellername
000000000000000000000001,1,1.25,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Usuario esencial,#XDM00001,00000000-0000-0000-0000-0000000111,Referencia personalizada 1,Ejemplo Cliente 1,00000000-0000-0000-0000-00000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-0000-000000000222,revendedor ref 1,ABC Revendedor
00000000000000000000003,1,15,2020-04-01T00:00:00.000+00:00,2020-04-30T23:59:59.000+00:00,Supervisor en tiempo real,#XDM00010,00000000-0000-0000-0000-0000000111,Referencia personalizada 1,Ejemplo de cliente 1,00000000-0000-0000-0000-000000000001,[[email protected]](mailto:[email protected]),00000000-0000-0000-0000-000000000222,revendedor ref 1,ABC Revendedor

Errores #

Desautorizado #

Cuando el token no se proporciona, no es válido o ha caducado

HTTP/1.1 401 No autorizado

No encontrado #

Cuando no hay facturas que tengan un identificador de factura coincidente

HTTP/1.1 404 No encontrado
Fecha: Thu, 06 Feb 2020 12:46:58 GMT
Tipo de contenido: application/json; charset=utf-8
Contenido-Longitud: 95
{
	"error": 404,
	"message": "No encontrado",
	"status": "error",
	"marca de tiempo": "2020-02-06T12:46:58.7669535Z"
}