Descripción general de los datos de facturación #
El recurso de facturación proporciona acceso para descargar facturas y datos de facturación de ~.Dimensions.~.
/{VERSIÓN}/billingdata
Esquema de detalles de factura #
Los clientes representan un inquilino en el sistema al que se pueden asignar los usuarios finales a través de API.
| Llave | Descripción | Tipo | Disponibilidad |
|---|---|---|---|
| Tenantid | El identificador de la cuenta de revendedor principal | cuerda | Todo |
| ID de factura | Un número único para identificar una factura en particular | cuerda | Todo |
| Número de factura | El número de factura que se muestra en el PDF factura | cuerda | Todo |
| Nombre de la cuenta | El nombre de la empresa de la cuenta de revendedor principal | cuerda | Todo |
| BillingPeriodStart | La fecha en que comienza el período de facturación | cuerda | Todo |
| BillingPeriodend | La fecha en que finaliza el período de facturación | cuerda | Todo |
| Valor de la factura | El valor total de la factura | doble | Todo |
| Artículos de factura | Una colección de elementos de factura | array(Elemento de factura | Obtener detalle de la factura Solamente |
Esquema de posición de factura #
Cada entrada en los datos de facturación proporciona los parámetros que se enumeran a continuación.
| Llave | Descripción | Tipo |
|---|---|---|
| identificación | El identificador de la cuenta de revendedor principal | cuerda |
| cantidad | 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 | |
|---|---|---|
| TenantCode1 | El identificador de inquilino del cliente | |
| TenantCodeext1 | La referencia del revendedor para el cliente | |
| Nombredelinquilino1 | El nombre del cliente | cuerda |
| ResellerCode | El identificador de inquilino del revendedor | |
| ResellerCodeExt2 | 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 |
Interfaces disponibles #
| Interfaz | Descripción |
|---|---|
| Obtener todo | Devuelve una colección de todas las facturas. |
| Obtener factura | Devuelve los detalles de una factura específica. |
| Obtener el detalle de la factura | Devoluciones JSON & CSV salida de datos de una factura específica en un archivo ZIP. |
| Obtener resumen de la factura | Devuelve el archivo PDF salida de datos de una factura específica. |
-
Los campos "TenantCode", "TenantCodeExt" y "TenantName" se rellenan con información sobre la cuenta del cliente. ↩︎
-
El ResellerCodeExt se rellenará con el número de referencia que se ha configurado con el revendedor. Esto se puede actualizar según sea necesario a través del Portal de la empresa o a través de Cliente API, para permitir la vinculación de registros de revendedor a sistemas externos. ↩︎