API Avanto¶
Avanto API le brinda acceso a un conjunto de funciones de administración de contenido seguro para usar en su propia aplicación, como generar y administrar comprobantes fiscales, administrar Clientes, Contactos y Sucursales, consultar la estructura empresarial de la cuenta entre otros. Se esfuerza por ser RESTful y se organiza en torno a los recursos principales de la interfaz WEB de Avanto.
Antes de hacer nada, debe contratar una cuenta de Avanto y registrarse para obtener una clave API para que pueda hacer llamadas API.
Si está creando aplicaciones personalizadas para usuarios con una cuenta de Avanto y desea aprovechar la API, puede seguir las instrucciones de autenticación con OAuth 2.
Ejemplos de Solicitudes¶
Se proporcionan ejemplos de llamadas a la API junto a cada método utilizando cURL, una herramienta de línea de comandos estándar. Todo lo que necesita hacer es colocar sus parámetros específicos, y puede probar las llamadas desde la línea de comandos. Si la línea de comandos no es su preferencia, una excelente alternativa es Insomnia, una aplicación fácil de usar para realizar solicitudes HTTP.
Formato de entrada/salida¶
Tanto los datos del cuerpo de la solicitud como los datos de respuesta están formateados como JSON.
Formato de fecha¶
Todas las marcas de tiempo (tanto las enviadas en las solicitudes como las devueltas en las respuestas) deben formatearse como se muestra en nuestros ejemplos. Admitimos marcas de tiempo RFC 3339. La forma preferida de pasar una fecha es convirtiendo la hora a UTC como esta: 2022-04-17T09:12:36-00:00.
En los casos en que las marcas de tiempo se redondean a un día determinado, puede omitir el componente de tiempo. Entonces, en lugar de 2022-04-17T13:35:01+05:00 puede usar 2022-04-17. Sin embargo, si se especifica una hora (y no solo una fecha) en una solicitud, la fecha del calendario en la zona horaria del Pacífico en el momento especificado es el día que se acepta.
Avanto admite el subconjunto de fechas después del inicio de la época de Unix: 1970-01-01T00:00:00+00:00 (00:00:00 UTC del 1 de enero de 1970).
Como nota, la marca de tiempo que recibe de Avanto API se basa en la configuración de Avanto. Si forma parte de una empresa, será la configuración de usuario predeterminada establecida por su administrador.
Recursos "fields" y "expand"¶
Al utilizar la API podemos especificar qué datos pueden ser devueltos en cada petición. Si un objeto contiene un recurso 'fields', podemos solicitar una lista de campos específicos del objeto separada por comas, si se cuenta con un objeto que extiende del mismo basta con añadir el parámetro 'expand' para requerir campo(s) relacionado(s) al objeto padre.
Paginación de respuestas¶
Al realizar las peticiones GET en cada objeto tenemos la posibilidad de mandar parámetros de paginación y el número de la página que deseemos consultar, podemos paginar la respuesta de cada solicitud hasta un máximo de 20 objetos por cada una.
Inactivación de registros¶
Para conservar la estructura de la base de datos, hemos decidido que los registros capturados no se borrarán, tan solo mantendrán el estado de inactivos, para ello cada solicitud con el método DELETE será procesada como la inactivación de un recurso.
Obtener ayuda¶
Si tiene alguna pregunta o comentario, puede enviar un correo a su asesor o al correo info@avanto.mx.
Características¶
- CFDI versión 4.0
- Tipos de comprobantes:
- Ingreso
- Egreso (nota de crédito)
- Pago (complemento de pago)
- Cancelaciones
- Administración de Clientes
- Consulta de Empresas