Datos de facturación JSON #
La siguiente información proporciona detalles de la JSON Datos proporcionados al descargar los datos de una factura específica. El JSON Los datos proporcionan el nivel más granular de información, incluidas las entradas para cada licencia de usuario utilizada y las entradas resumidas que proporcionan información sobre los totales de las facturas y los impuestos aplicables.
Esquema de detalles de factura #
El principal JSON La entrada proporciona detalles sobre el número de factura, el período y la fecha. También contiene una matriz de los elementos de factura individuales que se relacionan con cada licencia que se factura.
| Llave | Descripción | Tipo |
|---|---|---|
| Tenantid | El identificador de la cuenta de revendedor principal | cuerda |
| ID de factura | Un número único para identificar una factura en particular | cuerda |
| Número de factura | El número de factura que se muestra en el PDF factura | cuerda |
| Nombre de la cuenta | El nombre de la empresa de la cuenta de revendedor principal | cuerda |
| BillingPeriodStart | La fecha en que comienza el período de facturación | cuerda |
| BillingPeriodend | La fecha en que finaliza el período de facturación | cuerda |
| Valor de la factura | El valor total de la factura | doble |
| Artículos de factura | Una colección de elementos de factura | array(Elemento de factura) |
JSON Esquema de posición de factura #
Cada entrada de posición de factura en el JSON Los datos de facturación proporcionan los parámetros que se enumeran a continuación. Se refieren a un uso individual por parte de un usuario con los intervalos de fechas aplicables.
| Llave | Descripción | Tipo |
|---|---|---|
| identificación | Un identificador único para la compra individual | cuerda |
| Cantidad1 | La cantidad utilizada | doble |
| valor | El costo del artículo | doble |
| Fecha de inicio | La fecha a partir de la cual se factura el artículo | cuerda |
| hasta la fecha | La fecha a partir de la cual se factura el artículo | cuerda |
| calculationorder | Número secuencial que indica el orden en el que se deben procesar los artículos de la factura | Int |
| UserUsed | Indica cómo se aplica el valor del elemento de factura a la factura | Operador de posición de factura |
| operatorvalueused | Indica el valor del operador ADJUSTPERCENTAGE | doble |
| producttagname | El nombre de la característica/producto para el que es el artículo de factura. Tendrá el formato '{PRODUCT_NAME} #{PART_NUMBER}' | cuerda |
| BillingOutputTags | Indicación de si la posición de factura es para una compra o es un campo de resumen | matriz(cadena) |
| Valores de cadena | Proporciona información sobre el cliente y usuario final para el que es la compra | Par de valores clave< cadena,cadena> |
| Valores numéricos | Proporciona información sobre el cliente y usuario final para el que es la compra | Par de valores clave< cadena,doble> |
Operadores de artículos de factura #
El operador de cada artículo indica cómo se aplica el artículo a la factura. ResultadoCompra tendrá un PRECIO para identificar el costo del artículo. Los artículos con otras etiquetas de salida indicarán si están sumando el valor de la factura o aplicando un valor porcentual a los artículos anteriores, como el impuesto sobre las ventas.
| Artículos | Descripción |
|---|---|
| PRECIO | Indica que el artículo de factura muestra el precio unitario de un artículo |
| SUMA | Indica que el elemento de factura muestra un total de varios artículos |
| AJUSTARPORCENTAJE | Indica que el artículo de la factura muestra un ajuste porcentual en la suma, esto generalmente indica que se está aplicando el IVA |
Elementos de etiqueta de salida de facturación #
Las etiquetas de salida de facturación se utilizan para indicar si la entrada de datos se refiere a una compra o es una entrada de resumen que proporciona información sobre toda la factura.
| Artículos | Descripción |
|---|---|
| ResultadoCompra | Indica que el artículo de la factura es una compra con cargo |
| Resumen | Indica que el elemento de la factura es un resumen de las compras, proporcionando información sobre el total de la factura. Cuando está solo sin las etiquetas 'TotalVAT' o 'TotalInclVAT', indica el total de la factura antes de agregar el IVA. |
| TotalIVA incluido | Indica que el elemento de la factura muestra el total de la factura, incluido el IVA aplicable |
| IVA total | Indica que la posición de la factura muestra el IVA total aplicable a la factura |
Elementos de valor de cadena #
Los elementos de valor de cadena proporcionan información específica del cliente y del usuario final del artículo comprado.
| Llave | Descripción | |
|---|---|---|
| TenantCode2 | El identificador de inquilino del revendedor | |
| TenantCodeext2 | La referencia del revendedor para el revendedor | |
| Nombredelinquilino2 | El nombre del revendedor | cuerda |
| ResellerCode | El identificador de inquilino del revendedor | |
| ResellerCodeExt | La referencia ampliada para el revendedor | |
| ResellerName | El nombre del revendedor | |
| ID de usuario | El id del usuario | |
| Nombre de usuario | El nombre de usuario del usuario | |
| rol | La clave de rol para el artículo facturado |
Elementos de valor numérico #
Los artículos de valor numérico proporcionan información específica para el cliente y el usuario final del artículo comprado.
| Llave | Descripción |
|---|---|
| customer_licence_count | El número total de estas licencias que tiene el cliente |
Ejemplo JSON Salida #
{
"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
}