Se envía en cada petición el nombre de usuario y la contraseña codificados en Base64 como header "Authorization":
_> curl -X POST https://app.softseguros.com/api/poliza/ -H "Authorization: Basic convertBase64(username:password)"Este token se envía en cada petición como header "Authorization":
_> curl -X POST https://app.softseguros.com/api/cliente/ -H "Authorization: Token 83315d67dvg615dfg6f6s76gdfgdf78df177dfg"Para la obtención del token se hace una petición enviando Nombre de usuario y contraseña.
| Nombre del campo | Requerido | Descripción |
|---|---|---|
| username | Si | |
| password | Si |
{
"token": "83315d67dvg615dfg6f6s76gdfgdf78df177dfg"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente ya creado creado previamente, lo puedes consultar en / Clientes > Consultar cliente por número de documento | |
| estado_poliza | Si | ID del estado con el que se creará la póliza | Mostrar valores |
| numero_poliza | Si | ||
| sede | Si | ID de la sede ya creada en la que se creará la póliza, si no tienes más de 1 siempre será la "Principal" | Mostrar valores |
| ramo | Si | ID del producto (Ramo / Aseguradora) ya creado con el que se asociará la póliza | |
| codio_objeto_asegurado | Si | Riesgo (Placa, Dirección,etc) | |
| vendedor | Si | ID del vendedor asociado a la póliza. Vendedor > Listado de vendedores | |
| renovable | No | Es renovable | true, false |
| fecha_inicio | Si | Fecha inicio YYYY-MM-DD. | |
| fecha_fin | Si | Fecha fin YYYY-MM-DD. | |
| nombre_tomador | Si | Nombre Titular | |
| cedula_tomador | Si | Documento del Titular | |
| nombre_asegurado | Si | Nombre Asegurado | |
| cedula_asegurado | Si | Documento del Asegurado | |
| prima | No | Prima Neta | |
| gastos_expedicion | No | Derechos de emisión | |
| iva | No | ||
| porcentaje_iva_prima | No | % IVA Prima | |
| porcentje_comicion | No | Porcentaje Comisión | |
| participacion | No | Participación | |
| comicion | No | Comisión agencia | |
| total | No | Total |
{
"id": 1,
"numero_poliza": "P\u00f3liza test postman",
"codio_objeto_asegurado": "HJA test",
"ramo_porcentaje_iva_prima": "0.00",
"tipo_moneda_nombre": "",
"sede": 1,
"renovable": false,
"fecha_inicio": null,
"fecha_fin": null,
"estado_poliza": 1,
"estado_poliza_nombre": "Vigente",
"estado_poliza_codigo": "01",
"cliente": 1,
"cliente_numero_documento": "109939123",
"cliente_nombres": "Santiago",
"cliente_apellidos": "Mu\u00f1oz",
"tipo_poliza": "individual",
"fecha_creacion": "2019-08-02T21:38:05.071127Z",
"vendedor": 1,
"vendedores_nombre": "",
"vendedores": [
{
"id": "1151929",
"nombre_vendedor": "Vendedor",
"comision": "0.00",
"porcentaje_comision": "0.00",
"comision_bruta": "0.00",
"comision_prima": "true",
"comision_editada": "false",
"editar_comision_vendedor": "false",
"retencion_iva_porcentaje": "0.00",
"iva_porcentaje": "0.00",
"editar_iva_porcentaje": "false",
"valores_anclados": "false",
"vendedor": "7263332"
}
],
"ramo": 1,
"ramo_aseguradora_nombre": "SEGUROS \u00c1NGELES UNIDOS",
"ramo_nombre": "VIDA",
"ramo_global_nombre": "Vida",
"ramo_global": 1,
"categorias": [
{
"id": 1,
"nombre": "Categor\u00eda ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categor\u00eda ejemplo 2",
"color": "#000"
}
],
"sede_id": 1,
"sede_nombre": "Sede principal",
"nombre_asegurado": null,
"cedula_asegurado": null,
"nombre_tomador": null,
"cedula_tomador": null,
"prima": 0,
"porcentaje_iva_prima": 19.0,
"iva": null,
"total": null,
"gastos_expedicion": null,
"tipo_moneda": null,
"porcentje_comicion": null,
"participacion": null,
"comicion": null,
"iva_de_comision": null,
"total_pagado": null,
"comision_recibida": null,
"porcentaje_comision_vendedor": null,
"comision_vendedor": null
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente ya creado creado previamente, lo puedes consultar en / Clientes > Consultar cliente por número de documento | |
| estado_poliza | Si | ID del estado con el que se creará la póliza | Mostrar valores |
| numero_poliza | Si | ||
| sede | Si | ID de la sede ya creada en la que se creará la póliza, si no tienes más de 1 siempre será la "Principal" | Mostrar valores |
| ramo | Si | ID del producto (Ramo / Aseguradora) ya creado con el que se asociará la póliza | |
| codio_objeto_asegurado | Si | Riesgo (Placa, Dirección,etc) | |
| vendedor | Si | ID del vendedor asociado a la póliza. Vendedor > Listado de vendedores | |
| renovable | No | Es renovable | true, false |
| fecha_inicio | Si | Fecha inicio YYYY-MM-DD. | |
| fecha_fin | Si | Fecha fin YYYY-MM-DD. | |
| nombre_tomador | Si | Nombre Titular | |
| cedula_tomador | Si | Documento del Titular | |
| nombre_asegurado | Si | Nombre Asegurado | |
| cedula_asegurado | Si | Documento del Asegurado | |
| prima | No | Prima Neta | |
| gastos_expedicion | No | Derechos de emisión | |
| iva | No | ||
| porcentaje_iva_prima | No | % IVA Prima | |
| porcentje_comicion | No | Porcentaje Comisión | |
| participacion | No | Participación | |
| comicion | No | Comisión agencia | |
| total | No | Total |
{
"id": 1,
"numero_poliza": "P\u00f3liza test postman",
"codio_objeto_asegurado": "HJA test",
"ramo_porcentaje_iva_prima": "0.00",
"tipo_moneda_nombre": "",
"sede": 1,
"renovable": false,
"fecha_inicio": null,
"fecha_fin": null,
"estado_poliza": 1,
"estado_poliza_nombre": "Vigente",
"estado_poliza_codigo": "01",
"cliente": 1,
"cliente_numero_documento": "109939123",
"cliente_nombres": "Santiago",
"cliente_apellidos": "Mu\u00f1oz",
"tipo_poliza": "individual",
"fecha_creacion": "2019-08-02T21:38:05.071127Z",
"vendedor": 1,
"vendedores_nombre": "",
"vendedores": [
{
"id": "1151929",
"nombre_vendedor": "Vendedor",
"comision": "0.00",
"porcentaje_comision": "0.00",
"comision_bruta": "0.00",
"comision_prima": "true",
"comision_editada": "false",
"editar_comision_vendedor": "false",
"retencion_iva_porcentaje": "0.00",
"iva_porcentaje": "0.00",
"editar_iva_porcentaje": "false",
"valores_anclados": "false",
"vendedor": "7263332"
}
],
"ramo": 1,
"ramo_aseguradora_nombre": "SEGUROS \u00c1NGELES UNIDOS",
"ramo_nombre": "VIDA",
"ramo_global_nombre": "Vida",
"ramo_global": 1,
"categorias": [
{
"id": 1,
"nombre": "Categor\u00eda ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categor\u00eda ejemplo 2",
"color": "#000"
}
],
"sede_id": 1,
"sede_nombre": "Sede principal",
"nombre_asegurado": null,
"cedula_asegurado": null,
"nombre_tomador": null,
"cedula_tomador": null,
"prima": 0,
"porcentaje_iva_prima": 19.0,
"iva": null,
"total": null,
"gastos_expedicion": null,
"tipo_moneda": null,
"porcentje_comicion": null,
"participacion": null,
"comicion": null,
"iva_de_comision": null,
"total_pagado": null,
"comision_recibida": null,
"porcentaje_comision_vendedor": null,
"comision_vendedor": null
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_cliente | No | ID del cliente, lo puedes consultar en / Clientes > Consultar cliente por número de documento, Retorna todas las pólizas asociadas a un cliente. | |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Campo por el cual se ordenan los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"numero_poliza": "P\u00f3liza test postman",
"codio_objeto_asegurado": "HJA test",
"ramo_porcentaje_iva_prima": "0.00",
"tipo_moneda_nombre": "",
"sede": 1,
"renovable": false,
"fecha_inicio": null,
"fecha_fin": null,
"estado_poliza": 1,
"estado_poliza_nombre": "Vigente",
"estado_poliza_codigo": "01",
"cliente": 1,
"cliente_numero_documento": "109939123411",
"cliente_nombres": "Santiago",
"cliente_apellidos": "Mu\u00f1oz",
"tipo_poliza": "individual",
"fecha_creacion": "2019-08-02T21:38:05.071127Z",
"vendedor": 1,
"vendedores_nombre": "",
"vendedores": [
"7263"
],
"ramo": 1,
"ramo_aseguradora_nombre": "Aseguradora prueba 1",
"ramo_nombre": "Ramo Prueba 1",
"ramo_global_nombre": "Prueba",
"ramo_global": 1,
"categorias": [
{
"id": 1,
"nombre": "Categor\u00eda ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categor\u00eda ejemplo 2",
"color": "#000"
}
],
"sede_id": 1,
"sede_nombre": "Sede principal",
"nombre_asegurado": null,
"cedula_asegurado": null,
"nombre_tomador": null,
"cedula_tomador": null,
"prima": 0,
"porcentaje_iva_prima": 16.0,
"iva": null,
"total": null,
"gastos_expedicion": null,
"tipo_moneda": null,
"porcentje_comicion": null,
"participacion": null,
"comicion": null,
"iva_de_comision": null,
"total_pagado": null,
"comision_recibida": null,
"porcentaje_comision_vendedor": null,
"comision_vendedor": null
}
]
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza | Si | ID de la póliza a la que se asignará el beneficiario. | ID |
| nombres | Si | Nombre del Beneficiario. | |
| numero_documento | Si | Número documento del beneficiario. | |
| genero | No | Solo Pólizas de Salud. | femenino, masculino, otro |
| edad | No | Solo Pólizas de Salud y Vida. | |
| parentesco | No | Solo Pólizas de Salud y Vida. | |
| fecha_nacimiento | No | Solo Pólizas de Salud y Vida. | |
| porcentaje_beneficio | No | Solo Pólizas de Vida. | |
| excluido | No | Marcar beneficiario como excluido. | |
| fecha_exclusion | No | Fecha en la que se excluye. | YYYY-MM-DD |
| motivo_exclusion | No | Motivo por el cual se excluye el beneficiario. |
{
"id": "4442010116",
"numero_documento": "023105404",
"nombres": "PRUEBA",
"genero": "",
"edad": "",
"parentesco": "",
"porcentaje_beneficio": "",
"fecha_nacimiento": "",
"fecha_exclusion": "",
"motivo_exclusion": "",
"excluido": "false",
"poliza": "0882186417"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza | Si | ID de la póliza a la que se asignará el beneficiario. | ID |
| nombres | Si | Nombre del Beneficiario. | |
| numero_documento | Si | Número documento del beneficiario. | |
| genero | No | Solo Pólizas de Salud. | femenino, masculino, otro |
| edad | No | Solo Pólizas de Salud y Vida. | |
| parentesco | No | Solo Pólizas de Salud y Vida. | |
| fecha_nacimiento | No | Solo Pólizas de Salud y Vida. | |
| porcentaje_beneficio | No | Solo Pólizas de Vida. | |
| excluido | No | Marcar beneficiario como excluido. | |
| fecha_exclusion | No | Fecha en la que se excluye. | YYYY-MM-DD |
| motivo_exclusion | No | Motivo por el cual se excluye el beneficiario. |
{
"id": "4442010116",
"numero_documento": "023105404",
"nombres": "PRUEBA ACTUALIZAR",
"genero": "",
"edad": "",
"parentesco": "",
"porcentaje_beneficio": "",
"fecha_nacimiento": "",
"fecha_exclusion": "",
"motivo_exclusion": "",
"excluido": "false",
"poliza": "0882186417"
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza_id | Si | ID de la póliza. | ID |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Campo por el cual se ordenan los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 2,
"next": "null",
"previous": "null",
"results": [
{
"id": "4442010116",
"numero_documento": "023105404",
"nombres": "PRUEBA",
"genero": "",
"edad": "",
"parentesco": "",
"porcentaje_beneficio": "",
"fecha_nacimiento": "",
"fecha_exclusion": "",
"motivo_exclusion": "",
"excluido": "false",
"poliza": "0882186417"
},
{
"id": "4442010116",
"numero_documento": "023105404",
"nombres": "PRUEBA ACTUALIZAR",
"genero": "",
"edad": "",
"parentesco": "",
"porcentaje_beneficio": "",
"fecha_nacimiento": "",
"fecha_exclusion": "",
"motivo_exclusion": "",
"excluido": "false",
"poliza": "0882186417"
}
]
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza | Si | ID de la póliza, lo puedes consultar en / Polizas > Listar pólizas por ID del cliente | |
| numero_anexo_poliza | Si | ||
| estado_poliza | Si | ID del estado con el que se creará el anexo | Mostrar valores |
| fecha_inicio | Si | Fecha inicio YYYY-MM-DD. | |
| fecha_fin | Si | Fecha fin YYYY-MM-DD. | |
| fecha_expedicion | Si | Fecha expedición | |
| riesgo_asegurado | No | Riesgo asegurado | |
| renovable | No | Renovable | true, false |
| fecha_recepcion | No | Fecha recepción | |
| prima | No | Valor prima neta | |
| porcentaje_iva_prima | No | Porcentaje IVA | |
| gastos_expedicion | No | Valor gastos expedición | |
| iva_calculado | No | Iva calculado | true, false |
| iva | No | Valor IVA | |
| total | No | Valor Prima total | |
| porcentaje_comision | No | Porcentaje comisión | |
| comicion | No | Valor Comisión | |
| editar_comision_agencia | No | Comisión editada | true, false |
| forma_pago | No | Forma de pago | Contado, Financiado, Fraccionado, Acuerdo de pago |
| observaciones | No | Observaciones | |
| accesorios | No | Accesorios |
[
{
"id": 1,
"numero_anexo_poliza": "TEST",
"riesgo_asegurado": "TEST",
"estado_poliza_nombre": "Vigente",
"fecha_inicio": "2021-04-16",
"fecha_fin": "2022-03-10",
"fecha_expedicion": "2021-04-16",
"fecha_recepcion": "2021-04-16",
"renovable": true,
"anexo_padre": "",
"sede_id": 1,
"prima": "1000000.00",
"gastos_expedicion": "2000000.00",
"porcentaje_iva_prima": "19.00",
"iva": "570000.00",
"iva_calculado": true,
"porcentaje_comision": "0.00",
"editar_porcentaje_comision": false,
"comicion": "0.00",
"editar_comision_agencia": false,
"total": "3570000.00",
"accesorios": "test",
"observaciones": "test",
"numero_remicion": 1,
"forma_pago": "Financiado",
"poliza": 1,
"estado_poliza": 1
}
]| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| numero_anexo_poliza | Si | ||
| estado_poliza | Si | ID del estado con el que se creará el anexo | Mostrar valores |
| fecha_inicio | Si | Fecha inicio YYYY-MM-DD. | |
| fecha_fin | Si | Fecha fin YYYY-MM-DD. | |
| fecha_expedicion | Si | Fecha expedición | |
| riesgo_asegurado | No | Riesgo asegurado | |
| renovable | No | Renovable | true, false |
| fecha_recepcion | No | Fecha recepción | |
| prima | No | Valor prima neta | |
| porcentaje_iva_prima | No | Porcentaje IVA | |
| gastos_expedicion | No | Valor gastos expedición | |
| iva_calculado | No | Iva calculado | true, false |
| iva | No | Valor IVA | |
| total | No | Valor Prima total | |
| porcentaje_comision | No | Porcentaje comisión | |
| comicion | No | Valor Comisión | |
| editar_comision_agencia | No | Comisión editada | true, false |
| forma_pago | No | Forma de pago | Contado, Financiado, Fraccionado, Acuerdo de pago |
| observaciones | No | Observaciones | |
| accesorios | No | Accesorios |
[
{
"id": 1,
"numero_anexo_poliza": "TEST",
"riesgo_asegurado": "TEST",
"estado_poliza_nombre": "Vigente",
"fecha_inicio": "2021-04-16",
"fecha_fin": "2022-03-10",
"fecha_expedicion": "2021-04-16",
"fecha_recepcion": "2021-04-16",
"renovable": true,
"anexo_padre": "",
"sede_id": 1,
"prima": "1000000.00",
"gastos_expedicion": "2000000.00",
"porcentaje_iva_prima": "19.00",
"iva": "570000.00",
"iva_calculado": true,
"porcentaje_comision": "0.00",
"editar_porcentaje_comision": false,
"comicion": "0.00",
"editar_comision_agencia": false,
"total": "3570000.00",
"accesorios": "test",
"observaciones": "test",
"numero_remicion": 1,
"forma_pago": "Financiado",
"poliza": 1,
"estado_poliza": 1
}
]El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_poliza | No | ID de póliza si se desea obtener solo anexos de esta misma. | ID |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"numero_anexo_poliza": "TEST 1",
"riesgo_asegurado": "TEST 1",
"estado_poliza_nombre": "Vigente",
"fecha_inicio": "2021-04-16",
"fecha_fin": "2022-03-10",
"fecha_expedicion": "2021-04-16",
"fecha_recepcion": "2021-04-16",
"renovable": true,
"anexo_padre": "",
"sede_id": 1,
"prima": "1000000.00",
"gastos_expedicion": "2000000.00",
"porcentaje_iva_prima": "19.00",
"iva": "570000.00",
"iva_calculado": true,
"porcentaje_comision": "0.00",
"editar_porcentaje_comision": false,
"comicion": "0.00",
"editar_comision_agencia": false,
"total": "3570000.00",
"accesorios": "test",
"observaciones": "test",
"numero_remicion": 1,
"forma_pago": "Financiado",
"poliza": 1,
"estado_poliza": 1
},
{
"id": 1,
"numero_anexo_poliza": "TEST 2",
"riesgo_asegurado": "TEST 2",
"estado_poliza_nombre": "Vigente",
"fecha_inicio": "2021-04-16",
"fecha_fin": "2022-03-10",
"fecha_expedicion": "2021-04-16",
"fecha_recepcion": "2021-04-16",
"renovable": true,
"anexo_padre": "",
"sede_id": 1,
"prima": "1000000.00",
"gastos_expedicion": "2000000.00",
"porcentaje_iva_prima": "19.00",
"iva": "570000.00",
"iva_calculado": true,
"porcentaje_comision": "0.00",
"editar_porcentaje_comision": false,
"comicion": "0.00",
"editar_comision_agencia": false,
"total": "3570000.00",
"accesorios": "test",
"observaciones": "test",
"numero_remicion": 1,
"forma_pago": "Financiado",
"poliza": 1,
"estado_poliza": 1
}
]
}[
{
"id": 1,
"nombre": "Vigente",
"codigo_generico": "01"
},
{
"id": 2,
"nombre": "Devengada",
"codigo_generico": "03"
}
]Solo a pólizas colectivas se les puede asignar Vinculados.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza | Si | ID de la póliza a la que se asignará el vinculado. (Solo Colectivas) | ID |
| numero_riesgo_asegurado | Si | Número afiliado. | |
| fecha_inicio | Si | Fecha de Inicio. | YYYY-MM-DD |
| riesgo_asegurado | Si | Objeto asegurado. | |
| numero_anexo | No | Número de anexo. | |
| prima | Si | Prima neta (Mensual ,semestral, anual ). | |
| nombre_asegurado | No | Nombres del afiliado. | |
| apellidos_asegurado | No | Apellidos del afiliado. | |
| cedula_asegurado | No | Documento del afiliado. | |
| parentesco | No | Parentesco. | |
| fecha_nacimiento_asegurado | No | Fecha de nacimiento. | YYYY-MM-DD |
| edad | No | Edad. | |
| genero | No | Género. | |
| celular | No | Celular. | |
| No | Correo. | ||
| direccion | No | Dirección. | |
| plan_afiliado | No | Plan afiliado. | |
| tipo_tarifa | No | Tipo tarifa. | |
| tipo_afiliacion | No | ID Tipo afiliación. | Mostrar valores |
| porcentaje_iva_prima | Si | IVA Prima. | |
| gastos_expedicion | No | Gastos de expedición. | |
| iva | No | IVA. | |
| total | No | Total. | |
| empresa | No | ID Cliente tipo Empresa. | |
| empleado | No | ID Cliente tipo Persona. | |
| observaciones | No | Observaciones. | |
| accesorios | No | Observaciones internas. | |
| beneficiario_oneroso | No | Beneficiario oneroso. |
{
"id": "9879908",
"poliza_numero_poliza": "VINCULADO",
"fecha_inicio": "2021-04-15",
"fecha_fin": "",
"nombre_asegurado": "NOMBRE ASEGURADO",
"apellidos_asegurado": "APELLIDO ASEGURADO",
"cedula_asegurado": "0993324335",
"fecha_nacimiento_asegurado": "",
"genero": "",
"edad": "0",
"parentesco": "",
"direccion": "",
"email": "",
"celular": "",
"nombre_beneficiario": "",
"cedula_beneficiario": "",
"numero_anexo": "",
"numero_riesgo_asegurado": "0101010101",
"riesgo_asegurado": "56787-Riesgo",
"plan_afiliado": "",
"tipo_tarifa": "",
"porcentaje_iva_prima": "19.00",
"prima": "280000.00",
"editar_prima": "false",
"gastos_expedicion": "0.00",
"iva": "53200.00",
"iva_calculado": "true",
"total": "333200.00",
"accesorios": "",
"observaciones": "",
"fecha_retiro": "2021-05-03",
"motivo_retiro": "",
"retirado": "true",
"beneficiario_oneroso": "false",
"empresa": "3243235",
"empleado": "45446464",
"tipo_afiliacion": "",
"poliza": "2195256324325"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| numero_riesgo_asegurado | Si | Número afiliado. | |
| fecha_inicio | Si | Fecha de Inicio. | YYYY-MM-DD |
| riesgo_asegurado | Si | Objeto asegurado. | |
| numero_anexo | No | Número de anexo. | |
| prima | Si | Prima neta (Mensual ,semestral, anual ). | |
| nombre_asegurado | No | Nombres del afiliado. | |
| apellidos_asegurado | No | Apellidos del afiliado. | |
| cedula_asegurado | No | Documento del afiliado. | |
| parentesco | No | Parentesco. | |
| fecha_nacimiento_asegurado | No | Fecha de nacimiento. | YYYY-MM-DD |
| edad | No | Edad. | |
| genero | No | Género. | |
| celular | No | Celular. | |
| No | Correo. | ||
| direccion | No | Dirección. | |
| plan_afiliado | No | Plan afiliado. | |
| tipo_tarifa | No | Tipo tarifa. | |
| tipo_afiliacion | No | ID Tipo afiliación. | Mostrar valores |
| porcentaje_iva_prima | Si | IVA Prima. | |
| gastos_expedicion | No | Gastos de expedición. | |
| iva | No | IVA. | |
| total | No | Total. | |
| empresa | No | ID Cliente tipo Empresa. | |
| empleado | No | ID Cliente tipo Persona. | |
| observaciones | No | Observaciones. | |
| accesorios | No | Observaciones internas. | |
| beneficiario_oneroso | No | Beneficiario oneroso. |
{
"id": "9879908",
"poliza_numero_poliza": "VINCULADO ACTUALIZADO",
"fecha_inicio": "2021-04-15",
"fecha_fin": "",
"nombre_asegurado": "NOMBRE ASEGURADO",
"apellidos_asegurado": "APELLIDO ASEGURADO",
"cedula_asegurado": "0993324335",
"fecha_nacimiento_asegurado": "",
"genero": "",
"edad": "0",
"parentesco": "",
"direccion": "",
"email": "",
"celular": "",
"nombre_beneficiario": "",
"cedula_beneficiario": "",
"numero_anexo": "",
"numero_riesgo_asegurado": "0101010101",
"riesgo_asegurado": "56787-Riesgo",
"plan_afiliado": "",
"tipo_tarifa": "",
"porcentaje_iva_prima": "19.00",
"prima": "280000.00",
"editar_prima": "false",
"gastos_expedicion": "0.00",
"iva": "53200.00",
"iva_calculado": "true",
"total": "333200.00",
"accesorios": "",
"observaciones": "",
"fecha_retiro": "2021-05-03",
"motivo_retiro": "",
"retirado": "true",
"beneficiario_oneroso": "false",
"empresa": "3243235",
"empleado": "45446464",
"tipo_afiliacion": "",
"poliza": "2195256324325"
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza_id | Si | ID de la póliza. | ID |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Campo por el cual se ordenan los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 2,
"next": "null",
"previous": "null",
"results": [
{
"id": "1",
"poliza_numero_poliza": "VINCULADO 1",
"fecha_inicio": "2021-04-15",
"fecha_fin": "",
"nombre_asegurado": "NOMBRE ASEGURADO",
"apellidos_asegurado": "APELLIDO ASEGURADO",
"cedula_asegurado": "0993324335",
"fecha_nacimiento_asegurado": "",
"genero": "",
"edad": "0",
"parentesco": "",
"direccion": "",
"email": "",
"celular": "",
"nombre_beneficiario": "",
"cedula_beneficiario": "",
"numero_anexo": "",
"numero_riesgo_asegurado": "0101010101",
"riesgo_asegurado": "56787-Riesgo",
"plan_afiliado": "",
"tipo_tarifa": "",
"porcentaje_iva_prima": "19.00",
"prima": "280000.00",
"editar_prima": "false",
"gastos_expedicion": "0.00",
"iva": "53200.00",
"iva_calculado": "true",
"total": "333200.00",
"accesorios": "",
"observaciones": "",
"fecha_retiro": "2021-05-03",
"motivo_retiro": "",
"retirado": "true",
"beneficiario_oneroso": "false",
"empresa": "3243235",
"empleado": "45446464",
"tipo_afiliacion": "",
"poliza": "2195256324325"
},
{
"id": "2",
"poliza_numero_poliza": "VINCULADO 2",
"fecha_inicio": "2021-04-15",
"fecha_fin": "",
"nombre_asegurado": "NOMBRE ASEGURADO",
"apellidos_asegurado": "APELLIDO ASEGURADO",
"cedula_asegurado": "0993324335",
"fecha_nacimiento_asegurado": "",
"genero": "",
"edad": "0",
"parentesco": "",
"direccion": "",
"email": "",
"celular": "",
"nombre_beneficiario": "",
"cedula_beneficiario": "",
"numero_anexo": "",
"numero_riesgo_asegurado": "0101010101",
"riesgo_asegurado": "56787-Riesgo",
"plan_afiliado": "",
"tipo_tarifa": "",
"porcentaje_iva_prima": "19.00",
"prima": "280000.00",
"editar_prima": "false",
"gastos_expedicion": "0.00",
"iva": "53200.00",
"iva_calculado": "true",
"total": "333200.00",
"accesorios": "",
"observaciones": "",
"fecha_retiro": "2021-05-03",
"motivo_retiro": "",
"retirado": "true",
"beneficiario_oneroso": "false",
"empresa": "3243235",
"empleado": "45446464",
"tipo_afiliacion": "",
"poliza": "2195256324325"
}
]
}Este método es usado para la creación de Aseguradora.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre de la aseguradora. | |
| nit | Si | NIT de la aseguradora. Requerido solo para licencias de colombia. | |
| telefono | No | Número de telefono. | |
| direccion | No | Dirección de la aseguradora. | |
| No | Dirección email de la aseguradora. | ||
| numero_cuenta_bancaria | No | Número de cuenta bancaria de la aseguradora. | |
| url_pago | No | Link de pago que ofrece la aseguradora. |
{
"id": 346545645,
"nombre": "Aseguradora actualizada",
"telefono": "3698457895",
"nit": "0000-1",
"direccion": "Cll 0 # 54-3",
"email": "aseguradora@test.com",
"url_pago": "",
"numero_cuenta_bancaria": ""
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"nombre": "Aseguradora 1",
"telefono": "3698457895",
"nit": "0000-1",
"direccion": "Cll 0 # 54-3",
"email": "aseguradora@test.com",
"url_pago": "",
"numero_cuenta_bancaria": ""
},
{
"id": 2,
"nombre": "Aseguradora 2",
"telefono": "3698457895",
"nit": "0000-1",
"direccion": "Cll 0 # 54-3",
"email": "aseguradora@test.com",
"url_pago": "",
"numero_cuenta_bancaria": ""
}
]
}Este método es usado para la actualización de Aseguradora.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre de la aseguradora. | |
| nit | Si | NIT de la aseguradora. Requerido solo para licencias de colombia. | |
| telefono | No | Número de telefono. | |
| direccion | No | Dirección de la aseguradora. | |
| No | Dirección email de la aseguradora. | ||
| numero_cuenta_bancaria | No | Número de cuenta bancaria de la aseguradora. | |
| url_pago | No | Link de pago que ofrece la aseguradora. |
{
"id": 346545645,
"nombre": "Aseguradora actualizada",
"telefono": "3698457895",
"nit": "0000-1",
"direccion": "Cll 0 # 54-3",
"email": "aseguradora@test.com",
"url_pago": "",
"numero_cuenta_bancaria": ""
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_aseguradora | Si | ID del registro en softseguros. |
{
"id": 1,
"nombre": "Aseguradora 1",
"telefono": "3698457895",
"nit": "0000-1",
"direccion": "Cll 0 # 54-3",
"email": "aseguradora@test.com",
"url_pago": "",
"numero_cuenta_bancaria": ""
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"nombre": "Autos/Vehículos"
},
{
"id": 2,
"nombre": "Vida"
}
]
}Este método es usado para la creación de Subramos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| ramo_global | Si | ID del ramo principal. | Mostrar valores |
| nombre | Si | Nombre del Subramo. | |
| calcular_iva_a_gastos_expedicion | No | Calcular IVA a gatos de expedición. Solo aplica para pólizas individuales y sus anexos. | |
| en_mapa_oportunidad | No | Para la visualización de oportunidades en el mapa de oportunidades en el CRM. |
{
"id": "4564456",
"nombre_ramo_global": "Autos/Vehículos",
"nombre": "Subramo Autos",
"calcular_iva_a_gastos_expedicion": "false",
"en_mapa_oportunidad": "false",
"ramo_global": 11
}Este método es usado para la actualización de Subramos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del Subramo. | |
| calcular_iva_a_gastos_expedicion | No | Calcular IVA a gatos de expedición. Solo aplica para pólizas individuales y sus anexos. | |
| en_mapa_oportunidad | No | Para la visualización de oportunidades en el mapa de oportunidades en el CRM. |
{
"id": "4564456",
"nombre_ramo_global": "Autos/Vehículos",
"nombre": "Subramo Autos actualizado",
"calcular_iva_a_gastos_expedicion": "false",
"en_mapa_oportunidad": "false",
"ramo_global": 11
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"nombre_ramo_global": "Autos/Vehículos",
"nombre": "Autos",
"calcular_iva_a_gastos_expedicion": "true",
"en_mapa_oportunidad": "true",
"ramo_global": 11
},
{
"id": 2,
"nombre_ramo_global": "Vida",
"nombre": "Vida",
"calcular_iva_a_gastos_expedicion": "true",
"en_mapa_oportunidad": "true",
"ramo_global": 3
}
]
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_subramo | Si | ID del registro en softseguros. |
{
"id": 1,
"nombre_ramo_global": "Autos/Vehículos",
"nombre": "Autos",
"calcular_iva_a_gastos_expedicion": "true",
"en_mapa_oportunidad": "true",
"ramo_global": 11
}Este método es usado para asociar una aseguradora con un subramo, esta asociación se conoce cómo ramo y es el que se listará en el formulario de pólizas en el campo (Ramo).
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| aseguradora | Si | ID de la aseguradora. | Mostrar valores |
| ramo_marca | Si | ID del Ramo creado con anterioridad. | Mostrar valores |
| porcentajes_extra | Si | Array de objetos tipo texto. Es requerido para la configuracion de Porcentajes de comisión que se verá reflejado en la Póliza | [{'porcentaje_comision': '50.00','type': 'PRIMA','default': True, // Solo es posible tener un porcentaje por defecto, si se requiere un orcentaje adicional este campo estarpa en False}] |
| porcentaje_iva_prima | No | Porcentaje de IVA. | |
| has_beneficiarios | No | Marcar en True si el Subramo permite asignar multiples beneficiarios en póliza. |
{
"id": "76620145",
"aseguradora_nombre": "Aseguradora actualizada",
"porcentaje_iva_prima": "50.00",
"has_beneficiarios": "false",
"aseguradora": "9986856",
"ramo_global": "11",
"ramo_marca": "6831056"
}Este método es usado para la actualizar la asociación de una aseguradora con un subramo.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| porcentajes_extra | Si | Array de objetos tipo texto. Es requerido para la configuracion de Porcentajes de comisión que se verá reflejado en la Póliza | [{'id':'34546','porcentaje_comision': '50.00','type': 'PRIMA','default': True, // Solo es posible tener un porcentaje por defecto, si se requiere un orcentaje adicional este campo estarpa en False}] |
| porcentaje_iva_prima | No | Porcentaje de IVA. | |
| has_beneficiarios | No | Marcar en True si el Subramo permite asignar multiples beneficiarios en póliza. |
{
"id": "76620145",
"aseguradora_nombre": "Aseguradora actualizada",
"porcentaje_iva_prima": "50.00",
"has_beneficiarios": "false",
"aseguradora": "9986856",
"ramo_global": "11",
"ramo_marca": "6831056"
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_ramo | Si | ID del registro en softseguros. |
{
"id": "123",
"aseguradora_nombre": "Aseguradora",
"calcular_iva_a_gastos_expedicion": "true",
"nombre": "Nombre",
"porcentje_comicion": "100.00",
"porcentaje_impuesto_bomberos": "0.00",
"porcentaje_iva_prima": "0.00",
"comision_prima": "true",
"different_commissions_per_year": "false",
"has_coberturas": "false",
"has_beneficiarios": "false",
"aseguradora": "1234",
"ramo_global": "11",
"ramo_marca": "76620145"
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": "766201890",
"aseguradora_nombre": "Aseguradora actualizada",
"porcentajes": [
{
"id": "4700243345",
"porcentaje_comision": "50.00",
"type": "PRIMA",
"default": "true",
"ramo": "766201890"
},
{
"id": "4700246865",
"porcentaje_comision": "10.00",
"type": "PRIMA",
"default": "false",
"ramo": "766201890"
}
],
"porcentaje_iva_prima": "50.00",
"has_beneficiarios": "false",
"aseguradora": "9986844",
"ramo_global": "11",
"ramo_marca": "6831057"
}
]
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del estado de siniestro. | Choque |
| color | No | Hexadecimal, Color asignado al estado del siniestro. | #8A8A8A |
{
"id": 1,
"nombre": "Finalizado",
"color": "#8A8A8A"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Tipo de siniestro | Choque |
| color | No | Hexadecimal, Color asignado al estado del siniestro. | #8A8A8A |
{
"id": 1,
"nombre": "Finalizado",
"color": "#8A8A8A"
}Retorna todos los estados de siniestro registrados.
[
{
"id": 1,
"nombre": "SOLICITADO",
"color": "#00724D"
},
{
"id": 2,
"nombre": "FINALIZADO",
"color": "#8a8a8a"
}
]| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Tipo de siniestro | Choque |
| poliza | Si | ID de la póliza a la que pertenece este siniestro. | |
| amparo_afectado | Si | ID de estado de siniestro. | Mostrar valores |
| numero_siniestro_compania | No | Número de siniestro de la compañía. | |
| fecha_creacion | No | Fecha en que ocurre el siniestro YYYY-MM-DD. | YYYY-MM-DD |
| fecha_aviso | No | Fecha de aviso del siniestro YYYY-MM-DD. | |
| fecha_notificacion_aseguradora | No | Fecha notificación a segiradora YYYY-MM-DD. | YYYY-MM-DD |
| taller_asignado | No | Proveedor asignado. | |
| descripcion | No | Descripción(Hechos) | |
| riesgo_asegurado_vinculado | No | Número de riesgo asegurado si la póliza es colectiva. | |
| nombre_asegurado | No | Nombre del asegurado. | |
| documento_asegurado | No | Número de documento del asegurado. | |
| valor_indemnizacion | No | Valor indemnización. | |
| deducible | No | Deducible. | |
| monto_reclamo | No | Monto de reclamo. | |
| coaseguros | No | Coaseguros. | |
| finalizado | No | Marcar siniestro cómo finalizado | true, false |
| fecha_finalizacion | No | Fecha finalización YYYY-MM-DD. Llenar en caso del marcar el siniestro como finalizado. | YYYY-MM-DD |
{
"id": 1,
"poliza_codio_objeto_asegurado": "G48-468",
"ramo_nombre": "Autos individuales",
"ramo_aseguradora_nombre": "MAPFRE SEGUROS GENERALES DE COLOMBIA S.A.",
"estado_poliza_nombre": "09-Devengada",
"poliza_numero_poliza": "876567890000",
"poliza_cliente_nombres_": "TEST ClIENTE",
"poliza_cliente_apellidos_": "TEST APELLIDO",
"poliza_cliente_numero_documento_": "12627086",
"asegurado_vinculado": "",
"dias_ejecucion": "359",
"aseguradora": "9767",
"numero_siniestro": "1",
"numero_siniestro_compania": "GTHY-45",
"nombre": "CHOQUE",
"riesgo_asegurado_vinculado": "",
"descripcion": "",
"valor_indemnizacion": "0.00",
"porcentaje_siniestralidad": "0.00",
"resolucion": "",
"finalizado": "false",
"fecha_finalizacion": "",
"fecha_creacion": "2020-09-01",
"fecha_notificacion_aseguradora": "2020-09-03",
"deducible": "0.00",
"coaseguros": "0.00",
"monto_reclamo": "0.00",
"observacion": "",
"taller_asignado": "",
"fecha_aviso": "2020-09-03",
"nombre_asegurado": "",
"documento_asegurado": "343243243",
"poliza": "32315",
"riesgo_asegurado": "",
"amparo_afectado": "5356457"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Tipo de siniestro | Choque |
| poliza | Si | ID de la póliza a la que pertenece este siniestro. | |
| amparo_afectado | Si | ID de estado de siniestro. | Mostrar valores |
| numero_siniestro_compania | No | Número de siniestro de la compañía. | |
| fecha_creacion | No | Fecha en que ocurre el siniestro YYYY-MM-DD. | YYYY-MM-DD |
| fecha_aviso | No | Fecha de aviso del siniestro YYYY-MM-DD. | |
| fecha_notificacion_aseguradora | No | Fecha notificación a segiradora YYYY-MM-DD. | YYYY-MM-DD |
| taller_asignado | No | Proveedor asignado. | |
| descripcion | No | Descripción(Hechos) | |
| riesgo_asegurado_vinculado | No | Número de riesgo asegurado si la póliza es colectiva. | |
| nombre_asegurado | No | Nombre del asegurado. | |
| documento_asegurado | No | Número de documento del asegurado. | |
| valor_indemnizacion | No | Valor indemnización. | |
| deducible | No | Deducible. | |
| monto_reclamo | No | Monto de reclamo. | |
| coaseguros | No | Coaseguros. | |
| finalizado | No | Marcar siniestro cómo finalizado | true, false |
| fecha_finalizacion | No | Fecha finalización YYYY-MM-DD. Llenar en caso del marcar el siniestro como finalizado. | YYYY-MM-DD |
{
"id": 1,
"poliza_codio_objeto_asegurado": "G48-468",
"ramo_nombre": "Autos individuales",
"ramo_aseguradora_nombre": "MAPFRE SEGUROS GENERALES DE COLOMBIA S.A.",
"estado_poliza_nombre": "09-Devengada",
"poliza_numero_poliza": "876567890000",
"poliza_cliente_nombres_": "TEST ClIENTE",
"poliza_cliente_apellidos_": "TEST APELLIDO",
"poliza_cliente_numero_documento_": "12627086",
"asegurado_vinculado": "",
"dias_ejecucion": "359",
"aseguradora": "9767",
"numero_siniestro": "1",
"numero_siniestro_compania": "GTHY-45",
"nombre": "CHOQUE",
"riesgo_asegurado_vinculado": "",
"descripcion": "",
"valor_indemnizacion": "0.00",
"porcentaje_siniestralidad": "0.00",
"resolucion": "",
"finalizado": "false",
"fecha_finalizacion": "",
"fecha_creacion": "2020-09-01",
"fecha_notificacion_aseguradora": "2020-09-03",
"deducible": "0.00",
"coaseguros": "0.00",
"monto_reclamo": "0.00",
"observacion": "",
"taller_asignado": "",
"fecha_aviso": "2020-09-03",
"nombre_asegurado": "",
"documento_asegurado": "343243243",
"poliza": "32315",
"riesgo_asegurado": "",
"amparo_afectado": "5356457"
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"poliza_codio_objeto_asegurado": "G48-468",
"ramo_nombre": "Autos individuales",
"ramo_aseguradora_nombre": "MAPFRE SEGUROS GENERALES DE COLOMBIA S.A.",
"estado_poliza_nombre": "09-Devengada",
"poliza_numero_poliza": "876567890000",
"poliza_cliente_nombres_": "TEST ClIENTE",
"poliza_cliente_apellidos_": "TEST APELLIDO",
"poliza_cliente_numero_documento_": "12627086",
"asegurado_vinculado": "",
"dias_ejecucion": "359",
"aseguradora": "9767",
"numero_siniestro": "1",
"numero_siniestro_compania": "GTHY-45",
"nombre": "CHOQUE",
"riesgo_asegurado_vinculado": "",
"descripcion": "",
"valor_indemnizacion": "0.00",
"porcentaje_siniestralidad": "0.00",
"resolucion": "",
"finalizado": "false",
"fecha_finalizacion": "",
"fecha_creacion": "2020-09-01",
"fecha_notificacion_aseguradora": "2020-09-03",
"deducible": "0.00",
"coaseguros": "0.00",
"monto_reclamo": "0.00",
"observacion": "",
"taller_asignado": "",
"fecha_aviso": "2020-09-03",
"nombre_asegurado": "",
"documento_asegurado": "343243243",
"poliza": "32315",
"riesgo_asegurado": "",
"amparo_afectado": "5356457"
},
{
"id": 2,
"poliza_codio_objeto_asegurado": "G48-468",
"ramo_nombre": "Autos individuales",
"ramo_aseguradora_nombre": "MAPFRE SEGUROS GENERALES DE COLOMBIA S.A.",
"estado_poliza_nombre": "09-Devengada",
"poliza_numero_poliza": "876567890000",
"poliza_cliente_nombres_": "TEST ClIENTE",
"poliza_cliente_apellidos_": "TEST APELLIDO",
"poliza_cliente_numero_documento_": "12627086",
"asegurado_vinculado": "",
"dias_ejecucion": "359",
"aseguradora": "9767",
"numero_siniestro": "1",
"numero_siniestro_compania": "GTHY-45",
"nombre": "CHOQUE",
"riesgo_asegurado_vinculado": "",
"descripcion": "",
"valor_indemnizacion": "0.00",
"porcentaje_siniestralidad": "0.00",
"resolucion": "",
"finalizado": "false",
"fecha_finalizacion": "",
"fecha_creacion": "2020-09-01",
"fecha_notificacion_aseguradora": "2020-09-03",
"deducible": "0.00",
"coaseguros": "0.00",
"monto_reclamo": "0.00",
"observacion": "",
"taller_asignado": "",
"fecha_aviso": "2020-09-03",
"nombre_asegurado": "",
"documento_asegurado": "343243243",
"poliza": "32315",
"riesgo_asegurado": "",
"amparo_afectado": "5356457"
}
]
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| siniestro | Si | ID del siniestro al que se asignará este amparo afectado. | #8A8A8A |
| nombre_reclamante | Si | Nombre del reclamante. | |
| amparo | Si | Nombre del amparo afectado. | |
| valor | No | Valor. |
{
"id": 1,
"nombre": "Finalizado",
"color": "#8A8A8A"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| siniestro | Si | ID del siniestro al que se asignará este amparo afectado. | #8A8A8A |
| nombre_reclamante | Si | Nombre del reclamante. | |
| amparo | Si | Nombre del amparo afectado. | |
| valor | No | Valor. |
{
"id": 1,
"nombre": "Finalizado",
"color": "#8A8A8A"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| siniestro_id | Si | ID del siniestro. | ID |
[
{
"id": 1,
"nombre_reclamante": "Reclamante",
"amparo": "da\u00f1os parciales",
"valor": "5300.00"
},
{
"id": 2,
"nombre_reclamante": "Reclamante 2",
"amparo": "test",
"valor": "50000.00"
}
]Este método es usado para la creación de clientes tanto Empresas como Personas naturales.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| tipo_documento | Si | El tipo de documento nit solo se envía cuando se quiere crear un cliente de tipo "Empresa" | nit, cedula, cedula extranjeria, ruc, pasaporte, nuip, tarjeta de identidad, id_residencia |
| numero_documento | Si | Número de documento o NIT del cliente. | |
| nombres | Si | ||
| apellidos | Si | Este campo no es requerido para clientes de tipo "Empresa" | |
| genero | Si | MASCULINO, FEMENINO | |
| fecha_nacimiento | Si | ||
| direccion | Si | Dirección principal | |
| telefono | Si | Teléfono principal | |
| celular | Si | Celular principal | |
| Si | Email principal | ||
| otra_ocupacion | Si | Nombre de la ocupación o actividad económica | |
| enviar_correo_polizas_vencidas | No | Notificaciones asistente virtual | true, false |
| enviar_sms_poliza_por_vencer | No | Notificaciones asistente virtual | true, false |
| enviar_correo_cartera_por_vencer | No | Notificaciones asistente virtual | true, false |
| enviar_sms_cartera_por_vencer | No | Notificaciones asistente virtual | true, false |
{
"id": 1,
"categorias": [
{
"id": 1,
"nombre": "Categoría ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categoría ejemplo 2",
"color": "#000"
}
],
"sedes": [
{
"id": 1,
"nombre": "Sucursal 1"
}
],
"tipo_cliente": "Prospecto",
"numero_documento": "123456789",
"nombres": "Prueba Cliente",
"apellidos": "Demo Agencia de Seguros",
"direccion": "Bogotá DC, Colombia",
"tipo_documento": "cedula",
"model_tipo_documento": "",
"model_tipo_documento_code": "01",
"telefono": "123456",
"email": "prueba@email.com",
"celular": "67891011",
"observaciones": "",
"fecha_nacimiento": "2000-01-01",
"fecha_expedicion_cedula": "",
"genero": "MASCULINO",
"ocupacion": "",
"otra_ocupacion": "Esta es mi ocupación",
"ocupacion_string": "Esta es mi ocupación",
"enviar_correo_polizas_vencidas": true,
"enviar_sms_poliza_por_vencer": true,
"enviar_correo_cartera_por_vencer": true,
"enviar_sms_cartera_por_vencer": true,
"enviar_correo_notificacion_renovacion": false,
"perfil_social": "",
"pagina_web": "",
"tipo_direccion": "",
"tipo_telefono": "",
"tipo_celular": "",
"tipo_email": "",
"tiene_hijos": "",
"numero_hijos": "",
"tiene_casa_propia": "",
"numero_casas_propias": "",
"tiene_vehiculo": "",
"numero_vehiculos": "",
"ingreso_mensual": "",
"patrimonio": "",
"estado_civil": "",
"tratamiento_de_datos": "",
"estrato": ""
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| numero_documento | Si | Número de documento del cliente a consultar |
{
"id": 1,
"categorias": [
{
"id": 1,
"nombre": "Categoría ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categoría ejemplo 2",
"color": "#000"
}
],
"sedes": [
{
"id": 1,
"nombre": "Sucursal 1"
}
],
"tipo_cliente": "Prospecto",
"numero_documento": "123456789",
"nombres": "Prueba Cliente",
"apellidos": "Demo Agencia de Seguros",
"direccion": "Bogotá DC, Colombia",
"tipo_documento": "cedula",
"model_tipo_documento": "",
"model_tipo_documento_code": "01",
"telefono": "123456",
"email": "prueba@email.com",
"celular": "67891011",
"observaciones": "",
"fecha_nacimiento": "2000-01-01",
"fecha_expedicion_cedula": "",
"genero": "MASCULINO",
"ocupacion": "",
"otra_ocupacion": "Esta es mi ocupación",
"ocupacion_string": "Esta es mi ocupación",
"enviar_correo_polizas_vencidas": true,
"enviar_sms_poliza_por_vencer": true,
"enviar_correo_cartera_por_vencer": true,
"enviar_sms_cartera_por_vencer": true,
"enviar_correo_notificacion_renovacion": false,
"perfil_social": "",
"pagina_web": "",
"tipo_direccion": "",
"tipo_telefono": "",
"tipo_celular": "",
"tipo_email": "",
"tiene_hijos": "",
"numero_hijos": "",
"tiene_casa_propia": "",
"numero_casas_propias": "",
"tiene_vehiculo": "",
"numero_vehiculos": "",
"ingreso_mensual": "",
"patrimonio": "",
"estado_civil": "",
"tratamiento_de_datos": "",
"estrato": ""
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_cliente | Si | ID del registro en softseguros. |
{
"id": 1,
"categorias": [
{
"id": 1,
"nombre": "Categoría ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categoría ejemplo 2",
"color": "#000"
}
],
"sedes": [
{
"id": 1,
"nombre": "Sucursal 1"
}
],
"tipo_cliente": "Prospecto",
"numero_documento": "123456789",
"nombres": "Prueba Cliente",
"apellidos": "Demo Agencia de Seguros",
"direccion": "Bogotá DC, Colombia",
"tipo_documento": "cedula",
"model_tipo_documento": "",
"model_tipo_documento_code": "01",
"telefono": "123456",
"email": "prueba@email.com",
"celular": "67891011",
"observaciones": "",
"fecha_nacimiento": "2000-01-01",
"fecha_expedicion_cedula": "",
"genero": "MASCULINO",
"ocupacion": "",
"otra_ocupacion": "Esta es mi ocupación",
"ocupacion_string": "Esta es mi ocupación",
"enviar_correo_polizas_vencidas": true,
"enviar_sms_poliza_por_vencer": true,
"enviar_correo_cartera_por_vencer": true,
"enviar_sms_cartera_por_vencer": true,
"enviar_correo_notificacion_renovacion": false,
"perfil_social": "",
"pagina_web": "",
"tipo_direccion": "",
"tipo_telefono": "",
"tipo_celular": "",
"tipo_email": "",
"tiene_hijos": "",
"numero_hijos": "",
"tiene_casa_propia": "",
"numero_casas_propias": "",
"tiene_vehiculo": "",
"numero_vehiculos": "",
"ingreso_mensual": "",
"patrimonio": "",
"estado_civil": "",
"tratamiento_de_datos": "",
"estrato": ""
}El listado devuelve un máximo de 10 registros por cada pagina.
Para hacer el paginado de lo datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Campo por el cual se ordenan los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"categorias": [
{
"id": 1,
"nombre": "Categoría ejemplo 1",
"color": "#C13D94"
},
{
"id": 2,
"nombre": "Categoría ejemplo 2",
"color": "#000"
}
],
"sedes": [
{
"id": 1,
"nombre": "Sucursal 1"
}
],
"nombres": "Carlos Alfredo",
"apellidos": "García",
"direccion": "Pereira, Risaralda",
"numero_documento": "123456789",
"tipo_documento": "cedula",
"model_tipo_documento": "1",
"model_tipo_documento_code": "01",
"telefono": "+57 9123456",
"email": "softseguros@gmail.com",
"celular": "+57 312345678",
"observaciones": "",
"fecha_nacimiento": null,
"genero": "MASCULINO",
"tipo_cliente": "Prospecto",
"estado_civil": null,
"enviar_correo_polizas_vencidas": true,
"enviar_sms_poliza_por_vencer": false,
"enviar_correo_cartera_por_vencer": true,
"enviar_sms_cartera_por_vencer": false
}
]
}[
{
"id": 1,
"tipo": "Email",
"codigo_tipo": 1
},
{
"id": 2,
"tipo": "Dirección",
"codigo_tipo": 2
},
{
"id": 3,
"tipo": "Teléfono",
"codigo_tipo": 3
},
{
"id": 4,
"tipo": "Celular",
"codigo_tipo": 4
},
{
"id": 5,
"tipo": "Hijo",
"codigo_tipo": 5
},
{
"id": 6,
"tipo": "Vehículo",
"codigo_tipo": 6
}
]Este método es usado para la creación de información CRM de tipo autos para clientes naturales.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 6 |
| texto | Si | JSON tipo texto. | {"placa_dato_extra":"PLACA","fecha_soat_dato_extra":"YYYY-MM-DD","fecha_impuestos_dato_extra":"YYYY-MM-DD","fecha_tecnomecanica_dato_extra":"YYYY-MM-DD"} |
{
"id": "010101",
"tipo": {
"tipo": "Vehículo",
"codigo_tipo": 6
},
"texto": "{\"placa_dato_extra\":\"PLACA\",\"fecha_soat_dato_extra\":\"YYYY-MM-DD\",\"fecha_impuestos_dato_extra\":\"YYYY-MM-DD\",\"fecha_tecnomecanica_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
}Este método es usado para la creación de información CRM de tipo Hijos para clientes naturales.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 5 |
| texto | Si | JSON tipo texto. | {"nombre_dato_extra":"Nombre","telefono_dato_extra":"000101010","fecha_nacimiento_dato_extra":"YYYY-MM-DD"} |
{
"id": "622097",
"tipo": {
"tipo": "Hijo",
"codigo_tipo": 5
},
"texto": "{\"nombre_dato_extra\":\"Nombre\",\"telefono_dato_extra\":\"000101010\",\"fecha_nacimiento_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
}Este método es usado para la creación de datos extra tipo celular para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 4 |
| texto | Si | Numero de celular. | 3114567768 |
{
"id": "62210187",
"tipo": {
"tipo": "Celular",
"codigo_tipo": 4
},
"texto": "3114567768",
"tipo_dato": "2",
"cliente": "76656"
}Este método es usado para la creación de datos extra tipo teléfono para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 3 |
| texto | Si | Numero de teléfono. | 9872568899 |
{
"id": "98622100",
"tipo": {
"tipo": "Teléfono",
"codigo_tipo": 3
},
"texto": "dfg545475754",
"tipo_dato": "4",
"cliente": "456345"
}Este método es usado para la creación de datos extra tipo dirección para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 2 |
| texto | Si | Dirección. | Av #0-00 |
{
"id": "576896",
"tipo": {
"tipo": "Dirección",
"codigo_tipo": 2
},
"texto": "Av #0-00",
"tipo_dato": "3",
"cliente": "89867567"
}Este método es usado para la creación de datos extra tipo email para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el dato extra. | ID |
| codigo_tipo | Si | Código único para el tipo de dato extra. | 3 |
| texto | Si | Email. | email@email.com |
{
"id": 622102,
"tipo": {
"tipo": "Email",
"codigo_tipo": 1
},
"texto": "email@email.com",
"tipo_dato": "1",
"cliente": 1444610
}Este método es usado para la actualización de Información CRM Autos para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| texto | Si | JSON tipo texto Autos. | {"placa_dato_extra":"PLACA","fecha_soat_dato_extra":"YYYY-MM-DD","fecha_impuestos_dato_extra":"YYYY-MM-DD","fecha_tecnomecanica_dato_extra":"YYYY-MM-DD"} |
{
"id": "010101",
"tipo": {
"tipo": "Vehículo",
"codigo_tipo": 6
},
"texto": "{\"placa_dato_extra\":\"PLACA\",\"fecha_soat_dato_extra\":\"YYYY-MM-DD\",\"fecha_impuestos_dato_extra\":\"YYYY-MM-DD\",\"fecha_tecnomecanica_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
}Este método es usado para la actualización de Información CRM Hijos para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL. | |
| texto | Si | JSON tipo texto hijos. | {"nombre_dato_extra":"Nombre","telefono_dato_extra":"000101010","fecha_nacimiento_dato_extra":"YYYY-MM-DD"} |
{
"id": "622097",
"tipo": {
"tipo": "Hijo",
"codigo_tipo": 5
},
"texto": "{\"nombre_dato_extra\":\"Nombre\",\"telefono_dato_extra\":\"000101010\",\"fecha_nacimiento_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
}Este método es usado para la actualización de datos extra tipo celular para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL. | |
| texto | Si | Numero de celular. | 3114567768 |
{
"id": "62210187",
"tipo": {
"tipo": "Celular",
"codigo_tipo": 4
},
"texto": "3114567768",
"tipo_dato": "2",
"cliente": "76656"
}Este método es usado para la actualización de datos extra tipo teléfono para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL. | |
| texto | Si | Numero de teléfono. | 9872568899 |
{
"id": "98622100",
"tipo": {
"tipo": "Teléfono",
"codigo_tipo": 3
},
"texto": "dfg545475754",
"tipo_dato": "4",
"cliente": "456345"
}Este método es usado para la actualización de datos extra tipo dirección para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL. | |
| texto | Si | Dirección. | Av #0-00 |
{
"id": "576896",
"tipo": {
"tipo": "Dirección",
"codigo_tipo": 2
},
"texto": "Av #0-00",
"tipo_dato": "3",
"cliente": "89867567"
}Este método es usado para la actualización de datos extra tipo email para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL. | |
| texto | Si | Email. | email@email.com |
{
"id": 622102,
"tipo": {
"tipo": "Email",
"codigo_tipo": 1
},
"texto": "email@email.com",
"tipo_dato": "1",
"cliente": 1444610
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_datoextra | Si | ID del registro en softseguros. pasar en la URL |
[
{
"id": "010101",
"tipo": {
"tipo": "Vehículo",
"codigo_tipo": 6
},
"texto": "{\"placa_dato_extra\":\"PLACA\",\"fecha_soat_dato_extra\":\"YYYY-MM-DD\",\"fecha_impuestos_dato_extra\":\"YYYY-MM-DD\",\"fecha_tecnomecanica_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
},
{
"id": "622097",
"tipo": {
"tipo": "Hijo",
"codigo_tipo": 5
},
"texto": "{\"nombre_dato_extra\":\"Nombre\",\"telefono_dato_extra\":\"000101010\",\"fecha_nacimiento_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
}
]Este listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_cliente | No | Listar datos extra / Información CRM por ID del cliente. Si se quiere consultar los datos de un cliente en específico. | |
| documento_cliente | No | Listar datos extra / Información CRM por número docuemnto del cliente. Si se quiere consultar los datos de un cliente en específico. | |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": "010101",
"tipo": {
"tipo": "Vehículo",
"codigo_tipo": 6
},
"texto": "{\"placa_dato_extra\":\"PLACA\",\"fecha_soat_dato_extra\":\"YYYY-MM-DD\",\"fecha_impuestos_dato_extra\":\"YYYY-MM-DD\",\"fecha_tecnomecanica_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
},
{
"id": "622097",
"tipo": {
"tipo": "Hijo",
"codigo_tipo": 5
},
"texto": "{\"nombre_dato_extra\":\"Nombre\",\"telefono_dato_extra\":\"000101010\",\"fecha_nacimiento_dato_extra\":\"YYYY-MM-DD\"}",
"tipo_dato": "null",
"cliente": "54643001"
},
{
"id": "622097",
"tipo": {
"tipo": "Celular",
"codigo_tipo": 4
},
"texto": "546457453",
"tipo_dato": "2",
"cliente": "54643001"
},
{
"id": "622097",
"tipo": {
"tipo": "Teléfono",
"codigo_tipo": 3
},
"texto": "dfg545475754",
"tipo_dato": "4",
"cliente": "54643001"
},
{
"id": "576896",
"tipo": {
"tipo": "Dirección",
"codigo_tipo": 2
},
"texto": "Av #0-00",
"tipo_dato": "3",
"cliente": "89867567"
},
{
"id": "622097",
"tipo": {
"tipo": "Email",
"codigo_tipo": 1
},
"texto": "test@test.com",
"tipo_dato": "1",
"cliente": "54643001"
}
]
}Listar ocupaciones cliente Natural/Jurídico. El listado de ocupaciones devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| empresa | No | Parámetro para filtra las ocupaciones de cliente natural o jurídica . | true, false |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"nombre": "TECNÓLOGO INDUSTRIAL",
"empresa": "false"
},
{
"id": 2,
"nombre": "TRANSPORTE DE CARGA POR CARRETERA",
"empresa": "true"
}
]
}Este método es usado para la creación de contactos para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el contacto. | ID |
| nombre | Si | Nombre del contacto. | |
| apellido | No | Apellido del contacto | |
| documento | No | Número de documento del contacto. | |
| tipo_documento | No | Tipo documento contacto. | |
| direccion | No | Dirección del contacto. | |
| telefono | No | Teléfono del contacto. | |
| No | Email del contacto. | ||
| celular | No | Celular del contacto. | |
| fecha_nacimiento | No | Fecha nacimiento contacto. | YYYY-MM-DD |
| observaciones | No | Observaciones. | |
| cargo | No | Cargo que desempeña. | |
| parentesco | No | Parentesco con el cliente. |
{
"id": 151615345,
"cliente": 10686786209,
"cliente_documento": "45573575474",
"cliente_nombres": "Prueba Cliente",
"cliente_apellidos": "Demo Agencia de Seguros",
"nombre": "Prueba contacto",
"apellido": "Demo Agencia de Seguros",
"fecha_nacimiento": "1989-04-20",
"documento": "54654654",
"direccion": "",
"telefono": "",
"email": "info@info.com",
"celular": "45645647",
"observaciones": "",
"cargo": "",
"tipo_documento": "CÉDULA",
"parentesco": "Prueba"
}Este método es usado para la actualización de contactos para clientes.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| cliente | Si | ID del cliente al cual será agregado el contacto. | ID |
| nombre | Si | Nombre del contacto. | |
| apellido | No | Apellido del contacto | |
| documento | No | Número de documento del contacto. | |
| tipo_documento | No | Tipo documento contacto. | |
| direccion | No | Dirección del contacto. | |
| telefono | No | Teléfono del contacto. | |
| No | Email del contacto. | ||
| celular | No | Celular del contacto. | |
| fecha_nacimiento | No | Fecha nacimiento contacto. | YYYY-MM-DD |
| observaciones | No | Observaciones. | |
| cargo | No | Cargo que desempeña. | |
| parentesco | No | Parentesco con el cliente. |
{
"id": 151615345,
"cliente": 10686786209,
"cliente_documento": "45573575474",
"cliente_nombres": "Prueba Cliente",
"cliente_apellidos": "Demo Agencia de Seguros",
"nombre": "Prueba contacto",
"apellido": "Demo Agencia de Seguros",
"fecha_nacimiento": "1989-04-20",
"documento": "54654654",
"direccion": "",
"telefono": "",
"email": "info@info.com",
"celular": "45645647",
"observaciones": "cliente actualizado",
"cargo": "",
"tipo_documento": "CÉDULA",
"parentesco": "Prueba"
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_contacto | Si | ID del registro en softseguros. |
{
"id": 151615345,
"cliente": 10686786209,
"cliente_documento": "45573575474",
"cliente_nombres": "Prueba Cliente",
"cliente_apellidos": "Demo Agencia de Seguros",
"nombre": "Prueba contacto",
"apellido": "Demo Agencia de Seguros",
"fecha_nacimiento": "1989-04-20",
"documento": "54654654",
"direccion": "",
"telefono": "",
"email": "info@info.com",
"celular": "45645647",
"observaciones": "",
"cargo": "",
"tipo_documento": "CÉDULA",
"parentesco": "Prueba"
}El listado de contactos devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_cliente | No | Listar contactos por ID del cliente. Si se quiere consultar los datos de un cliente en específico. |
| documento_cliente | No | Listar contactos por ID del cliente. Si se quiere consultar los datos de un cliente en específico. |
| created_at_ini | No | Fecha inicio de creación del contacto. |
| created_at_fin | No | Fecha fin de creación de contacto. |
| page | No | Número de la página que se desea consultar. |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. |
| order | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1557457161,
"cliente": 10686786209,
"cliente_documento": "45573575474",
"cliente_nombres": "Prueba Cliente",
"cliente_apellidos": "Demo Agencia de Seguros",
"nombre": "Prueba contacto",
"apellido": "Demo Agencia de Seguros",
"fecha_nacimiento": "1989-04-20",
"documento": "54654654",
"direccion": "",
"telefono": "",
"email": "info@info.com",
"celular": "45645647",
"observaciones": "",
"cargo": "",
"tipo_documento": "CÉDULA",
"parentesco": "Prueba"
}
]
}Este método permite la creación individual y múltiple de pagos a una póliza o anexo.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| fecha_pago | Si | Fecha de pago | |
| cuotas | Si | # Cuotas | |
| pago_a | Si | Cada | Mostrar valores |
| valor_pagar_mensual | Si | Valor a pagar | |
| comision_a_recibir | Si | Comisión a recibir | |
| anexo_poliza | No | ID del Anexo | |
| observaciones_pago_m | No | Observaciones |
[
{
"id": 1,
"fecha_pago": "2019-12-31",
"valor_a_pagar": 10000.0,
"comision_a_recibir": 1000.0,
"poliza": 1,
"anexo_poliza": 1,
"observaciones": "",
"numero_pago": 1
},
{
"id": 2,
"fecha_pago": "2020-12-31",
"valor_a_pagar": 10000.0,
"comision_a_recibir": 1000.0,
"poliza": 1,
"anexo_poliza": 1,
"observaciones": "",
"numero_pago": 2
}
]| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del negocio | |
| asesor | Si | ID del vendedor al que se le asignará | |
| ramo_global | Si | Ramo | |
| cliente | Si | ID del cliente, necesariamente creado previamente, lo puedes consultar en / Clientes > Consultar cliente por número de documento | |
| etapa | Si | ID de la etapa, por defecto se asigna 1 | Mostrar valores |
{
"id": 1,
"numero_solicitud": 1,
"nombre": "Mi negocio de prueba",
"asesor": 1,
"etapa": 1,
"ramo_global": 1,
"ramo_global_nombre": "Autos",
"cliente": 1,
"cliente_documento": "9003222222-1",
"cliente_nombre_completo": "Primer Cliente Prueba",
"cliente_telefono": "123456",
"cliente_email": "Softseguros@softseguros.com",
"cliente_celular": "123456789"
}| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del negocio | |
| asesor | Si | ID del vendedor al que se le asignará | |
| ramo_global | Si | Ramo | |
| cliente | Si | ID del cliente, necesariamente creado previamente, lo puedes consultar en / Clientes > Consultar cliente por número de documento | |
| etapa | Si | ID de la etapa | Mostrar valores |
{
"id": 1,
"numero_solicitud": 1,
"nombre": "Mi negocio de prueba",
"asesor": 1,
"etapa": 1,
"ramo_global": 1,
"ramo_global_nombre": "Autos",
"cliente": 1,
"cliente_documento": "9003222222-1",
"cliente_nombre_completo": "Primer Cliente Prueba",
"cliente_telefono": "123456",
"cliente_email": "Softseguros@softseguros.com",
"cliente_celular": "123456789"
}{
"id": 1,
"numero_solicitud": 1,
"nombre": "Mi negocio de prueba",
"asesor": 1,
"etapa": 1,
"ramo_global": 1,
"ramo_global_nombre": "Autos",
"cliente": 1,
"cliente_documento": "9003222222-1",
"cliente_nombre_completo": "Primer Cliente Prueba",
"cliente_telefono": "123456",
"cliente_email": "softseguros@softseguros.com",
"cliente_celular": "123456567"
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción |
|---|---|---|
| page | No | Número de la página que se desea consultar. |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. |
{
"count": 90,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": 1,
"numero_solicitud": 1,
"nombre": "Mi negocio de prueba",
"asesor": 1,
"etapa": 1,
"ramo_global": 1,
"ramo_global_nombre": "Autos",
"cliente": 1,
"cliente_documento": "9003222222-1",
"cliente_nombre_completo": "Primer Cliente Prueba",
"cliente_telefono": "123456",
"cliente_email": "softseguros@softseguros.com",
"cliente_celular": "123456567"
},
{
"id": 2,
"numero_solicitud": 2,
"nombre": "Mi negocio de prueba",
"asesor": 1,
"etapa": 1,
"ramo_global": 1,
"ramo_global_nombre": "Autos",
"cliente": 1,
"cliente_documento": "9003222222-1",
"cliente_nombre_completo": "Primer Cliente Prueba",
"cliente_telefono": "123456",
"cliente_email": "softseguros@softseguros.com",
"cliente_celular": "123456567"
}
]
}| Nombre del campo | Requerido | Descripción |
|---|---|---|
| id_archivo | Si | ID del archivo, lo puedes consultar en Archivos |
El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| poliza_id | Si | ID de la póliza, lo puedes consultar en / Polizas > Listar pólizas por ID del cliente | |
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Nombre del Campo por el cual se ordenarán los registros. | id |
| sort_by | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 2,
"next": "null",
"previous": "null",
"results": [
{
"id": 1,
"nombre": "SAMPLE1",
"anclado": false,
"tipo_anexo_nombre": "Carátula",
"extension": "pdf",
"file_storage_name": ""
},
{
"id": 2,
"nombre": "SAMPLE2",
"anclado": true,
"tipo_anexo_nombre": "Documento",
"extension": "pdf",
"file_storage_name": ""
}
]
}Este método es usado para la creación de categorías para clientes y/o pólizas.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre de la categoría. | |
| tipo | Si | Tipo de categoría (póliza o cliente). | cliente, poliza, crm_campaign |
| color | No | Hexadecimal del color d ela categoría. | #238AE6 |
{
"id": "35324",
"nombre": "Facebook leads",
"color": "#238AE6",
"tipo": "poliza"
}Este método es usado para la actualización de categorías para clientes y/o pólizas.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| id_categoria | Si | ID del registro en softseguros. pasar en la URL. | |
| nombre | Si | Nombre de la categoría. | |
| color | No | Hexadecimal del color d ela categoría. | #238AE8 |
{
"id": "35324",
"nombre": "Facebook leads",
"color": "#238AE8",
"tipo": "poliza"
}Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción |
|---|---|---|
| tipo | No | Listar todas las categorías por el tipo de categoria. |
[
{
"id": 1,
"nombre": "nuevo",
"color": "#4D6724",
"tipo": "cliente"
},
{
"id": 2,
"nombre": "HOGAR2",
"color": "#E924E7",
"tipo": "poliza"
},
{
"id": 3,
"nombre": "Vida 2020",
"color": "#D04ED5",
"tipo": "crm_campaign"
}
]Este método es usado para la creación de vendedores.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del vendedor. | |
| tipo_documento | No | ID tipo documento del vendedor. | Mostrar valores |
| cedula | No | Número de documento del vendedor. | |
| telefono | No | Teléfono del vendedor. | |
| celular | No | Celular del vendedor.. | |
| No | Email del vendedor. | ||
| numero_cuenta_bancaria | No | Número de cuenta del vendedor. | |
| tipo_persona | No | Natural (Persona), Jurídica (Empresa) | natural, juridica |
| es_agencia | No | Determina si el Vendedor registrado es agencia. | True, False |
| participacion | No | Porcentaje de participación del vendedor en las pólizas, (Solo números) | |
| custom_commission_percent | No | Incluir en True si tiene Porcentaje de participación. | |
| comision_prima | No | Calcular la comisión sobre el valor de prima neta. | True, False |
| retencion | Si | Porcentaje de retención, (Solo números). | |
| retencion_ica_porcentaje | No | Porcentaje de retención de ICA, (Solo números). | |
| iva_porcentaje | Si | Porcentaje IVA, (Solo números). | |
| retencion_iva_porcentaje | No | Porcentaje de retención IVA. (Solo números). | |
| sede | Si | Sede a la que pertenece el vendedor. | Mostrar valores |
{
"id": "2152656",
"comision_prima_nombre": "agencia",
"nombre": "Softseguros-Colombia",
"cedula": "",
"telefono": "",
"celular": "",
"email": "",
"numero_cuenta_bancaria": "",
"participacion": "100.00",
"retencion": "0.0000",
"iva_porcentaje": "0.00",
"retencion_ica_porcentaje": "0.00000",
"retencion_iva_porcentaje": "0.00",
"tipo_persona": "natural",
"es_agencia": "false",
"comision_prima": "false",
"tipo_documento": "CC",
"custom_commission_percent": "true",
"sede": 5902
}Este método es usado para la actualización de vendedor.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| nombre | Si | Nombre del vendedor. | |
| tipo_documento | No | ID tipo documento del vendedor. | Mostrar valores |
| cedula | No | Número de documento del vendedor. | |
| telefono | No | Teléfono del vendedor. | |
| celular | No | Celular del vendedor.. | |
| No | Email del vendedor. | ||
| numero_cuenta_bancaria | No | Número de cuenta del vendedor. | |
| tipo_persona | No | Natural (Persona), Jurídica (Empresa) | natural, juridica |
| es_agencia | No | Determina si el Vendedor registrado es agencia. | True, False |
| participacion | No | Porcentaje de participación del vendedor en las pólizas, (Solo números) | |
| custom_commission_percent | No | Incluir en True si tiene Porcentaje de participación. | |
| comision_prima | No | Calcular la comisión sobre el valor de prima neta. | True, False |
| retencion | Si | Porcentaje de retención, (Solo números). | |
| retencion_ica_porcentaje | No | Porcentaje de retención de ICA, (Solo números). | |
| iva_porcentaje | Si | Porcentaje IVA, (Solo números). | |
| retencion_iva_porcentaje | No | Porcentaje de retención IVA. (Solo números). | |
| sede | Si | Sede a la que pertenece el vendedor. | Mostrar valores |
{
"id": "2152656",
"comision_prima_nombre": "agencia",
"nombre": "Softseguros-Colombia",
"cedula": "",
"telefono": "",
"celular": "",
"email": "",
"numero_cuenta_bancaria": "",
"participacion": "100.00",
"retencion": "0.0000",
"iva_porcentaje": "0.00",
"retencion_ica_porcentaje": "0.00000",
"retencion_iva_porcentaje": "0.00",
"tipo_persona": "natural",
"es_agencia": "false",
"comision_prima": "false",
"tipo_documento": "CC",
"custom_commission_percent": "true",
"sede": 5902
}El listado devuelve un máximo de 10 registros por cada pagina.
Campos para filtrado y paginación de los datos.
| Nombre del campo | Requerido | Descripción | Posibles valores |
|---|---|---|---|
| page | No | Número de la página que se desea consultar. | 2,3,4,5,6..... |
| order_by | No | Campo por el cual se ordenan los registros. | id |
| order | No | Ordena los registros (Ascendente o Descendente) por el campo seleccionado. | asc, desc |
{
"count": 171,
"next": "page=3",
"previous": "page=1",
"results": [
{
"id": "2152656",
"comision_prima_nombre": "agencia",
"nombre": "Softseguros-Colombia",
"cedula": "",
"telefono": "",
"celular": "",
"email": "",
"numero_cuenta_bancaria": "",
"participacion": "100.00",
"retencion": "0.0000",
"iva_porcentaje": "0.00",
"retencion_ica_porcentaje": "0.00000",
"retencion_iva_porcentaje": "0.00",
"tipo_persona": "natural",
"es_agencia": "false",
"comision_prima": "false",
"tipo_documento": "CC",
"custom_commission_percent": "true",
"sede": 5902
},
{
"id": "35535346",
"comision_prima_nombre": "agencia",
"nombre": "Softseguros-Colombia2",
"cedula": "",
"telefono": "",
"celular": "",
"email": "",
"numero_cuenta_bancaria": "",
"participacion": "100.00",
"retencion": "0.0000",
"iva_porcentaje": "0.00",
"retencion_ica_porcentaje": "0.00000",
"retencion_iva_porcentaje": "0.00",
"tipo_persona": "natural",
"es_agencia": "false",
"comision_prima": "false",
"tipo_documento": "CC",
"custom_commission_percent": "true",
"sede": 5902
}
]
}