Módulo API
api/rst/compra
...
getlist
____
https://restelix.com/api/rst/compra/getlist
Request:
numpagina |
Opcional. Página actual. Default: 0 |
renglonespagina |
Opcional. Renglones por página. Default: 20 |
orden |
Opcional. Campo(s) para ordenar la lista (Ej: fecha:A) |
fields |
Opcional. Lista de campos a incluir en lista (separados por coma) |
folio |
Filtro opcional |
folio_g |
Filtro opcional |
folio_l |
Filtro opcional |
fecha |
Filtro opcional |
fecha_g |
Filtro opcional |
fecha_l |
Filtro opcional |
hora |
Filtro opcional |
hora_g |
Filtro opcional |
hora_l |
Filtro opcional |
referencia |
Filtro opcional |
st |
Filtro opcional |
idproveedor |
Filtro opcional |
proveedor |
Filtro opcional |
clave_proveedor |
Filtro opcional |
rfc |
Filtro opcional |
idalmacen |
Filtro opcional |
almacen |
Filtro opcional |
idusuario_compra |
Filtro opcional |
usuario_compra |
Filtro opcional |
idusuario_aprobo |
Filtro opcional |
usuario_aprobo |
Filtro opcional |
idusuario_cancelo |
Filtro opcional |
usuario_cancelo |
Filtro opcional |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
Descripción del Status |
numregistros |
Número total de registros |
numpaginas |
Número de páginas en base a renglonespagina |
numpagina |
Número de página actual |
renglonespagina |
Número de renglones por página |
lista |
Arreglo de registros que cumplen con los filtros |
filtro |
Arreglo asociativo campo:valor de los filtros aplicados |
orden |
Campo(s) empleados para ordenar de la lista |
Campos de lista
:
getlist_csv
____
https://restelix.com/api/rst/compra/getlist_csv
Request:
Ver getlist
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
filename |
Nombre del archivo |
archivo |
Contenido del archivo base64 |
getlist_pdf
____
https://restelix.com/api/rst/compra/getlist_pdf
Request:
Ver getlist
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
filename |
Nombre del archivo |
archivo |
Contenido del archivo base64 |
get
____
https://restelix.com/api/rst/compra/get
Request:
id |
ID del objeto |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
master |
|
details |
Campos de master
:
id |
|
prefijo |
|
numfolio |
|
referencia |
|
fecha |
|
hora |
|
idalmacen |
|
idproveedor |
|
st |
|
idusuario_compra |
|
fecha_aprobo |
|
hora_aprobo |
|
idusuario_aprobo |
|
fecha_cerro |
|
hora_cerro |
|
idusuario_cerro |
|
fecha_cancelo |
|
hora_cancelo |
|
idusuario_cancelo |
|
idmoneda |
|
tipoCambio |
|
subtotal |
|
iva |
|
retIVA |
|
retISR |
|
importe |
|
nota |
|
folio |
|
status |
|
almacen |
|
clave_proveedor |
|
proveedor |
|
rfc_proveedor |
|
moneda |
|
usuario_compra |
|
usuario_aprobo |
|
usuario_cerro |
|
usuario_cancelo |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
get_pdf
____
https://restelix.com/api/rst/compra/get_pdf
Request:
id |
ID del objeto |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
clave |
Clave del objeto |
folio |
Folio del objeto |
filename |
Nombre del archivo |
archivo |
Contenido del archivo base64 |
create
____
https://restelix.com/api/rst/compra/create
Request:
master |
Valores de las propiedades del nuevo objeto |
Campos para master
:
prefijo |
|
numfolio |
|
referencia |
|
fecha |
|
hora |
|
idalmacen |
|
idproveedor |
|
st |
|
idusuario_compra |
|
fecha_aprobo |
|
hora_aprobo |
|
idusuario_aprobo |
|
fecha_cerro |
|
hora_cerro |
|
idusuario_cerro |
|
fecha_cancelo |
|
hora_cancelo |
|
idusuario_cancelo |
|
idmoneda |
|
tipoCambio |
|
subtotal |
|
iva |
|
retIVA |
|
retISR |
|
importe |
|
nota |
|
folio |
|
status |
|
almacen |
|
clave_proveedor |
|
proveedor |
|
rfc_proveedor |
|
moneda |
|
usuario_compra |
|
usuario_aprobo |
|
usuario_cerro |
|
usuario_cancelo |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
id |
ID del objeto creado |
Status de Respuesta:
001 |
OK |
C099 |
Error en los datos. Regresa el arreglo 'err' con la lista de errores |
update
____
https://restelix.com/api/rst/compra/update
Request:
id |
ID del objeto a actualizar |
master |
Valores de las propiedades del objeto |
Campos para master
:
prefijo |
|
numfolio |
|
referencia |
|
fecha |
|
hora |
|
idalmacen |
|
idproveedor |
|
st |
|
idusuario_compra |
|
fecha_aprobo |
|
hora_aprobo |
|
idusuario_aprobo |
|
fecha_cerro |
|
hora_cerro |
|
idusuario_cerro |
|
fecha_cancelo |
|
hora_cancelo |
|
idusuario_cancelo |
|
idmoneda |
|
tipoCambio |
|
subtotal |
|
iva |
|
retIVA |
|
retISR |
|
importe |
|
nota |
|
folio |
|
status |
|
almacen |
|
clave_proveedor |
|
proveedor |
|
rfc_proveedor |
|
moneda |
|
usuario_compra |
|
usuario_aprobo |
|
usuario_cerro |
|
usuario_cancelo |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
id |
ID del objeto creado |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
C099 |
Error en los datos. Regresa el arreglo 'err' con la lista de errores |
delete
____
https://restelix.com/api/rst/compra/delete
Request:
id |
ID del objeto a borrar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
C023 |
Existen registros asociados |
approve
____
https://restelix.com/api/rst/compra/approve
Request:
id |
ID del objeto a aprobar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
close
____
https://restelix.com/api/rst/compra/close
Request:
id |
ID del objeto a cerrar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
cancel
____
https://restelix.com/api/rst/compra/cancel
Request:
id |
ID del objeto a cancelar |
motivo |
Motivo de la cancelación |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
duplicate
____
https://restelix.com/api/rst/compra/duplicate
Request:
id |
ID del objeto a duplicar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
getFileContent
____
https://restelix.com/api/rst/compra/getFileContent
Request:
id |
ID del objeto |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
C023 |
Existen registros asociados |
C024 |
Faltan datos |
C030 |
Campo requerido |
C031 |
Valor requerido |
C032 |
Valor requerido (no cero) |
C033 |
Valor inferior al mínimo |
C034 |
Valor superior al máximo |
C035 |
Valor fuera del rango |
C036 |
Valor duplicado |
C037 |
Valor incorrecto |
C041 |
Acción no permitida |
C042 |
Requiere autorización |
F032 |
Espacio de disco saturado |
F033 |
Falta nombre del archivo |
F034 |
Falta el archivo |
F035 |
Tamaño del archivo supera máximo permitido |
F036 |
No se puede borrar el archivo |
F042 |
Falta ID del formato |
F043 |
Plantilla del formato no encontrada o asignada |
file_list
____
https://restelix.com/api/rst/compra/file_list
Request:
id |
ID del objeto |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
archivos |
Lista de archivos. Estructura: [ruta, filename, ext, size] |
disco |
Valores del disco: cuota, uso, libre, uso_p |
file_upload
____
https://restelix.com/api/rst/compra/file_upload
Request:
id |
ID del objeto |
filename |
Nombre del archivo con extensión |
archivo |
Contenido del archivo en Base64 |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
archivos |
Lista de archivos. Estructura: [ruta, filename, ext, size] |
disco |
Valores del disco: cuota, uso, libre, uso_p |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
F032 |
Espacio de disco saturado |
F033 |
Falta nombre del archivo |
F034 |
Falta el archivo |
F035 |
Tamaño del archivo supera máximo permitido |
file_delete
____
https://restelix.com/api/rst/compra/file_delete
Request:
id |
ID del objeto |
filename |
Nombre del archivo a borrar |
Response:
code |
Código HTTP |
st |
Status de la llamada |
msg |
descripción del Status |
Status de Respuesta:
001 |
OK |
C021 |
Falta parámetro de búsqueda |
C022 |
Objeto no encontrado |
F033 |
Falta nombre del archivo |
F036 |
No se puede borrar el archivo |