invantive documentation
Foros de Soporte de InvantiveIniciar Sesión / Registrarse

CustomerContracts: Contratos de cliente de Visma.net Financials

insert update REST

  • Catálogo: VismaNet
  • Esquema: CustomerContract
  • Llaves Primarias: contractId
  • Etiqueta: Contratos de cliente

Obtener un rango de contratos de cliente; es necesario especificar un filtro - ScreenId=CT301000

Permite recuperar y modificar datos mediante insert y update.

Fuente de la API

  • Punto final: /v1/customerContract
  • Operación: get /v1/customerContract

Características de rendimiento

Characteristic Value
Latencia media de acceso (ms) 155
Número de filas escaneadas por minuto 29,100
Número de filas de queries puntuales por minuto 387

El resultado se puede almacenar en la Caché del cliente.

Parámetros

Name Tipo de Datos Required Default Documentation
attributes `` Atributos (información adicional) asociados a la entidad.Ejemplos: {{base}}/customerContract?attributes={"AttributeID":"ValueID","AttributeID":"ValueID"} {{base}}/customerContract?attributes={"AttributeID":"ValueID1,ValueID2"}
contractTemplate ``
customer ``
expandAttributes ``
expandDetails ``
expandSummary ``
greaterThanValue ``
lastModifiedDateTime ``
lastModifiedDateTimeCondition ``
status `` Valores: Borrador, InApproval, Activo, Expirado, Cancelado, Completado, InUpgrade, PendingActivation.

Columnas de la Tabla

A continuación se muestran las columnas de la tabla CustomerContracts. Cada columna tiene un tipo de datos SQL. Se debe proporcionar un nuevo valor no nulo para cada columna requerida en todo momento durante la inserción y la actualización.

Name Tipo de Datos Label Required Marks Documentation
COMPANY_CODE varchar2(30) Código de empresa writable Código de partición que segmenta los datos.
COMPANY_NAME varchar2(240) Nombre de la Compañía writable Nombre de la partición.
balance double Balance filtros en la plataforma, modificables, balance La parte superior > Saldo > Campo de solo lectura que muestra la suma de los saldos de las facturas abiertas asociadas al contrato.
contractId varchar2 ID de contrato filtros en la plataforma, modificables, contractId Campo obligatorio: La parte superior > ID de contrato* > El identificador único de un contrato.
contractTemplate_description varchar2 Descripción de la plantilla de contrato filtros en la plataforma, modificables, contractTemplate.description Haga clic en la lupa. > La descripción.
contractTemplate_id varchar2 N.º de plantilla de contrato filtros en la plataforma, modificables, contractTemplate.id Haga clic en la lupa. > El identificador.
customer_name varchar2 Nombre del Cliente filtros en la plataforma, modificables, customer.name Haga clic en la lupa. > El nombre.
customer_number varchar2 Numero de cliente filtros en la plataforma, modificables, customer.number
description varchar2 Description filtros en la plataforma, modificables, description Campo obligatorio: La parte superior > Descripción* > La descripción del contrato, que incluye cualquier comentario relacionado.
details_currentRecurring double itgen_vnet_details_currentrecurring filtros en la plataforma, modificables, details.currentRecurring
details_currentRenewal double itgen_vnet_details_currentrenewal filtros en la plataforma, modificables, details.currentRenewal
details_currentSetup double itgen_vnet_details_currentsetup filtros en la plataforma, modificables, details.currentSetup
details_effectiveFrom datetime itgen_vnet_details_effectivefrom filtros en la plataforma, modificables, details.effectiveFrom
details_pendingRecurring double itgen_vnet_details_pendingrecurring filtros en la plataforma, modificables, details.pendingRecurring
details_pendingRenewal double itgen_vnet_details_pendingrenewal filtros en la plataforma, modificables, details.pendingRenewal
details_pendingSetup double itgen_vnet_details_pendingsetup filtros en la plataforma, modificables, details.pendingSetup
details_promoCode_description varchar2 itgen_vnet_details_promocode_description filtros en la plataforma, modificables, details.promoCode.description Haga clic en la lupa. > La descripción.
details_promoCode_id varchar2 itgen_vnet_details_promocode_id filtros en la plataforma, modificables, details.promoCode.id Haga clic en la lupa. > El identificador.
details_totalPending double Total pendiente filtros en la plataforma, modificables, details.totalPending
lastModifiedDateTime datetime Última Modificación filtros en la plataforma, modificables, lastModifiedDateTime Información generada por el sistema
location_description varchar2 Descripción de la Ubicación filtros en la plataforma, modificables, location.description Haga clic en la lupa. > La descripción.
location_id varchar2 ID de Ubicación filtros en la plataforma, modificables, location.id Haga clic en la lupa. > El identificador.
status varchar2 Status filtros en la plataforma, modificables, status La parte superior > Estado > El estado del contrato, que es uno de los siguientes: Borrador, Pendiente de activación, Activo, Vencido, Cancelado, Pendiente de actualización.
summary_activationDate datetime Fecha de activación filtros en la plataforma, modificables, summary.activationDate Sección de configuración del contrato > Fecha de activación > La fecha en que se inicia la prestación de los servicios del contrato.
summary_caseCountItem_description varchar2 itgen_vnet_summary_casecountitem_description filtros en la plataforma, modificables, summary.caseCountItem.description Nombre del artículo/descripción
summary_caseCountItem_number varchar2 itgen_vnet_summary_casecountitem_number filtros en la plataforma, modificables, summary.caseCountItem.number Número de artículo
summary_currency varchar2 Currency filtros en la plataforma, modificables, summary.currency Campo obligatorio: Sección de configuración del contrato > Moneda* > La moneda utilizada en el contrato.
summary_expirationDate datetime Fecha de caducidad filtros en la plataforma, modificables, summary.expirationDate Sección de configuración del contrato > Fecha de vencimiento > La fecha en que vence el contrato.
summary_gracePeriod int32 Período de gracia filtros en la plataforma, modificables, summary.gracePeriod Sección de configuración del contrato > Período de gracia > El número de días posteriores a la fecha de vencimiento en que el contrato todavía puede renovarse.
summary_invoiceAccount_name varchar2 itgen_vnet_summary_invoiceaccount_name filtros en la plataforma, modificables, summary.invoiceAccount.name Haga clic en la lupa. > El nombre.
summary_invoiceAccount_number varchar2 itgen_vnet_summary_invoiceaccount_number filtros en la plataforma, modificables, summary.invoiceAccount.number
summary_invoiceLocation_description varchar2 itgen_vnet_summary_invoicelocation_description filtros en la plataforma, modificables, summary.invoiceLocation.description Haga clic en la lupa. > La descripción.
summary_invoiceLocation_id varchar2 itgen_vnet_summary_invoicelocation_id filtros en la plataforma, modificables, summary.invoiceLocation.id Haga clic en la lupa. > El identificador.
summary_invoiceTo varchar2 itgen_vnet_summary_invoiceto filtros en la plataforma, modificables, summary.invoiceTo Sección de información de facturación > Facturar a > El ajuste que define la cuenta de cliente que se facturará por un contrato.Están disponibles las siguientes opciones: Cuenta principal, Cuenta de cliente, Cuenta específica.
summary_invoicingPeriod varchar2 itgen_vnet_summary_invoicingperiod filtros en la plataforma, modificables, summary.invoicingPeriod Campo obligatorio: Sección de calendario de facturación > Período de facturación* > El tipo de calendario de facturación, que puede ser una de las siguientes opciones: Semanal, Mensual, Trimestral, Semestral, Anual, Bajo demanda, Basado en extractos.
summary_invoicingScheduleStartsOn datetime itgen_vnet_summary_invoicingschedulestartson filtros en la plataforma, modificables, summary.invoicingScheduleStartsOn Sección de calendario de facturación > El calendario de facturación comienza el > Campo de solo lectura que muestra la fecha de inicio del primer período de facturación.
summary_lastInvoicingDate datetime itgen_vnet_summary_lastinvoicingdate filtros en la plataforma, modificables, summary.lastInvoicingDate Sección de calendario de facturación > Última fecha de facturación > Campo de solo lectura que muestra la fecha en que se realizó la facturación más recientemente.
summary_massRenewal char itgen_vnet_summary_massrenewal filtros en la plataforma, modificables, summary.massRenewal Sección de configuración del contrato > Renovación masiva > Casilla de verificación que indica la renovación de todos los contratos en la fecha de vencimiento.
summary_nextInvoicingDate datetime itgen_vnet_summary_nextinvoicingdate filtros en la plataforma, modificables, summary.nextInvoicingDate Sección de calendario de facturación > Próxima fecha de facturación > La fecha de la siguiente factura, según el calendario de facturación.
summary_owner_internalId varchar2 itgen_vnet_summary_owner_internalid filtros en la plataforma, modificables, summary.owner.internalId
summary_owner_name varchar2 itgen_vnet_summary_owner_name filtros en la plataforma, modificables, summary.owner.name El nombre del destino concreto del tipo seleccionado.
summary_owner_number varchar2 itgen_vnet_summary_owner_number filtros en la plataforma, modificables, summary.owner.number El identificador del destino concreto del tipo seleccionado.
summary_renewalPoint int32 itgen_vnet_summary_renewalpoint filtros en la plataforma, modificables, summary.renewalPoint Sección de configuración del contrato > Punto de renovación > El número de días antes de la expiración en que deben comenzar los procesos de renovación.
summary_salesPerson_description varchar2 itgen_vnet_summary_salesperson_description filtros en la plataforma, modificables, summary.salesPerson.description Haga clic en la lupa. > La descripción.
summary_salesPerson_id varchar2 itgen_vnet_summary_salesperson_id filtros en la plataforma, modificables, summary.salesPerson.id Haga clic en la lupa. > El identificador.
summary_setupDate datetime itgen_vnet_summary_setupdate filtros en la plataforma, modificables, summary.setupDate Campo obligatorio: Sección de configuración del contrato > Fecha de configuración* > La fecha de configuración del contrato.
summary_terminationDate datetime itgen_vnet_summary_terminationdate filtros en la plataforma, modificables, summary.terminationDate Sección de configuración del contrato > Fecha de terminación > La fecha en que se cancelará el contrato; no se prestarán servicios.
timeStamp blob Timestamp filtros en la plataforma, modificables, timeStamp Identificador que representa una versión específica del recurso.Ayuda a evitar que las actualizaciones simultáneas del recurso se sobrescriban entre sí (mediante ETags y encabezados If-Match).

Teclas

Key Column Se refiere a Kind Description
CustomerContracts_customer_number_fk customer_number Customers.number Key

Notas de la Versión

Cambios introducidos en cada versión en las tablas, columnas, atributos y capacidades del controlador: