Documento
Consulta
Obtener Listado de Documentos
Para obtener todos los documentos de la cuenta hacemos uso del endpoint:
GET https://api.contifico.com/sistema/api/v1/registro/documento/
Query Parameters
Parámetro | Tipo | Longitud | Descripción |
---|---|---|---|
tipo_registro | varchar | 3 | CLI -> Cliente PRO -> Proveedor. |
tipo | varchar | 3 | tipo de documento a consultar (FAC:factura, LQC:liquidacion de compra). |
fecha_emision | date | - | fecha de emisión del documento. |
fecha_vencimiento | date | - | fecha de vencimiento del documento. |
fecha_creacion | date | - | fecha de creación del documento. |
persona_identificacion | varchar | 200 | identificación de la persona del documento. |
result_size | int | cantidad de resultados por consulta. | |
result_page | int | número de página que se quiere obtener. | |
fecha_inicial | date | - | Filtro de fecha inicial con respecto a la fecha de emisión. |
fecha_final | date | - | Filtro de fecha final con respecto a la fecha de emisión. |
persona_id | varchar | 16 | Filtro apartir de la persona asociada al documento <ID> . |
bodega_id | varchar | 16 | Filtro apartir de la bodega asociada al documento <ID> . |
Ejemplo:
GET https://api.contifico.com/sistema/api/v1/registro/documento/?tipo_registro=CLI&fecha_emision=24/01/2019
Nos devolverá todos los documentos de tipo cliente emitidos el 24/01/2019.
Obtener un Documento
GET https://api.contifico.com/sistema/api/v1/documento/<ID>
Devuelve un documento con el <ID>
solicitado.
Ejemplo:
{
"iva": "12.00",
"tarjeta_consumo_id": null,
"vendedor": null,
"pos": null,
"vendedor_id": null,
"logistica": null,
"subtotal_0": "0.0",
"ice": "0.0",
"descripcion": "prueba",
"total": "11200.0",
"id": "usdjcbjsydhcsjd",
"subtotal_12": "10000.0",
"servicio": "0.0",
"detalles": [
{
"producto_id": "RZxg87rxLh9Mb1pV",
"cantidad": 1.00,
"precio": 1.00,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 1.00,
"base_no_gravable": 0.00,
"porcentaje_ice": 15,
"valor_ice" : null,
"irbpnr": "0.02",
}
],
"referencia": "",
"saldo_anticipo": null,
"tipo_domicilio": null,
"autorizacion": "5454654546",
"hora_evento": null,
"url_ride": "http://capacitacion.desarrollo.contifico.com/sistema/registro/documento/ride/NABjszT3.pdf",
"fecha_creacion": "17/05/2020",
"cobros": [
{
"forma_cobro": "CQ",
"numero_comprobante": "CHEQUE",
"caja_id": null,
"monto": "10000.0",
"numero_tarjeta": null,
"fecha": "17/05/2020",
"nombre_tarjeta": null,
"tipo_banco": null,
"cuenta_bancaria_id": null,
"bin_tarjeta": null,
"monto_propina": null,
"numero_cheque": "201307000001",
"fecha_cheque": null,
"tipo_ping": null,
"id": "O9pgenoW9F6aNQxy",
"lote": null
}
],
"tipo_descuento": null,
"orden_domicilio_id": null,
"fecha_vencimiento": "17/05/2021",
"documento_relacionado_id": null,
"fecha_emision": "17/05/2021",
"vendedor_identificacion": null,
"documento": "001-001-000000251",
"adicional2": "",
"firmado": false,
"adicional1": "",
"hora_emision": null,
"url_xml": "http://capacitacion.desarrollo.contifico.com/sistema/registro/documento/xml/NABjszT3/",
"cliente": {
"ruc": "0922054366001",
"cedula": "0922054366",
"razon_social": "Nombres del Cliente",
"telefonos": "0988800001",
"direccion": "Direccion cliente",
"tipo": "N",
"email": "cliente@contifico.com",
"es_extranjero": false
},
"saldo": "10000.00",
"entregado": true,
"tipo_registro": "CLI",
"url_": null,
"estado": "P",
"persona_id": "P3RBe3KA52uReLJr",
"tipo_documento": "FAC",
"fecha_evento": null,
"electronico": true,
"direccion_evento": null,
"placa": null,
"pax": null,
"anulado": false,
"caja_id": null
}
Parámetro | Tipo | Longitud | Descripción |
---|---|---|---|
iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). |
tarjeta_consumo_id | varchar | 16 | Identificador de la tarjeta de consumo en el sistema. |
vendedor | objeto | - | Objeto de la persona vendedor. |
pos | varchar | 36 | API Token del POS. |
vendedor_id | varchar | 16 | Identificador de la persona vendedor en el sistema. |
logistica | boolean | 1 | Indicador si el documento esta marcado para logistica (Modulo Adicional). |
subtotal_0 | decimal | 10 | Representa el valor subtotal |
ice | decimal | 10 | Representa el valor del ic del documento. |
descripcion | text | - | Explicación del documento. |
total | decimal | 13 | Valor total del movimiento. |
id | varchar | 16 | Identificador del documento en el sistema. |
subtotal_12 | decimal | 10 | Representa el valor Subtotal del iva del documento. |
servicio | decimal | 13 | Representa el valor del porcentaje de servicio del documento. |
detalles | objeto | - | objeto contenedor de los items a facturar del documento. |
producto_id | varchar | 16 | Identificador del producto en el sistema. |
cantidad | decimal | 20 | Indica la cantidad del producto en el movimiento (14 int, 6 decimal)max. |
precio | decimal | 13 | Valor del producto en especifico. |
porcentaje_iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). |
porcentaje_descuento | decimal | 10 | Representa el valor Subtotal del iva del documento. |
base_cero | decimal | 10 | Representa el valor del producto si grava 0% iva. |
base_gravable | decimal | 10 | Representa el valor del producto si grava 12% iva. |
base_no_gravable | decimal | 10 | Representa el valor del producto si no grava iva. |
porcentaje_ice | SmallIntegerField | - | Representa el valor porcentual de ice que grava el producto. |
valor_ice | decimal | 10 | Representa el valor entero de ice que grava el producto. |
irbpnr | decimal | 10 | Representa el valor de irbpnr del producto. |
referencia | varchar | 300 | Dato adicional de la factura. |
saldo_anticipo | decimal | 10 | Valor del producto en especifico. |
tipo_domicilio | varchar | 2 | Campo para asociacion de delivery del documento (UB:uber, GL:glovo) (Modulo Adicional). |
autorizacion | varchar | 49 | Numero de autorizacion del documento. |
hora_evento | time | - | Representa el valor del producto si grava 0% iva. |
fecha_creacion | date | Fecha de creacion del documento. | |
cobros | objeto | - | objeto contenedor de los cobros del documento. |
forma_cobro | varchar | 10 | Tipo de documento a aplicar el cobro o pago de la transacción (Ver lista tipos cobro). |
numero_comprobante | varchar | 15 | Secuencia unica que identifica la transacción. |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. |
monto | decimal | 10 | Valor total del documento detalle relacionado. |
numero_tarjeta | varchar | 10 | Numero de tarjeta bancaria supereasy (Modulo adicional). |
fecha | date | - | Fecha que se realiza la transacción. |
nombre_tarjeta | varchar | 300 | Nombre de tarjeta bancaria supereasy (Modulo adicional). |
tipo_banco | char | 300 | Nombre del banco supereasy (Modulo adicional). |
cuenta_bancaria_id | varchar | 16 | Identificador de la cuenta bancaria en el sistema. |
bin_tarjeta | varchar | 10 | Numero de tarjeta bancaria supereasy (Modulo adicional). |
monto_propina | decimal | 10 | Represeta el valor de la propina por un servicio. |
numero_cheque | varchar | 15 | Numero de cheque en la transacción. |
fecha_cheque | Date | - | Fecha del cheque. |
tipo_ping | varchar | 1 | Tipo de transaccion con TC (D:datafast, M:medianet, E:dataexpress, P:placetopay, A:alignet) |
id | varchar | 16 | Identificador del cobro en el sistema. |
tipo_descuento | varchar | 1 | Identificador del tipo de descuento que tiene asignado el documento (P:porcentual, U:unitario). |
orden_domicilio_id | varchar | 16 | Id de la orden de delivery (Modulo adicional). |
fecha_vencimiento | Date | - | Fecha limite de vigencia del documento. |
documento_relacionado_id | varchar | 16 | Identificador del documento relacion al documento actual el sistema. |
fecha_emision | date | - | Fecha de emision del documento. |
vendedor_identificacion | varchar | 10 | Cedula del vendedor asignado al documento. |
documento | varchar | 17 | Numero del documento. |
adicional2 | varchar | 300 | Dato adicional de la factura. |
firmado | boolean | 1 | Indicador si el documento esta firmado. |
adicional1 | varchar | 300 | Dato adicional de la factura. |
hora_emision | Time | - | Hora de emision del documento. |
cliente | objeto | - | objeto contenedor del cliente del documento. |
ruc | varchar | 13 | Ruc de la persona. |
cedula | varchar | 10 | Cedula de la persona. |
razon_social | varchar | 300 | Razon social de la persona. |
telefonos | varchar | 300 | Telefono de la persona. |
direccion | varchar | 300 | Direccion de la persona. |
tipo | varchar | 1 | Tipo de persona (N:Natural J:Juridica I:SinId P:Placa). |
varchar | 50 | Correo de la persona. | |
es_extranjero | bool | Verificador de personas extranjeras. | |
saldo | decimal | 10 | Identificador del tipo de descuento que tiene asignado el documento (P:porcentual, U:unitario). |
entregado | boolean | 1 | Indica si el documento ha sido entregado. |
tipo_registro | varchar | 3 | Indica el tipo de registro del documento (CLI:cliente, PRO:proveedor). |
estado | varchar | 1 | Indicador del estado del documento (P:pendiente, C:cobrado, G:pagado, A:anulado, E:generado, F:facturado). |
persona_id | varchar | 16 | Indentificador de la persona asociada al documento. |
tipo_documento | varchar | 3 | Tipo de registro del documento (FAC:factura, LQC:liquidacion de compra). |
fecha_evento | date | - | Fecha evento del documento (Modulo Adicional). |
electronico | boolean | - | Indica si el documento es electronico. |
direccion_evento | varchar | 300 | Direccion del evento del documento (Modulo Adicional). |
placa | varchar | 13 | Placa de la persona si es de tipo placa. |
pax | int | pax del documento (Modulo Adicional). | |
anulado | boolean | 1 | Indica si el documento esta anulado. |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. |
Creación
Documento Tipo Cliente
Este servicio permite agregar un nuevo documento a Contifico.
Para crear un documento se debe hacer uso de la url:
POST https://api.contifico.com/sistema/api/v1/documento/
por medio del método POST enviando en el cuerpo del requerimiento los datos del documento:
Ejemplo:
{
"pos" : "ceaa9097-1d76-4eb8-0000-6f412fa0297b",
"fecha_emision": "01/11/2015",
"tipo_documento": "FAC",
"documento": "001-001-000008089",
"estado": "P",
"autorizacion": "0123456789",
"caja_id": null,
"cliente": {
"ruc": "0922054366001",
"cedula": "0922054366",
"razon_social": "Nombres del Cliente",
"telefonos": "0988800001",
"direccion": "Direccion cliente",
"tipo": "N",
"email": "cliente@contifico.com",
"es_extranjero": false
},
"vendedor": {
"ruc": "0904728680001",
"cedula": "0904728680",
"razon_social": "Nombres del Vendedor",
"telefonos": "5104910",
"direccion": "direccion del vendedor",
"tipo": "N",
"email": "vendedor@contifico.com",
"es_extranjero": false
},
"descripcion": "FACTURA 8040",
"subtotal_0": 0.00,
"subtotal_12": 1.35,
"iva": 0.16,
"ice": 0.00,
"servicio": 0.00,
"total": 1.51,
"adicional1": "",
"adicional2": "",
"detalles": [{
"producto_id": "RZxg87rxLh9Mb1pV",
"cantidad": 1.00,
"precio": 1.00,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 1.00,
"base_no_gravable": 0.00,
"porcentaje_ice": 15,
"valor_ice" : null
},
{
"producto_id": "YqxgeprxLh9981cU",
"cantidad": 1.00,
"precio": 0.35,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 0.35,
"base_no_gravable": 0.00
}],
"cobros":[{
"forma_cobro" : "TC",
"monto" : 1.51,
"numero_cheque" : "4567897",
"tipo_ping" : "D"
}]
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
fecha_emision | date | - | Fecha de emision del documento. | Si |
tipo_documento | varchar | 3 | Tipo de registro del documento (FAC:factura, LQC:liquidacion de compra). | Si |
documento | varchar | 17 | Numero del documento. | Si |
estado | varchar | 1 | Indicador del estado del documento (P:pendiente, C:cobrado, G:pagado, A:anulado, E:generado, F:facturado). | No |
autorizacion | varchar | 49 | Numero de autorizacion del documento. | Si |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. | No |
cliente | objeto | - | objeto contenedor del cliente del documento. | Si |
ruc | varchar | 13 | Ruc de la persona. | Opcional |
cedula | varchar | 10 | Cedula de la persona. | Si |
razon_social | varchar | 300 | Razon social de la persona. | Si |
telefonos | varchar | 300 | Telefono de la persona. | No |
direccion | varchar | 300 | Direccion de la persona. | No |
tipo | varchar | 1 | Tipo de persona (N:Natural J:Juridica I:SinId P:Placa). | Si |
varchar | 50 | Correo de la persona. | No | |
es_extranjero | bool | Verificador de personas extranjeras. | No | |
Vendedor | objeto | - | objeto contenedor del vendedor del documento | No |
descripcion | text | - | Explicación del documento. | No |
subtotal_0 | decimal | 10 | Representa el valor subtotal (8 int, 2 decimal)max | Si |
subtotal_12 | decimal | 10 | Representa el valor Subtotal del iva del documento (8 int, 2 decimall)max. | Si |
ice | SmallIntegerField | - | Valor total de ICE que graba el producto con este impuesto (valor o porcentaje ice * cantidad del producto). | Si |
iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | Si |
servicio | decimal | 10 | Representa el valor del porcentaje de servicio del documento (8 int, 2 decimal)max. | No |
total | decimal | 10 | Valor total del movimiento (8 int, 2 decimal)max. | Si |
adicional1 | varchar | 300 | Dato adicional de la factura. | No |
adicional2 | varchar | 300 | Dato adicional de la factura. | No |
detalles | objeto | - | objeto contenedor de los items facturados del documento | Si |
producto_id | varchar | 16 | Identificador del producto en el sistema. | Si |
cantidad | decimal | 13 | Indica la cantidad del producto en el movimiento (7 int, 6 decimal)max. | Si |
precio | decimal | 13 | Valor del producto en especifico (7 int, 6 decimal)max. | Si |
porcentaje_iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | No |
porcentaje_descuento | decimal | 10 | Representa el valor Subtotal del iva del documento. | Si |
base_cero | decimal | 10 | Representa el valor del producto si grava 0% iva (8 int, 2 decimal). | Si |
base_gravable | decimal | 10 | Representa el valor del producto si grava 12% iva (8 int, 2 decimal). | Si |
base_no_gravable | decimal | 10 | Representa el valor del producto si no grava iva (8 int, 2 decimal). | Si |
porcentaje_ice | SmallIntegerField | - | Representa el valor porcentual de ice que grava el producto. | |
valor_ice | decimal | 10 | Representa el valor entero de ice que grava el producto. | |
cobros | objeto | - | objeto contenedor de los cobros del documento. | Opcional |
forma_cobro | varchar | 10 | Tipo de documento a aplicar el cobro o pago de la transacción (Ver lista tipos cobro). | Si |
monto | decimal | 10 | Valor total del documento detalle relacionado (8 int, 2 decimal). | Si |
numero_cheque | varchar | 15 | Numero de cheque en la transacción. | No |
tipo_ping | varchar | 1 | Tipo de transaccion con TC (D:datafast, M:medianet, E:dataexpress, P:placetopay, A:alignet) | Si |
NOTA:
Para los casos de productos con impuesto ice se debe incluir el campo porcentaje_ice
o valor_ice
dependiendo de como este configurado el producto; el valor total por ice se debe incluir en el campo ice
siguiendo el formato del json de ejemplo.
Para el caso de productos con impuesto IRBPNR se debe incluir en el campo total
agregado el valor total de irbpnr que genera el producto, es decir;
Ejemplo: si tiene un documento con un total
de 1.25(incluidos iva e ice) y el irbpnr que graba su producto es de 0.02, el total
seria 1.27
Documento Tipo Proveedor
Este servicio permite agregar un nuevo documento a Contifico.
Para crear un documento tipo proveedor se debe hacer uso de la url:
POST https://api.contifico.com/sistema/api/v1/documento/
por medio del método POST enviando en el cuerpo del requerimiento los datos del documento:
Ejemplo:
{
"pos" : "e4ee7f87-471c-4110-8c2f-15dae1e44ac4",
"fecha_emision": "07/08/2018",
"tipo_documento": "FAC",
"tipo_registro" : "PRO",
"documento": "333-001-002008012",
"autorizacion": "0123456787",
"caja_id": null,
"persona": {
"ruc": "",
"cedula": "0922078352",
"razon_social": "Andres Gomez",
"telefonos": "0988845001",
"direccion": "Direccion cliente",
"tipo": "N",
"email": "cliente@contifico.com",
"es_extranjero": false
},
"descripcion": "FACTURA 8040",
"subtotal_0": 0.00,
"subtotal_12": 1.35,
"iva": 0.16,
"ice":0.00,
"servicio": 0.00,
"total": 1.51,
"adicional1": "",
"adicional2": "",
"detalles": [{
"producto_id": "x4LmavQwkcENe3Nr",
"cantidad": 1.00,
"precio": 1.00,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 1.00,
"base_no_gravable": 0.00,
"porcentaje_ice": 15,
"valor_ice" : null
},
{
"producto_id": "x4LmavQwkcENe3Nr",
"cantidad": 1.00,
"precio": 0.35,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 0.35,
"base_no_gravable": 0.00
}]
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
fecha_emision | date | - | Fecha de emision del documento. | Si |
tipo_documento | varchar | 3 | Tipo de registro del documento (FAC:factura, LQC:liquidacion de compra). | Si |
tipo_registro | varchar | 3 | Indica el tipo de registro del documento (CLI:cliente, PRO:proveedor). | Si |
documento | varchar | 17 | Numero del documento. | Si |
estado | varchar | 1 | Indicador del estado del documento (P:pendiente, C:cobrado, G:pagado, A:anulado, E:generado, F:facturado). | No |
autorizacion | varchar | 49 | Numero de autorizacion del documento. | Si |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. | No |
cliente | objeto | - | objeto contenedor del cliente del documento. | Si |
ruc | varchar | 13 | Ruc de la persona. | Opcional |
cedula | varchar | 10 | Cedula de la persona. | Si |
razon_social | varchar | 300 | Razon social de la persona. | Si |
telefonos | varchar | 300 | Telefono de la persona. | No |
direccion | varchar | 300 | Direccion de la persona. | No |
tipo | varchar | 1 | Tipo de persona (N:Natural J:Juridica I:SinId P:Placa). | Si |
varchar | 50 | Correo de la persona. | No | |
es_extranjero | bool | Verificador de personas extranjeras. | No | |
Vendedor | objeto | - | objeto contenedor del vendedor del documento | No |
descripcion | text | - | Explicación del documento. | No |
subtotal_0 | decimal | 10 | Representa el valor subtotal (8 int, 2 decimal)max | Si |
subtotal_12 | decimal | 10 | Representa el valor Subtotal del iva del documento (8 int, 2 decimall)max. | Si |
ice | SmallIntegerField | - | Valor total de ICE que graba el producto con este impuesto (valor o porcentaje ice * cantidad del producto). | Si |
iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | Si |
servicio | decimal | 10 | Representa el valor del porcentaje de servicio del documento (8 int, 2 decimal)max. | No |
total | decimal | 10 | Valor total del movimiento (8 int, 2 decimal)max. | Si |
adicional1 | varchar | 300 | Dato adicional de la factura. | No |
adicional2 | varchar | 300 | Dato adicional de la factura. | No |
detalles | objeto | - | objeto contenedor de los items facturados del documento | Si |
producto_id | varchar | 16 | Identificador del producto en el sistema. | Si |
cantidad | decimal | 13 | Indica la cantidad del producto en el movimiento (7 int, 6 decimal)max. | Si |
precio | decimal | 13 | Valor del producto en especifico (7 int, 6 decimal)max. | Si |
porcentaje_iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | No |
porcentaje_descuento | decimal | 10 | Representa el valor Subtotal del iva del documento. | Si |
base_cero | decimal | 10 | Representa el valor del producto si grava 0% iva (8 int, 2 decimal). | Si |
base_gravable | decimal | 10 | Representa el valor del producto si grava 12% iva (8 int, 2 decimal). | Si |
base_no_gravable | decimal | 10 | Representa el valor del producto si no grava iva (8 int, 2 decimal). | Si |
porcentaje_ice | SmallIntegerField | - | Representa el valor porcentual de ice que grava el producto. | |
valor_ice | decimal | 10 | Representa el valor entero de ice que grava el producto. | |
cobros | objeto | - | objeto contenedor de los cobros del documento. | Opcional |
forma_cobro | varchar | 10 | Tipo de documento a aplicar el cobro o pago de la transacción (Ver lista tipos cobro). | Si |
monto | decimal | 10 | Valor total del documento detalle relacionado (8 int, 2 decimal). | Si |
numero_cheque | varchar | 15 | Numero de cheque en la transacción. | No |
tipo_ping | varchar | 1 | Tipo de transaccion con TC (D:datafast, M:medianet, E:dataexpress, P:placetopay, A:alignet) | Si |
NOTA:
Para los casos de productos con impuesto ice se debe incluir el campo porcentaje_ice
o valor_ice
dependiendo de como este configurado el producto; el valor total por ice se debe incluir en el campo ice
siguiendo el formato del json de ejemplo.
Para el caso de productos con impuesto IRBPNR se debe incluir en el campo total
agregado el valor total de irbpnr que genera el producto, es decir;
Ejemplo: si tiene un documento con un total
de 1.25(incluidos iva e ice) y el irbpnr que graba su producto es de 0.02, el total
seria 1.27
Documento Tipo Prefactura
Este servicio permite agregar una nueva prefactura a Contifico.
Para crear una Prefactura se debe hacer uso de la url:
POST https://api.contifico.com/sistema/api/v1/documento/
{
"pos" : "ffc3de27-fb4c-48b4-a06e-a129cf37ea99",
"fecha_emision": "26/01/2016",
"tipo_documento": "PRE",
"estado": "P",
"caja_id": "",
"cliente": {
"ruc": "",
"cedula": "0922054366",
"razon_social": "Andres Gomez",
"telefonos": "",
"direccion": "",
"tipo": "N",
"email": "",
"es_extranjero": false
},
"vendedor": "",
"descripcion": "DETALLE PREFACTURA",
"subtotal_0": 0.00,
"subtotal_12": 125.00,
"iva": 20.00,
"total": 140.00,
"adicional1": "165582/165581/165580/165579/165578/",
"detalles": [{
"producto_id": "x4LmavQwkcENe3No",
"cantidad": 1.00,
"precio": 125.00,
"porcentaje_iva": 12,
"porcentaje_descuento": 0.00,
"base_cero": 0.00,
"base_gravable": 125.00,
"base_no_gravable": 0.00
}]
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
fecha_emision | date | - | Fecha de emision del documento. | Si |
tipo_documento | varchar | 3 | Tipo de registro del documento (PRE:prefactura). | Si |
tipo_registro | varchar | 3 | Indica el tipo de registro del documento (CLI:cliente, PRO:proveedor). | Si |
documento | varchar | 17 | Numero del documento. | Si |
estado | varchar | 1 | Indicador del estado del documento (P:pendiente, C:cobrado, G:pagado, A:anulado, E:generado, F:facturado). | No |
autorizacion | varchar | 49 | Numero de autorizacion del documento. | Si |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. | No |
cliente | objeto | - | objeto contenedor del cliente del documento. | Si |
ruc | varchar | 13 | Ruc de la persona. | Opcional |
cedula | varchar | 10 | Cedula de la persona. | Si |
razon_social | varchar | 300 | Razon social de la persona. | Si |
telefonos | varchar | 300 | Telefono de la persona. | No |
direccion | varchar | 300 | Direccion de la persona. | No |
tipo | varchar | 1 | Tipo de persona (N:Natural J:Juridica I:SinId P:Placa). | Si |
varchar | 50 | Correo de la persona. | No | |
es_extranjero | bool | Verificador de personas extranjeras. | No | |
Vendedor | objeto | - | objeto contenedor del vendedor del documento | No |
descripcion | text | - | Explicación del documento. | No |
subtotal_0 | decimal | 10 | Representa el valor subtotal (8 int, 2 decimal)max | Si |
subtotal_12 | decimal | 10 | Representa el valor Subtotal del iva del documento (8 int, 2 decimall)max. | Si |
iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | Si |
servicio | decimal | 10 | Representa el valor del porcentaje de servicio del documento (8 int, 2 decimal)max. | No |
total | decimal | 10 | Valor total del movimiento (8 int, 2 decimal)max. | Si |
adicional1 | varchar | 300 | Dato adicional de la factura. | No |
adicional2 | varchar | 300 | Dato adicional de la factura. | No |
detalles | objeto | - | objeto contenedor de los items facturados del documento | Si |
producto_id | varchar | 16 | Identificador del producto en el sistema. | Si |
cantidad | decimal | 13 | Indica la cantidad del producto en el movimiento (7 int, 6 decimal)max. | Si |
precio | decimal | 13 | Valor del producto en especifico (7 int, 6 decimal)max. | Si |
porcentaje_iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | No |
porcentaje_descuento | decimal | 10 | Representa el valor Subtotal del iva del documento. | Si |
base_cero | decimal | 10 | Representa el valor del producto si grava 0% iva (8 int, 2 decimal). | Si |
base_gravable | decimal | 10 | Representa el valor del producto si grava 12% iva (8 int, 2 decimal). | Si |
base_no_gravable | decimal | 10 | Representa el valor del producto si no grava iva (8 int, 2 decimal). | Si |
NOTA: El json enviado es similar al de una factura de cliente; Se debe indicar el campo tipo_documento
en "PRE", el campo de numero de documento es asignado automaticamente por la secuencia actual de prefacturas registradas en el sistema.
Actualización
Este servicio permite modificar un documento creado por API en Contífico.
Para modificar un documento se debe hacer uso de la url:
PUT https://api.contifico.com/sistema/api/v1/documento/
Los datos que se envian al momento de la actualización son los mismos que al momento de la creación aumentando el parámetro "id" dentro del json.
{
"id" : "7ujk93jdhsieu839",
"vendedor": null,
"fecha_emision": "10/06/2013",
"documento": "221-321-321321321",
"pos": "e4ee7f87-471c-4110-8c2f-15dae1e44ac4",
"fecha_vencimiento": "10/06/2013",
"subtotal_0": "0.0",
"descripcion": "prueba",
"total": "11200.0",
"servicio": null,
"electronico": false,
"iva": "1200.0",
"cobros": [
{
"forma_cobro": "CQ",
"monto": "10000.0",
"fecha": "01/07/2013",
"numero_tarjeta": null,
"numero_cheque": "201307000001",
"tipo_ping": null
}
],
"detalles": [
{
"porcentaje_iva": 12,
"cantidad": "500.0",
"base_no_gravable": "0.0",
"precio": "20.0",
"porcentaje_descuento": "0.0",
"descripcion": null,
"producto_id": "MRYWb4kJoHz0aZ1m",
"base_cero": "0.0",
"base_gravable": "10000.0"
}
],
"adicional2": "",
"adicional1": "",
"estado": "P",
"tipo_documento": "FAC",
"autorizacion": "5454654546",
"id_caja": "",
"subtotal_12": "10000.0",
"cliente": {
"ruc": "0922054366001",
"cedula": "0922054366",
"razon_social": "Nombres del Cliente",
"telefonos": "0988800001",
"direccion": "Direccion cliente",
"tipo": "N",
"email": "cliente@contifico.com",
"es_extranjero": false
}
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
id | varchar | 16 | Identificador del documento a modificar | Si |
pos | varchar | 36 | API Token del POS. | Si |
fecha_emision | date | - | Fecha de emision del documento. | Si |
tipo_documento | varchar | 3 | Tipo de registro del documento (FAC:factura, LQC:liquidacion de compra). | Si |
tipo_registro | varchar | 3 | Indica el tipo de registro del documento (CLI:cliente, PRO:proveedor). | Si |
documento | varchar | 17 | Numero del documento. | Si |
estado | varchar | 1 | Indicador del estado del documento (P:pendiente, C:cobrado, G:pagado, A:anulado, E:generado, F:facturado). | No |
autorizacion | varchar | 49 | Numero de autorizacion del documento. | Si |
caja_id | varchar | 16 | Identificador de la caja desde la cual se realiza la transaccion. | No |
cliente | objeto | - | objeto contenedor del cliente del documento. | Si |
ruc | varchar | 13 | Ruc de la persona. | Opcional |
cedula | varchar | 10 | Cedula de la persona. | Si |
razon_social | varchar | 300 | Razon social de la persona. | Si |
telefonos | varchar | 300 | Telefono de la persona. | No |
direccion | varchar | 300 | Direccion de la persona. | No |
tipo | varchar | 1 | Tipo de persona (N:Natural J:Juridica I:SinId P:Placa). | Si |
varchar | 50 | Correo de la persona. | No | |
es_extranjero | bool | Verificador de personas extranjeras. | No | |
Vendedor | objeto | - | objeto contenedor del vendedor del documento | No |
descripcion | text | - | Explicación del documento. | No |
subtotal_0 | decimal | 10 | Representa el valor subtotal (8 int, 2 decimal)max | Si |
subtotal_12 | decimal | 10 | Representa el valor Subtotal del iva del documento (8 int, 2 decimall)max. | Si |
iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | Si |
servicio | decimal | 10 | Representa el valor del porcentaje de servicio del documento (8 int, 2 decimal)max. | No |
total | decimal | 10 | Valor total del movimiento (8 int, 2 decimal)max. | Si |
adicional1 | varchar | 300 | Dato adicional de la factura. | No |
adicional2 | varchar | 300 | Dato adicional de la factura. | No |
detalles | objeto | - | objeto contenedor de los items facturados del documento | Si |
producto_id | varchar | 16 | Identificador del producto en el sistema. | Si |
cantidad | decimal | 13 | Indica la cantidad del producto en el movimiento (7 int, 6 decimal)max. | Si |
precio | decimal | 13 | Valor del producto en especifico (7 int, 6 decimal)max. | Si |
porcentaje_iva | SmallIntegerField | - | Valor de porcentaje de IVA que tiene el producto (0, 12, null). | No |
porcentaje_descuento | decimal | 10 | Representa el valor Subtotal del iva del documento. | Si |
base_cero | decimal | 10 | Representa el valor del producto si grava 0% iva (8 int, 2 decimal). | Si |
base_gravable | decimal | 10 | Representa el valor del producto si grava 12% iva (8 int, 2 decimal). | Si |
base_no_gravable | decimal | 10 | Representa el valor del producto si no grava iva (8 int, 2 decimal). | Si |
cobros | objeto | - | objeto contenedor de los cobros del documento. | Opcional |
forma_cobro | varchar | 10 | Tipo de documento a aplicar el cobro o pago de la transacción (Ver lista tipos cobro). | Si |
monto | decimal | 10 | Valor total del documento detalle relacionado (8 int, 2 decimal). | Si |
numero_cheque | varchar | 15 | Numero de cheque en la transacción. | No |
tipo_ping | varchar | 1 | Tipo de transaccion con TC (D:datafast, M:medianet, E:dataexpress, P:placetopay, A:alignet) | Si |