Cruce de Documentos
Cruce de Documentos
Se permite registrar un cruce de un documento con el siguiente endpoint:
`POST https://api.contifico.com/sistema/api/v1/documento/<ID>/cruce/`
donde el parámetro <ID>
es el ID de integración del documento (devuelto al momento de su creación).
Formato del JSON
{
"pos" : "e4ee7f87-471c-4110-8c2f-15dae1e44ac4",
"caja_id": "7ujk93jdhsieu830",
"monto": "20.0",
"documento_id": "7ujk93jdhsieu831",
"descripcion" : "Cruce de Documento",
"fecha": "31/07/2020",
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
caja_id | varchar | 16 | ID de integración de la caja del POS (opcional). | Si |
monto | decimal | 10 | Valor de la transacción (8 int, 2 decimal)max. | Si |
documento_id | varchar | 16 | ID de integración del documento con el que se hará el cruce. | Si |
descripcion | varchar | 300 | Descripción de la transacción | Si |
fecha | date | - | Fecha de la transacción | Si |
NOTA: Para poder hacer uso del cruce de un documento mediante api, uno de los dos documentos a cruzar debe haber sido creado mediante API, el <ID>
del documento creado desde API es el que se incluira en la url POST
.
Cruce de un Documento con una Nota de credito
Se permite registrar un cruce de un documento con una cuenta contable utilizando el siguiente endpoint:
`POST https://api.contifico.com/sistema/api/v1/documento/<ID>/cruce/`
donde el parámetro <ID>
es el ID de integración del documento (devuelto al momento de su creación).
El campo documento_id
debe indicar el ID de integracion de la nota de credito a cruzar
{
"pos" : "e4ee7f87-471c-4110-8c2f-15dae1e44ac4",
"caja_id": "7ujk93jdhsieu830",
"monto": "20.0",
"documento_id": "7ujk93jdhsieu831",
"descripcion" : "Cruce de Documento",
"fecha": "31/07/2020",
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
caja_id | varchar | 16 | ID de integración de la caja del POS (opcional). | Si |
monto | decimal | 10 | Valor de la transacción (8 int, 2 decimal)max. | Si |
documento_id | varchar | 16 | ID de integración del documento con el que se hará el cruce. | Si |
descripcion | varchar | 300 | Descripción de la transacción | Si |
fecha | date | - | Fecha de la transacción | Si |
NOTA: Para el cruce de un documento con una nota de credito, Ambos documento deben haber sido creados mediante API
Cruce de un Documento con una Cuenta Contable
Se permite registrar un cruce de un documento con una cuenta contable utilizando el siguiente endpoint:
`POST https://api.contifico.com/sistema/api/v1/documento/<ID>/cruce_cuenta/`
Tipo de Cruce
El tipo de cruce con cuenta contable está determinado por uno de los valores de la siguiente table:
Valor | Tipo |
---|---|
CTA | Cualquier cuenta contable |
GC | Giftcard |
DY | Domicilio Ya |
PE | Super Easy |
UB | Uber |
GL | Glovo |
RA | Rappi |
PI | Picker |
OT | Otros |
Por ejemplo, para realizar el cruce de un documento con cualquier cuenta contable del sistema, se define el query parameter en la llamada al servicio de la sigiente forma:
POST https://api.contifico.com/sistema/api/v1/documento/7ujk93jdhsieu839/cruce_cuenta/?tipo="CTA"
Para un servicio de delivery, como Glovo, se utiliza el valor correspondiente, y así:
POST https://api.contifico.com/sistema/api/v1/documento/7ujk93jdhsieu839/cruce_cuenta/?tipo="GL"
Formato del JSON
Ejemplo:
{
"pos" : "e4ee7f87-471c-4110-8c2f-15dae1e44ac4",
"caja_id": "7ujk93jdhsieu830",
"monto": 20.0,
"descripcion" : "Cruce de Documento con Cuenta Contable",
"fecha": "31/07/2020",
"cuenta_id": "7ujk93jdhsieu832"
}
Parámetro | Tipo | Longitud | Descripción | Obligatorio |
---|---|---|---|---|
pos | varchar | 36 | API Token del POS. | Si |
caja_id | varchar | 16 | ID de integración de la caja del POS (opcional). | No |
monto | decimal | 10 | Valor de la transacción (8 int, 2 decimal)max. | Si |
descripcion | varchar | 300 | Descripción de la transacción | Si |
fecha | date | - | Fecha de la transacción | Si |
cuenta_id | varchar | 16 | Indentificador de la cuenta contable en el sistema | Opcional |
NOTA: Para los cruces con un servicio de delivery (tabla tipo cruce), el campo de cuenta_id no es necesario, pero el modeloAPI debe tener configurada las respectivas cuentas para dicho delivery en la pagina web de contifico, si no tiene configuradas estas cuentas por favor contactar con soporte contifico.