# Webhooks
### Información general
La configuración de Webhooks nos ayuda a enviar notificaciones de diferentes eventos que ocurren en su cuenta de admintotal, estas notificaciones son enviadas mediante una petición POST a la URL que se especifica al momento de su configuración. Los eventos que pueden ser notificados son:
* Creación de productos
* Creación de clientes
* Creación de cotización
* Timbrar factura
* Actualización de precios y existencias de productos
### Configuración básica de un webhook
La configuración de webhooks podemos encontrarla entrando en su cuenta de admintotal a la ruta **Configuración / Webhooks** ó directamente `https://{clave}.admintotal.com/admin/integraciones/configuracion_webhooks/`
{% hint style="info" %}
Todos los webhooks que se configuren tendrán las siguientes propiedades, dependiendo el tipo de evento que se notificará puede que se agreguen propiedades adicionales a su configuración.
{% endhint %}
* **URL:** Admintotal tomará el valor especificado para enviar una petición POST con la información de la notificación.
* **La autenticación de las notificaciones enviadas es opcional pero recomendada, pueden ser de las siguientes maneras:**
* **Token**: Token de autenticación que será utilizado en cada petición enviada, se enviará en el header *"Api-key"*
* [**Autenticación de acceso básica**](https://es.wikipedia.org/wiki/Autenticaci%C3%B3n_de_acceso_b%C3%A1sica):
* Username
* Password
### Creación de productos
Ejemplo del body de la petición:
```javascript
{
"id": 15111,
"codigo": "PRODUCTO DE EJEMPLO",
"medio_distribucion": 3,
"descripcion": "Lorem ipsum dolor...",
"descripcion_adicional": "",
"ce_fraccion_arancelaria": "",
"descripcion_ingles": "",
"descripcion_ecommerce": "",
"tipo": 0,
"tipo_producto_sistema_cardonal": null,
"composiciones": [],
"unidad_aduana": "",
"imagen_url": "",
"costo_ensamble": 0,
"costo": 0.0,
"precio": 160.0,
"unidad": {
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
},
"unidades": [
{
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
}
]
}
```
### Cambios de precios y existencias
{% hint style="info" %}
El envío de los cambios de precios y existencias se realiza cada 4 minutos y no en tiempo real, se envían un máximo de 50 productos por petición.
{% endhint %}
Para recibir notificaciones sobre cambios de precios y existencias en su catálogo de productos será necesario especificar las siguientes configuraciones, esto podemos hacerlo entrando en su cuenta de admintotal a la ruta **Configuración / Webhooks** ó directamente `https://{clave}.admintotal.com/admin/integraciones/configuracion_webhooks/`
* **Almacén de precios:** Almacén que será usado para calcular los precios notificados.
* **Almacén(es)**: Se especifica uno o varios almacenes de los cuales se tomarán en cuenta las existencias.
* **Cliente**: Se puede seleccionar un cliente del catálogo para poder asignar listas de precios.
Ejemplo del body de la petición:
```javascript
[
{
"sku": "0001",
"precio": "99.00",
"costo": "0.00",
"stock": "10"
},
{
"sku": "0002",
"precio": "239.00",
"costo": "0.00",
"stock": "2"
},
...
]
```
# API
# Introducción
Información general y de ayuda para el consumo de la API v2 de admintotal.
### Dominio base de su API
El dominio base de todos los endpoints se construye con el dominio que fué asignada a su cuenta de admintotal, por ejemplo:
Si usted accede al sistema con la url `https://micuenta.admintotal.com/` la url a la api será `https://micuenta.admintotal.com/api/v2/`
### Paginado
Por defecto los endpoints de listados retornan `count` (total de objetos), `previous` (página anterior) y `next` (página siguiente). Adicional se puede especificar el parámetro `limit` que se usa para limitar la cantidad de objetos, el valor por defecto es de 100 objetos.
### Límite de consultas
Se pueden hacer hasta 4 consultas ya sea GET o POST por segundo.
# Autenticación
Todas las peticiones realizadas a la API de Admintotal deben incluir un método de autenticación válido.
Actualmente se encuentran disponibles los siguientes métodos:
* **API Key ****(Recomendado)**
* **JWT**
## Autenticación mediante API Key (Recomendado)
{% hint style="info" %}
**IMPORTANTE**\
Al utilizar este método es necesario almacenar el `api_key` de manera segura y evitar exponerlo en código fuente, repositorios públicos o aplicaciones cliente.
{% endhint %}
La autenticación mediante **API Key** es el método recomendado para consumir la API de Admintotal.
Primero es necesario autenticar al usuario mediante su nombre de usuario y contraseña. Si las credenciales son correctas, el servicio retornará un `api_key`.
Este valor deberá enviarse posteriormente en el header `api-key` de todas las peticiones realizadas a la API.
### Obtener API Key
**POST**** ** `https://{clave}.admintotal.com/api/v2/usuarios/login_usuario/`
Este endpoint permite autenticar a un usuario y obtener el `api_key` que será utilizado como token de acceso para consumir los diferentes endpoints de la API.
{% tabs %}
{% tab title="Request Body" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| `username` | string | Nombre del usuario |
| `password` | string | Contraseña del usuario |
| {% endtab %} | | |
{% tab title="Ejemplo solicitud" %}
```json
{
"username": "johndoe",
"password": "contraseña"
}
```
{% endtab %}
{% tab title="200 OK" %}
```json
{
"ok": true,
"usuario": {
"id": 104,
"api_key": "...",
"username": "johndoe",
"nombre": "John Doe",
...
}
}
```
{% endtab %}
{% endtabs %}
### Enviar el API Key
Una vez obtenido el `api_key`, deberá incluirse en el header de todas las peticiones:
{% tabs %}
{% tab title="Ejemplo" %}
`Api-key: {api_key}`
```
GET https://{clave}.admintotal.com/api/v2/clientes/
Api-key: ...
```
{% endtab %}
{% endtabs %}
***
## Autenticación mediante JWT
{% hint style="info" %}
Al utilizar este método de autenticación, TODAS las peticiones realizadas a la API deberán incluir el header Authorization de la siguiente forma: `Authorization: Bearer {access_token}`
{% endhint %}
Admintotal también permite autenticarse utilizando **JSON Web Tokens (JWT)**.
Con este método se obtiene un `access token` y un `refresh token`. \
El `access token` deberá incluirse en el header `Authorization` de las peticiones.
### Obtener token JWT
**POST**** ** `https://{clave}.admintotal.com/api/v2/token/`
Este endpoint permite autenticar al usuario y obtener los tokens necesarios para utilizar autenticación JWT.
{% tabs %}
{% tab title="Request Body" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| `username` | string | Nombre del usuario |
| `password` | string | Contraseña del usuario |
| {% endtab %} | | |
{% tab title="Ejemplo solicitud" %}
```json
{
"username": "johndoe",
"password": "contraseña"
}
```
{% endtab %}
{% tab title="200 OK" %}
```json
{
"refresh": "eyJ0XAiO...",
"access": "eyJ0eXAiO..."
}
```
{% endtab %}
{% endtabs %}
### Refrescar token JWT
El `access token` tiene un tiempo de vigencia limitado. Cuando expire, puede obtenerse uno nuevo utilizando el `refresh token`.
**POST**** ** `https://{clave}.admintotal.com/api/v2/refresh/`
{% tabs %}
{% tab title="Request Body" %}
| Name | Type | Description |
|---|
refresh | string | Refresh token obtenido durante la autenticación |
{% endtab %}
{% tab title="Ejemplo solicitud" %}
```json
{
"refresh": "eyJ0XAiO..."
}
```
{% endtab %}
{% tab title="200 OK" %}
```json
{
"access": "eyJ0eXAiO..."
}
```
{% endtab %}
{% endtabs %}
## ¿Que método utilizar?
Utilizar **API Key** ofrece una implementación sencilla y permite autenticar las peticiones mediante un único valor.
Utilizar **JWT** puede ser una mejor opción cuando se requiere un mayor control sobre la duración de las credenciales de acceso.
# Almacenes
## Obtener listado de almacenes
`GET` `https://{clave}.admintotal.com/api/v2/almacenes/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 23,
"next": "https://{clave}.admintotal.com/api/v2/almacenes/",
"previous": null,
"results": [
{
"id": 1545,
"activo": true,
"nombre": "Mi almacén",
"codigo": "0009"
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un almacén
`GET` `https://{clave}.admintotal.com/api/v2/almacenes/:id/`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ------------- |
| ID | integer | ID de almacén |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"id": 1545,
"activo": true,
"nombre": "Mi almacén",
"codigo": "0009"
}
```
{% endtab %}
{% endtabs %}
# Anticipos de clientes
## Crear un anticipo de cliente
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/anticipos_clientes/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| fecha | string | Fecha del pedido en formato YYYY-MM-DD |
| almacen | integer | ID del almacén (en caso de no especificar se tomará el primer almacén) |
| cliente | integer | ID de cliente (este parámetro es opcional si se especifica cliente_rfc) |
| concepto_cfdi | string | Concepto que irá en el CFDI |
| cuenta | integer | ID de la cuenta bancaria |
| total | string | Total del anticipo |
| uso_cfdi | string | Posibles valores: "G01", "G02", "G03", "I01", "I02", "I03", "I04", "I05", "I06", "I07", "I08", "D01", "D02", "D03", "D04", "D05", "D06", "D07", "D08", "D09", "D10", "P01", "CP01", "CN01", "S01" |
| comentarios | string | Comentarios |
| forma_pago | string | Posibles valores: "01", "02", "03", "04", "05", "06", "08", "12", "13", "14", "15", "17", "23", "24", "25", "26", "27", "28", "29", "30", "31", "99" (si no se especifica se intentará tomar del cliente) |
| campos_personalizados | array | Lista de campos personalizados (se validarán los campos personalizados de venta), ejemplo de estructura: [
{
"key": "codigo_reservacion",
"valor": "FKL4646"
},
{
"key": "origen",
"valor": "Sistema externo"
}
]
|
{% tabs %}
{% tab title="201 " %}
```
{
"id": 5102,
"fecha": "2025-05-22T10:37:54.727482-07:00",
"almacen": 9,
"cliente": 1522,
"folio": 3,
"cuenta": 1530,
"saldo": "0.00",
"saldo_cliente": "0.00",
"total": "100.00",
"comentarios": "",
"usuario_creado": 20,
"creado": "2025-05-22T10:37:54.763087-07:00",
"uso_cfdi": "G03",
"tipo_relacion": null,
"cancelado": false,
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"motivo_cancelacion": "",
"cfdi_uuid": null,
"cfdi_xml": null,
"cfdi_certificado_pago": "",
"cfdi_cadena_pago": "",
"cfdi_sello_pago": "",
"concepto_cfdi": "Anticipo de reservación #FKL576B5",
"campos_personalizados": [
{
"key": "codigo_reservacion",
"valor": "FKL576B5"
},
{
"key": "origen",
"valor": "Sistema externo"
}
]
}
```
{% endtab %}
{% endtabs %}
# Clientes
Permite consultar, crear y administrar la información de los clientes registrados.
{% hint style="info" %}
**NOTA:** Los clientes disponibles pueden variar dependiendo del usuario utilizado para realizar la consulta. Por ejemplo, un usuario repartidor puede visualizar únicamente los clientes relacionados con sus entregas asignadas.
{% endhint %}
## Endpoints disponibles
| Method | Endpoint |
|---|
| GET | Obtener listado de clientes
GET - https://{clave}.admintotal.com/api/v2/clientes/ |
| GET | Obtener un cliente
https://{clave}.admintotal.com/api/v2/clientes/{id}/ |
| GET | Obtener direcciones de entrega de un cliente
https://{clave}.admintotal.com/api/v2/clientes/:id/direcciones_entrega/ |
| GET | Obtener contactos de un cliente
https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/ |
| GET | Obtener clientes cercanos
https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/ |
| POST | Crear cliente
https://{clave}.admintotal.com/api/v2/clientes/ |
| POST | Actualizar contacto de cliente
https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/:id |
## Obtener listado de clientes
Obtiene el listado de clientes registrados. La consulta puede limitarse utilizando los parámetros de filtrado disponibles.
**GET** `https://{clave}.admintotal.com/api/v2/clientes/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="Parámetros GET" %}
| Name | Type | Description | Values |
|---|
| saldo | number | Estado del saldo pendiente del cliente. | 0: Sin saldo pendiente
1: Con saldo pendiente |
| q | string | Texto utilizado para buscar clientes por razón social, nombre comercial, RFC o código. | — |
{% endtab %}
{% tab title="200 OK" %}
```json
{
"count": 722,
"next": "https://{clave}.admintotal.com/api/v2/clientes/",
"previous": null,
"results": [
{
"id": 2482,
"activo": true,
"tipo_cliente": 1,
"razon_social": "CLIENTE DE EJEMPLO",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": null,
"rfc": "...",
"curp": null,
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 1241,
"municipio": "",
"localidad": "",
"estado": "",
"calle": "Uni",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": true,
"dias_cortar_credito": 0,
"dias_credito": 0,
"regimen_fiscal": null,
"creado": "2026-02-10T12:00:32.592595-06:00",
"usuario_creado": null,
"direccion_txt": " ",
"almacen_precios": null,
"clasificacion": null,
"segmentacion": null
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un cliente
Obtiene la información detallada de un cliente específico.
**GET** `https://{clave}.admintotal.com/api/v2/clientes/{id}/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="200 OK" %}
{% code overflow="wrap" %}
```json
{
"id": 2482,
"activo": true,
"tipo_cliente": 1,
"razon_social": "CLIENTE DE EJEMPLO",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": null,
"rfc": "...",
"curp": null,
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 1308,
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": true,
"dias_cortar_credito": 0,
"dias_credito": 0,
"regimen_fiscal": null,
"creado": "2026-02-10T12:00:32.592595-06:00",
"usuario_creado": null,
"direccion_txt": " ",
"almacen_precios": null,
"clasificacion": null,
"segmentacion": null,
"monedero": "0"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Campos principales de respuesta en cliente
| Name | Type | Description | Values |
|---|
id | integer | Identificador único del cliente. | — |
activo | boolean | Indica si el cliente se encuentra activo en el sistema. | true: Activo
false: Inactivo |
tipo_cliente | number | Tipo de cliente. | — |
razon_social | string | Razón social o nombre fiscal del cliente. | — |
codigo | string | Código interno utilizado para identificar al cliente. | — |
referencia | string | Referencia adicional asociada al cliente. | — |
nombre_comercial | string | Nombre comercial del cliente. | — |
sitio_web | string | Sitio web del cliente. | — |
rfc | string | RFC del cliente | — |
curp | string | CURP del cliente. | — |
limite_credito | number | Monto máximo de crédito autorizado para el cliente. | — |
representante_legal | string | Representante legal del cliente. | — |
direccion | object | Objeto de relacion con una direccion por Información del domicilio principal del cliente. | — |
bloquear_vencido | boolean | Restringir ventas con facturas vencidas. | — |
dias_cortar_credito | integer | Días de gracia por defecto para facturas vencidas. | — |
dias_credito | number | Número de días de crédito otorgados al cliente. | — |
regimen_fiscal | string | Régimen Fiscal del cliente. | — |
creado | string | Fecha y hora en que se creó el registro. | Formato: YYYY-MM-DDTHH:mm:ss±hh:mm |
usuario_creado | integer | Identificador único del usuario que creó al cliente. | — |
direccion_txt | string | Direccion escrita del cliente. | — |
almacen_precios | object | Precios por almacén del cliente. | — |
clasificacion | object | Clasificación del cliente. | — |
segmentacion | object | Segmentación del cliente. | — |
monedero | decimal | Monedero disponible del cliente. | — |
Dirección ( direccion )
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
***
## Obtener direcciones de entrega de un cliente
Obtiene la dirección de entrega de un cliente específico.
**GET** `https://{clave}.admintotal.com/api/v2/clientes/:id/direcciones_entrega/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="200 OK" %}
{% code overflow="wrap" %}
```json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 33,
"nombre": "Oficina",
"direccion": {
"id": 482,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "A la torre",
"colonia": "Pitic",
"cp": "83150",
"telefono": "",
"email": "",
"numero_e": "xxxx",
"numero_i": "",
"pais_residencia": "MX",
"latitud": "xxxx",
"longitud": "xxxx",
"referencia": null
}
"es_sucursal": false
},
...
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Campos de respuesta para direcciones de entrega de un cliente
| Name | Type | Description | Values |
|---|
id | integer | Identificación única de la direccion de entrega. | — |
nombre | string | Nombre de la direccion de entrega. | — |
direccion | object | Direccion de entrega. | — |
es_sucursal | boolean | Indicador para saber si la dirección es un sucursal | true: Si es una sucursal
false: No es una sucursal |
Dirección ( direccion )
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
***
## Obtener contactos de un cliente
Obtiene los contactos de un cliente específico.
**GET** `https://{clave}.admintotal.com/api/v2/clientes/:id/contactos/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="200 OK" %}
{% code overflow="wrap" %}
```json
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 109,
"nombre": "Contacto de Prueba",
"celular": "",
"telefono": "",
"email": "",
"puesto": "",
"extension": "",
"factura": true,
"cancelacion_factura": false,
"remision": false,
"cotizacion_c": false,
"cotizacion_p": false,
"garantia_p": true,
"orden_compra": false,
"estado_cuenta": false,
"auxiliar_movimientos": false,
"auxiliar_movimientos_cxp": false,
"devolucion": false,
"notificaciones_pago": false,
"sucursal": null,
"devolucion_cxp": false,
"recepcion_pago": false
}
...
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Campos de respuesta para contactos de un cliente
| Name | Type | Description |
|---|
id | integer | Identificador único del contacto. |
nombre | string | Nombre del contacto. |
celular | string | Teléfono celular del contacto. |
telefono | string | Teléfono del contacto. |
email | string | Correo del contacto. |
puesto | string | Puesto del contacto |
extencion | string | Extensión del contacto. |
factura | boolean | Envíos de documentos: Facturas. |
cancelacion_factura | boolean | Envíos de documentos: Cancelar facturas. |
remision | boolean | Envíos de documentos: Remisiones. |
cotizacion_c | boolean | Envíos de documentos: Cotizaciones de cliente. |
cotizacion_p | boolean | Envíos de documentos: Cotizaciones de proveedor. |
garantia_p | boolean | Envíos de documentos: Garantía proveedor. |
orden_compra | boolean | Envíos de documentos: Órdenes de compra. |
estado_cuenta | boolean | Envíos de documentos: Estados de cuenta. |
auxiliar_movimientos | boolean | Envíos de documentos: Auxiliar de movimientos de clientes. |
auxiliar_movimientos_cxp | boolean | Envíos de documentos: Auxiliar de movimientos de proveedores. |
devolucion | boolean | Envíos de documentos: Devoluciones, Descuentos y CFDI Egresos. |
notificaciones_pago | boolean | Envíos de documentos: Enviar notificaciones de pago. |
sucursal | integer | Identificador único de la sucursal. |
devolucion_cxp | boolean | Envíos de documentos: Devoluciones de proveedor. |
recepcion_pago | boolean | Envíos de documentos: Recepción de pago. |
***
## Obtener clientes cercanos
Obtiene un listado de clientes cercanos.
**GET** `https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/`
Ejemplo:
`https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/``?latitud={}&longitud={}``/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="Parámetros GET" %}
| Name | Type | Description |
|---|
| longitud | number | Latitud del punto de partida. |
| latitud | number | Longitud del punto de partida. |
| radio | number | Radio en km, el valor por defecto es 10. |
{% endtab %}
{% tab title="200 OK" %}
{% code overflow="wrap" %}
```json
{
"count": 2,
"next": "https://{clave}.admintotal.com/api/v2/clientes/geolocalizaciones/",
"previous": null,
"results": [
{
"id": 1940,
"rfc": "",
"nombre_comercial": "CLIENTE DE PRUEBA",
"razon_social": "CLIENTE DE PRUEBA S.A DE C.V",
"direccion": {
"id": 546,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "campeche",
"colonia": "San Benito",
"cp": "83190",
"telefono": "",
"email": "",
"numero_e": "xx",
"numero_i": "",
"pais_residencia": "MX",
"latitud": "xxxx",
"longitud": "xxxx",
"referencia": null
},
"limite_credito": "10000.00",
"saldo": 0.0
},
...
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Campos de respuesta de clientes cercanos
| Name | Type | Description |
|---|
id | integer | Identificador único del cliente. |
rfc | string | RFC del cliente. |
nombre_comercial | string | Nombre comercial del cliente. |
razon_social | string | Razón social del cliente. |
direccion | object | Dirección del cliente. |
limite_credito | decimal | Límite de crédito del cliente. |
saldo | decimal | Saldo del cliente. |
Dirección ( direccion )
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
***
## Crear cliente
Crea un nuevo cliente.
**POST** `https://{clave}.admintotal.com/api/v2/clientes/`
### Request Body
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="Ejemplo Body" %}
{% code overflow="wrap" %}
```json
{
"activo": false,
"tipo_cliente": null,
"razon_social": "",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "",
"curp": "",
"limite_credito": null,
"representante_legal": "",
"direccion": {
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": null,
"longitud": null,
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": null,
"dias_credito": null,
"regimen_fiscal": null,
"usuario_creado": null
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Campos de Request Body
| Name | Type | Required | Description | |
|---|
activo | boolean | No | Indica si el cliente se encuentra activo en el sistema. | true: Activo
false: Inactivo |
tipo_cliente | number | Si | Tipo de cliente. | — |
razon_social | string | Si | Razón social o nombre fiscal del cliente. | — |
codigo | string | No | Código interno utilizado para identificar al cliente. | — |
referencia | string | No | Referencia adicional asociada al cliente. | — |
nombre_comercial | string | No | Nombre comercial del cliente. | — |
sitio_web | string | No | Sitio web del cliente. | — |
rfc | string | No | RFC del cliente | — |
curp | string | No | CURP del cliente. | — |
limite_credito | number | Si | Monto máximo de crédito autorizado para el cliente. | — |
representante_legal | string | No | Representante legal del cliente. | — |
direccion | object | Si | Objeto de relacion con una direccion por Información del domicilio principal del cliente. | — |
bloquear_vencido | boolean | No | Restringir ventas con facturas vencidas. | — |
dias_cortar_credito | integer | Si | Días de gracia por defecto para facturas vencidas. | — |
dias_credito | number | No | Número de días de crédito otorgados al cliente. | — |
regimen_fiscal | string | No | Régimen Fiscal del cliente. | — |
usuario_creado | integer | No | Identificador único del usuario que creó al cliente. | — |
Tipos de cliente ( tipo_cliente )
| Value | Description |
| ----- | ---------------------- |
| `1` | Nacional |
| `2` | Extranjero |
| `3` | Nacional relacionado |
| `4` | Extranjero relacionado |
Dirección ( direccion )
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
### Respuesta 201 Created
{% tabs %}
{% tab title="201 Created" %}
```json
{
"id": 1940,
"rfc": "",
"nombre_comercial": "CLIENTE DE PRUEBA",
"razon_social": "CLIENTE DE PRUEBA S.A DE C.V",
"direccion": {
"id": 546,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "campeche",
"colonia": "San Benito",
"cp": "83190",
"telefono": "",
"email": "",
"numero_e": "xx",
"numero_i": "",
"pais_residencia": "MX",
"latitud": "xxxx",
"longitud": "xxxx",
"referencia": null
},
"limite_credito": "10000.00",
"saldo": 0.0
}
```
{% endtab %}
{% endtabs %}
### Campos de respuesta 201 Created
| Name | Type | Description |
|---|
| id | integer | Identificador único del cliente. |
| rfc | string | RFC del cliente. |
| nombre_comercial | string | Nombre comercial del cliente. |
| razon_social | string | Razón social o nombre fiscal del cliente. |
| direccion | object | Objeto de la dirección del cliente. |
| limite_credito | number | Monto máximo de crédito autorizado para el cliente. |
| saldo | decimal | Saldo en monedero del cliente. |
Dirección ( direccion )
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
***
## Actualizar contacto de cliente
Editar un contacto especifico de un cliente.
**POST** `https://{clave}.admintotal.com/api/v2/clientes/``{cliente_id}``/contactos/``{contacto_id}` `/`
Ejemplo: \
`https://{clave}.admintotal.com/api/v2/clientes/``1``/contactos/``1``/`
### Request Body
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="Ejemplo Body" %}
{% code overflow="wrap" %}
```json
{
"id": 109,
"nombre": "Contacto de Prueba",
"celular": "",
"telefono": "",
"email": "",
"puesto": "",
"extension": "",
"factura": true,
"cancelacion_factura": false,
"remision": false,
"cotizacion_c": false,
"cotizacion_p": false,
"garantia_p": true,
"orden_compra": false,
"estado_cuenta": false,
"auxiliar_movimientos": false,
"auxiliar_movimientos_cxp": false,
"devolucion": false,
"notificaciones_pago": false,
"sucursal": null,
"devolucion_cxp": false,
"recepcion_pago": false
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Respuesta 201 Created
{% tabs %}
{% tab title="201 Created" %}
```json
{
"nombre": "Juan Pérez",
"celular": "6623070707",
"telefono": "",
"email": "juanperez@admintotal.com",
"puesto": "",
"extension": "",
"factura": false,
"cancelacion_factura": false,
"remision": false,
"cotizacion_c": false,
"cotizacion_p": false,
"garantia_p": false,
"orden_compra": false,
"estado_cuenta": false,
"auxiliar_movimientos": false,
"auxiliar_movimientos_cxp": false,
"devolucion": false,
"notificaciones_pago": false,
"sucursal": null,
"devolucion_cxp": false,
"recepcion_pago": false
}
```
{% endtab %}
{% endtabs %}
### Campos para crear y de respuesta para actualizar contacto
| Name | Type | Description |
|---|
id | integer | Identificador único del contacto. |
nombre | string | Nombre del contacto. |
celular | string | Teléfono celular del contacto. |
telefono | string | Teléfono del contacto. |
email | string | Correo del contacto. |
puesto | string | Puesto del contacto |
extencion | string | Extensión del contacto. |
factura | boolean | Envíos de documentos: Facturas. |
cancelacion_factura | boolean | Envíos de documentos: Cancelar facturas. |
remision | boolean | Envíos de documentos: Remisiones. |
cotizacion_c | boolean | Envíos de documentos: Cotizaciones de cliente. |
cotizacion_p | boolean | Envíos de documentos: Cotizaciones de proveedor. |
garantia_p | boolean | Envíos de documentos: Garantía proveedor. |
orden_compra | boolean | Envíos de documentos: Órdenes de compra. |
estado_cuenta | boolean | Envíos de documentos: Estados de cuenta. |
auxiliar_movimientos | boolean | Envíos de documentos: Auxiliar de movimientos de clientes. |
auxiliar_movimientos_cxp | boolean | Envíos de documentos: Auxiliar de movimientos de proveedores. |
devolucion | boolean | Envíos de documentos: Devoluciones, Descuentos y CFDI Egresos. |
notificaciones_pago | boolean | Envíos de documentos: Enviar notificaciones de pago. |
sucursal | integer | Identificador único de la sucursal. |
devolucion_cxp | boolean | Envíos de documentos: Devoluciones de proveedor. |
recepcion_pago | boolean | Envíos de documentos: Recepción de pago. |
## Errores HTTP
Posibles códigos de error que puedes encontrar al consumir este recurso.
| | | |
|---|
400
Solicitud invalida | 403
Sin permiso | 404
Registro no encontrado | 500
Error interno del servidor |
# Centros de responsabilidad
Consultar y crear Centros de Responsabilidad disponibles en Admintotal.
## Endpoints disponibles
| Method | Endpoint |
|---|
| GET | Obtiene la lista de centros de responsabilidad
https://{clave}.admintotal.com/api/v2/centros_responsabilidad/ |
| GET | Obtiene un centro específico
https://{clave}.admintotal.com/api/v2/centros_responsabilidad/:id/ |
| POST | Crea un nuevo centro de responsabilidad
https://{clave}.admintotal.com/api/v2/centros_responsabilidad/ |
## Obtiene la lista de centros de responsabilidad
**GET** `https://{clave}.admintotal.com/api/v2/centros_responsabilidad/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="200 OK" %}
"count": 8,
"next": "http://{clave}.admintotal.com/api/v2/entradas_almacen/",
"previous": null,
"results": [
{
"id": 1,
"numero": "001",
"nombre": "SURSAL EJEMPLO",
"padre": "SUCURSAL PADRE",
"tipo": "CeCo",
"responsable": "JUAN PEREZ"
}
]
}
{% endtab %}
{% endtabs %}
## Obtener un centro de responsabilidad.
**GET** `https://{clave}.admintotal.com/api/v2/centros_responsabilidad/:id/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="200 OK" %}
```json
{
"id": 1,
"numero": "001",
"nombre": "SURSAL EJEMPLO",
"padre": "SUCURSAL PADRE",
"tipo": "CeCo",
"responsable": "JUAN PEREZ"
}
```
{% endtab %}
{% endtabs %}
### Campos de respuesta
{% hint style="info" %}
Algunos campos utilizan valores distintos entre la solicitud y la respuesta.\
En la solicitud, `padre`, `tipo` y `responsable` reciben identificadores internos. \
En la respuesta, estos campos se representan mediante valores descriptivos para facilitar su lectura.
{% endhint %}
| Name | Type | Description | Values |
|---|
id | integer | Identificador único del centro de responsabilidad. | — |
numero | string | Número o código asignado al centro de responsabilidad. | — |
nombre | string | Nombre asignado al centro de responsabilidad. | — |
padre | string | Centro de responsabilidad asignado como padre al centro actual. | — |
tipo | string | Tipo de Centro de responsabilidad. | 1 = CeCo
2 = CeBe |
responsable | string | Responsable al centro de responsabilidad. | — |
***
## Crear un centro de responsabilidad.
**POST** `https://{clave}.admintotal.com/api/v2/centros_responsabilidad/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | --------------------- |
| Api-key | string | Toke de autenticacion |
| {% endtab %} | | |
{% tab title="201 Created" %}
```json
{
"id": 187,
"numero": "002",
"nombre": "SURSAL CREADA EJEMPLO",
"padre": "SUCURSAL PADRE",
"tipo": "CeBe",
"responsable": "Pedro López"
}
```
{% endtab %}
{% endtabs %}
### Campos de la solicitud
{% hint style="info" %}
Algunos campos utilizan valores distintos entre la solicitud y la respuesta.\
En la solicitud, `padre`, `tipo` y `responsable` reciben identificadores internos. \
En la respuesta, estos campos se representan mediante valores descriptivos para facilitar su lectura.
{% endhint %}
| Name | Type | Required | Description |
|---|
numero | string | Si | Número o código asignado al centro de responsabilidad. |
nombre | string | Si | Nombre asignado al centro de responsabilidad. |
padre | string | No | Centro de responsabilidad asignado como padre al centro actual. |
tipo | string | Si | Tipo de Centro de responsabilidad. |
responsable | string | No | Responsable al centro de responsabilidad. |
***
## Errores HTTP
Posibles códigos de error que puedes encontrar al consumir este recurso.
| | | |
|---|
400
Solicitud invalida | 403
Sin permiso | 404
Registro no encontrado | 500
Error interno del servidor |
# Consumo Interno
## Obtener listado de Consumo Interno
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/consumo_interno/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
{
"count": 391,
"next": "https://{clave}.admintotal.com/api/v2/movimientos/consumo_interno/",
"previous": null,
"results": [
{
"id": 573439,
"status": 1,
"almacen": 9,
"fecha": "2026-03-03",
"fecha_vencimiento": "2026-03-03",
"iva": "0.00",
"subtotal": "0.00",
"total": "0.0",
"uso_cfdi": null,
"comentarios": "",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [],
"creado": "2026-03-03T10:25:54.770552-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 604,
"folio_completo": "604",
"vendedor": "",
"url_pdf": "",
"cliente": [],
"motivo": ""
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un solo Consumo Interno
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/consumo_interno/:id`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ---------------------- |
| ID | Integer | ID del Consumo Interno |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="First Tab" %}
```
{
"id": 573439,
"status": 1,
"almacen": 9,
"fecha": "2026-03-03",
"fecha_vencimiento": "2026-03-03",
"iva": "0.00",
"subtotal": "0.00",
"total": "0.00",
"uso_cfdi": null,
"comentarios": "",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [
{
"id": 1831246,
"producto": {
"id": 37496,
"codigo": "PRODUCTO DE EJEMPLO",
"linea": "LINEA DE EJEMPLO",
"descripcion": "Lorem ipsum dolor..."
},
"cantidad": 4.0,
"descripcion_adicional": "",
"unidad": {
"id": 1531,
"nombre": "PIEZA",
"factor": "1.00000000"
},
"precio_um": "0.0",
"precio_unitario": "0.0",
"importe": "0.0",
"total": "0.0",
"iva": "0.0",
"ieps": "0.0"
}
],
"creado": "2026-03-03T10:25:54.770552-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 604,
"folio_completo": "604",
"vendedor": "",
"url_pdf": "",
"campos_personalizados": [],
"movimiento_origen": null,
"movimientos_relacionados": [],
"cliente": {
"activo": false,
"tipo_cliente": null,
"razon_social": "",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "",
"curp": "",
"limite_credito": null,
"representante_legal": "",
"direccion": {
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": null,
"longitud": null,
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": null,
"dias_credito": null,
"regimen_fiscal": null
},
"motivo": ""
}
```
{% endtab %}
{% endtabs %}
## Crear un Consumo Interno
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/consumo_interno/`
#### Headers
| Name | Type | Description |
|---|
| Api-key | String | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| almacen | Integer | ID del almacén |
| centro_responsabilidad | Integer | ID del centro de responsabilidad |
| cuenta_gasto | Integer | ID de la cuenta de gasto |
| detalles | Array | Lista de objetos con la información de los productos del movimiento de consumo interno (para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor), ejemplo: [
{
"cantidad": "1.00",
"producto_codigo": "PRODUCTO DE EJEMPLO",
"descripcion": "Liquidar orden de compra"
"precio_unitario": "100.00",
"um": {
"factor": 1,
"nombre": "Pieza"
}
}
]
|
| comentarios | String | Comentario para el registro del consumo interno |
{% tabs %}
{% tab title="200" %}
```
{
"id": 573456,
"status": 1,
"almacen": 9,
"fecha": "2026-03-05",
"fecha_vencimiento": "2026-03-05",
"iva": "0.000000",
"subtotal": "0.00",
"total": "0.000000",
"uso_cfdi": null,
"comentarios": "Comentario de ejemplo",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [],
"creado": "2026-03-05T12:39:12.426583-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 605,
"folio_completo": "605",
"vendedor": "",
"url_pdf": "",
"cliente": [],
"motivo": "Comentario de ejemplo"
}
```
{% endtab %}
{% endtabs %}
# Cotizaciones
## Obtener un listado de Cotizaciones
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/cotizaciones/`
#### Parámetros GET disponibles
| Name | Type | Description |
| ---------------------- | ------- | --------------------------------------------------------------------------- |
| cliente | integer | Filtro por ID de cliente |
| cliente\_razon\_social | string | Filtro por razón social de cliente |
| fecha | string | Filtro por fecha (formato YYYY-MM-DD) |
| desde | string | Filtro por fecha donde sea mayor o igual a este valor (formato YYYY-MM-DD) |
| hasta | string | Filtro por fecha donde sea menor o igual a este valor (formato YYYY-MM-DD) |
| prospecto | integer | Filtro por ID de prospecto |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 368,
"next": "https://{clave}.admintotal.com/api/v2/cotizaciones/",
"previous": null,
"results": [
{
"id": 25319,
"saldo": "0.00",
"folio": 222,
"serie": "",
"orig_total": "297.000000",
"moneda": {
"nombre": "MXN"
},
"cancelado": false,
"almacen": 1545,
"motivo_cancelacion": "",
"folio_completo": "222",
"fecha": "09/11/2021",
"fecha_vencimiento": "19/11/2021",
"folio_serie": "000222",
"vencida": false,
"cliente": {
"id": 1522,
"activo": true,
"tipo_cliente": 1,
"razon_social": "PUBLICO EN GENERAL",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "XAXX010101000",
"curp": "",
"limite_credito": "10000000.00",
"representante_legal": "",
"direccion": {
"id": 3283,
"municipio": "",
"localidad": "",
"estado": "",
"calle": ".",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": 10,
"saldo_pendiente": "1796182.8100",
"dias_credito": 10
}
}
]
}
```
{% endtab %}
{% endtabs %}
## Crear una Cotización
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/cotizaciones/`
Se tiene que especificar como mínimo un dato de estos datos del cliente (cliente, cliente\_rfc o cliente\_razon\_social)
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| almacen | String | ID del almacén (en caso de no especificar se tomará el primer almacén) |
| cliente | String | ID de cliente (este parámetro es opcional si se especifica cliente_razon_social) |
| cliente_email | String | Email del cliente |
| cliente_razon_social | String | Razón social del cliente (este parámetro es opcional si se especifica cliente) |
| cliente_telefono | String | Teléfono del cliente |
| detalles | Array | Lista de objetos con la información de los productos de la factura (para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor), ejemplo: [
{
"cantidad": "1.00",
"producto_codigo": "CAPCON",
"descripcion": "Descripción del producto",
"precio_unitario": "100.00",
"um": {
"factor": 1,
"nombre": "Pieza"
}
}
]
|
| fecha | String | Fecha de la cotización en formato ISO |
| cliente_rfc | String | RFC del cliente (este parámetro es opcional si se especifica cliente) |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 368,
"next": "https://{clave}.admintotal.com/api/v2/cotizaciones/",
"previous": null,
"results": [
{
"id": 25319,
"saldo": "0.00",
"folio": 222,
"serie": "",
"orig_total": "297.000000",
"moneda": {
"nombre": "MXN"
},
"cancelado": false,
"almacen": 1545,
"motivo_cancelacion": "",
"folio_completo": "222",
"fecha": "09/11/2021",
"fecha_vencimiento": "19/11/2021",
"folio_serie": "000222",
"vencida": false,
"cliente": {
"id": 1522,
"activo": true,
"tipo_cliente": 1,
"razon_social": "PUBLICO EN GENERAL",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "XAXX010101000",
"curp": "",
"limite_credito": "10000000.00",
"representante_legal": "",
"direccion": {
"id": 3283,
"municipio": "",
"localidad": "",
"estado": "",
"calle": ".",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": 10,
"saldo_pendiente": "1796182.8100",
"dias_credito": 10
}
}
]
}
```
{% endtab %}
{% endtabs %}
# Cuenta
## Obtener listado de entradas almacén.
`GET` `https://{clave}.admintotal.com/api/v2/cuentas/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
"count": 8,
"next": "http://{clave}.admintotal.com/api/v2/cuentas/",
"previous": null,
"results": [
{
"id": 1,
"padre": 1,
"numero_cuenta": "704.23.02",
"descripcion": "Descripción de ejemplo",
"alias": null,
"naturaleza": "Acreedora",
"clasificacion": "Ingresos"
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una cuenta.
`GET` `https://{clave}.admintotal.com/api/v2/cuentas/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
{
"id": 1,
"padre": 1,
"numero_cuenta": "704.23.02",
"descripcion": "Descripción de ejemplo",
"alias": null,
"naturaleza": "Acreedora",
"clasificacion": "Ingresos"
}
```
{% endtab %}
{% endtabs %}
# Cuentas bancarias
## Obtener lista de cuentas bancarias
`GET` `https://{clave}.admintotal.com/api/v2/cuentas_bancarias/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 313,
"next": "https://{clave}.admintotal.com/api/v2/cuentas_bancarias/",
"previous": null,
"results": [
{
"id": 1530,
"activo": true,
"banco": "BANORTE/IXE",
"clabe": "11111111111111111",
"saldo_inicial": "1000.00",
"descripcion": "Cuenta d Prueba",
"moneda": "MXN",
"cuenta_contable": "102.01.01",
"tipo_cuenta": "Tarjeta de débito"
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una cuenta bancaria
`GET` `https://{clave}.admintotal.com/api/v2/cuentas_bancarias/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"id": 1530,
"activo": true,
"banco": "BANORTE/IXE",
"clabe": "11111111111111111",
"saldo_inicial": "1000.00",
"descripcion": "Cuenta d Prueba",
"moneda": "MXN",
"cuenta_contable": "102.01.01",
"tipo_cuenta": "Tarjeta de débito"
}
```
{% endtab %}
{% endtabs %}
# Empleado
## Obtener lista de Empleados
`GET` `https://{clave}.admintotal.com/api/v2/empleados/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 313,
"next": "https://{clave}.admintotal.com/api/v2/empleados/",
"previous": null,
"results": [
{
"id": 1779,
"usuario_creado": null,
"usuario_modificado": null,
"activo": true,
"modificado": "2021-03-16T10:25:52.218862-07:00",
"creado": "2021-03-16T10:25:52.204124-07:00",
"comentarios": "",
"metodo_pago": 0,
"metodo_de_pago": null,
"apodo": "",
"empresa_rfc": "",
"empresa_rfc_variable": "",
"user": null,
"clave": "0368",
"tipo_nomina": "s",
"nombre": "Fabian Alejandro",
"apellido_paterno": "Abril",
"apellido_materno": "Rondan",
"almacen": 9,
"es_vendedor": false,
"es_repartidor": false,
"almacenes": [],
"tipo_cobro": false,
"comision_venta": "0.00",
"categoria": 1,
"puesto": "",
"direccion": {
"id": 3924,
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"rfc": "AIRF980120UP1",
"celular": null,
"curp": "AIRF980120HSRBNB03",
"foto_empleado": null,
"ife": null,
"comprobante": null,
"nss": "18199811946",
"imss_umf": "",
"sucursal_banco": "",
"fecha_nacimiento": null,
"lugar_nacimiento_estado": "",
"lugar_nacimiento_ciudad": "",
"tiene_infonavit": false,
"tipo_infonavit": 0,
"infonavit_numero": null,
"infonavit_vsm": "0.00000",
"infonavit_porcentaje": "0.0000",
"infonavit_cuota_fija": "0.0000",
"esta_activo": false,
"salario": "0.00",
"ultima_entrada": null,
"fecha": "2021-03-16",
"nombre_completo": "Abril Rondan Fabian Alejandro",
"cuenta_bancaria": null,
"banco_nombre": "",
"cantidad_fija": "0.00",
"cantidad_variable": "0.00",
"clase": null,
"factor_integracion": "1.04520",
"num_empleado": "",
"tipo_regimen": 2,
"departamento_empleado": null,
"clabe": "",
"fecha_iniciorel_laboral": null,
"tipo_contrato": "",
"tipo_jornada": "",
"riesgo_puesto": 0,
"salario_diario_integrado": "0.000000",
"registro_patronal": null,
"meta_ventas": "0.00",
"meta_utilidad": "0.00",
"sexo": null,
"estado_civil": null,
"usa_aguinaldo": false,
"usa_ptu": false,
"ptu": 1,
"tipo_empleado": null,
"base_pago_sueldo": null,
"clave_mesero": null,
"numero_comanda_inicial": 1,
"numero_comanda_final": null,
"ac_no": null,
"checador_monto_hora": "0.0000",
"checador_monto_bono": "0.0000",
"es_asesor_servicios": false,
"es_tecnico_servicios": false,
"vehiculo_entrega": null,
"usa_prima_dominical": false,
"dias": 6,
"es_externo": false,
"tercero": null,
"licencia_conducir": null,
"requiere_licencia_conducir": false,
"numero_licencia": "",
"tipo_licencia": null,
"fecha_expedicion_licencia": null,
"fecha_vencimiento_licencia": null,
"pasaporte": null,
"requiere_pasaporte": false,
"numero_pasaporte": "",
"fecha_expedicion_pasaporte": null,
"fecha_vencimiento_pasaporte": null,
"usar_salario_mixto": false,
"tipo_trabajador": 1,
"tipo_salario": 0,
"jornada_reducida": 0,
"tipo_gasto": null,
"outsourcing": false,
"fecha_termino_infonavit": null,
"fecha_inicio_infonavit": null
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un Empleado
`GET` `https://{clave}.admintotal.com/api/v2/empleados/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 313,
"next": "https://{clave}.admintotal.com/api/v2/empleados/",
"previous": null,
"results": [
{
"id": 1779,
"usuario_creado": null,
"usuario_modificado": null,
"activo": true,
"modificado": "2021-03-16T10:25:52.218862-07:00",
"creado": "2021-03-16T10:25:52.204124-07:00",
"comentarios": "",
"metodo_pago": 0,
"metodo_de_pago": null,
"apodo": "",
"empresa_rfc": "",
"empresa_rfc_variable": "",
"user": null,
"clave": "0368",
"tipo_nomina": "s",
"nombre": "Fabian Alejandro",
"apellido_paterno": "Abril",
"apellido_materno": "Rondan",
"almacen": 9,
"es_vendedor": false,
"es_repartidor": false,
"almacenes": [],
"tipo_cobro": false,
"comision_venta": "0.00",
"categoria": 1,
"puesto": "",
"direccion": {
"id": 3924,
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"rfc": "AIRF980120UP1",
"celular": null,
"curp": "AIRF980120HSRBNB03",
"foto_empleado": null,
"ife": null,
"comprobante": null,
"nss": "18199811946",
"imss_umf": "",
"sucursal_banco": "",
"fecha_nacimiento": null,
"lugar_nacimiento_estado": "",
"lugar_nacimiento_ciudad": "",
"tiene_infonavit": false,
"tipo_infonavit": 0,
"infonavit_numero": null,
"infonavit_vsm": "0.00000",
"infonavit_porcentaje": "0.0000",
"infonavit_cuota_fija": "0.0000",
"esta_activo": false,
"salario": "0.00",
"ultima_entrada": null,
"fecha": "2021-03-16",
"nombre_completo": "Abril Rondan Fabian Alejandro",
"cuenta_bancaria": null,
"banco_nombre": "",
"cantidad_fija": "0.00",
"cantidad_variable": "0.00",
"clase": null,
"factor_integracion": "1.04520",
"num_empleado": "",
"tipo_regimen": 2,
"departamento_empleado": null,
"clabe": "",
"fecha_iniciorel_laboral": null,
"tipo_contrato": "",
"tipo_jornada": "",
"riesgo_puesto": 0,
"salario_diario_integrado": "0.000000",
"registro_patronal": null,
"meta_ventas": "0.00",
"meta_utilidad": "0.00",
"sexo": null,
"estado_civil": null,
"usa_aguinaldo": false,
"usa_ptu": false,
"ptu": 1,
"tipo_empleado": null,
"base_pago_sueldo": null,
"clave_mesero": null,
"numero_comanda_inicial": 1,
"numero_comanda_final": null,
"ac_no": null,
"checador_monto_hora": "0.0000",
"checador_monto_bono": "0.0000",
"es_asesor_servicios": false,
"es_tecnico_servicios": false,
"vehiculo_entrega": null,
"usa_prima_dominical": false,
"dias": 6,
"es_externo": false,
"tercero": null,
"licencia_conducir": null,
"requiere_licencia_conducir": false,
"numero_licencia": "",
"tipo_licencia": null,
"fecha_expedicion_licencia": null,
"fecha_vencimiento_licencia": null,
"pasaporte": null,
"requiere_pasaporte": false,
"numero_pasaporte": "",
"fecha_expedicion_pasaporte": null,
"fecha_vencimiento_pasaporte": null,
"usar_salario_mixto": false,
"tipo_trabajador": 1,
"tipo_salario": 0,
"jornada_reducida": 0,
"tipo_gasto": null,
"outsourcing": false,
"fecha_termino_infonavit": null,
"fecha_inicio_infonavit": null
}
]
}
```
{% endtab %}
{% endtabs %}
# Entradas Almacén
## Obtener listado de entradas almacén.
`GET` `https://{clave}.admintotal.com/api/v2/entradas_almacen/`
#### Headers
| Name | Type | Description |
|---|
| almacen | integer | Filtro por ID de almacén |
| tipo_movimiento | string | Filtrar por tipo de movimiento, las opciones disponibles son:
COMPRA
DEVOLUCION CLIENTE
ENTRADA AJUSTE
TRASPASO ENTRADA
INVENTARIO FISICO
CONVERSION ENTRADA
ENTRADA POR PRODUCCION |
| fecha | string | Filtro por fecha (formato YYYY-MM-DD) |
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
"count": 8,
"next": "http://{clave}.admintotal.com/api/v2/entradas_almacen/",
"previous": null,
"results": [
{
"id": 573158,
"folio": 317,
"almacen": 1552,
"serie": "",
"folio": 100,
"folio_factura": "I62780",
"fecha": "2026-03-05T09:36:29-07:00",
"cancelado": false,
"fecha_cancelacion": null,
"tipo_movimiento": "COMPRA",
"cfdi_uuid": "XXXXX-7A9E-4EE1-A371-AAAAA",
"origen_creado": "Liquidar orden de compra",
"detalles": []
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una entrada almacén.
`GET` `https://{clave}.admintotal.com/api/v2/entradas_almacen/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
{
"id": 573158,
"saldo": "0.0",
"folio": 317,
"orig_total": "0.0",
"cancelado": false,
"almacen": 1552,
"tipo_movimiento": "COMPRA",
"origen_creado": "Liquidar orden de compra",
"detalles": [
{
"id": 1831246,
"producto": {
"id": 37496,
"codigo": "PRODUCTO DE EJEMPLO",
"linea": "LINEA DE EJEMPLO",
"descripcion": "Lorem ipsum dolor..."
},
"cantidad": 4.0,
"descripcion_adicional": "",
"unidad": {
"id": 1531,
"nombre": "PIEZA",
"factor": "1.00000000"
},
"precio_um": "0.0",
"precio_unitario": "0.0",
"importe": "0.0",
"total": "0.0",
"iva": "0.0",
"ieps": "0.0"
}
],
"proveedor": {
"id": 8087,
"activo": true,
"tipo_cliente": 1,
"razon_social": "CLIENTE DE PRUEBA S.A DE C.V",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "XXXXXXXXX",
"curp": "",
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 546,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "campeche",
"colonia": "San Benito",
"cp": "83190",
"telefono": "",
"email": "",
"numero_e": "xx",
"numero_i": "",
"pais_residencia": "MX",
"latitud": "xxxx",
"longitud": "xxxx",
"referencia": null
},
"bloquear_vencido": false,
"dias_cortar_credito": 0,
"dias_credito": 0,
"regimen_fiscal": "XXX",
"direccion_txt": "XXXXXXXXXXX",
"almacen_precios": null,
"clasificacion": null,
"segmentacion": null
}
}
```
{% endtab %}
{% endtabs %}
# Facturas
Consultar, editar o crear facturas a clientes
## Endpoints disponibles
| Method | Endpoint |
|---|
| GET | https://{clave}.admintotal.com/api/v2/movimientos/facturas/ |
| GET | https://{clave}.admintotal.com/api/v2/movimientos/facturas/{id}/ |
| POST | https://{clave}.admintotal.com/api/v2/movimientos/facturas/ |
## Obtener el listado de facturas
Obtiene el listado de facturas registradas. \
La consulta puede limitarse utilizando los parámetros de filtrado disponibles.
**GET** `https://{clave}.admintotal.com/api/v2/movimientos/facturas/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | ---------------------- |
| Api-key | string | Token de autenticacion |
| {% endtab %} | | |
{% tab title="Parámetros GET" %}
| Name | Type | Description | Values |
|---|
cliente | integer | Filtro por identificador único del cliente. | — |
cliente_razon_social | string | Filtro por razón social de cliente. | — |
fecha | string | Filtro por fecha. | Formato: YYYY-MM-DD |
desde | string | Filtro por fecha donde sea mayor o igual a este valor. | Formato: YYYY-MM-DD |
hasta | string | Filtro por fecha donde sea menor o igual a este valor. | Formato: YYYY-MM-DD |
uuid | string | Filtro por UUID. | — |
folio | integer | Filtro por folio. | — |
serie | string | Filtro por serie. | — |
cancelado | integer | Filtro por movimiento cancelado. | 0: Mostrará solo activos.
1: Mostrará solo cancelados. |
centro_responsabilidad | integer | Filtro por identificador único del centro de responsabilidad. | — |
{% endtab %}
{% tab title="200 OK" %}
```json
}
"count": 722,
"next": "https://{clave}.admintotal.com/api/v2/clientes/",
"previous": null,
"results": [
{
"id": 4659569,
"status": 1,
"status_display": "Pendientes",
"almacen": 9,
"fecha": "2026-09-03",
"fecha_vencimiento": "2026-09-03",
"iva": "20.800000",
"subtotal": "130.00",
"total": "150.800000",
"uso_cfdi": "G01",
"comentarios": "",
"mostrar_comentarios": true,
"forma_pago": "01",
"detalles": [
{
"id": 5323921,
"factura": null,
"producto": 8355,
"cantidad": "1.0000",
"precio_unitario": "130.000000",
"importe": "130.000000",
"iva": "20.800000",
"ieps": "0.000000",
"entrega_domicilio": true
}
],
"creado": "2026-09-03T16:58:23.884366-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"factura_pagada": "Sí",
"vendedor": "",
"saldo": "150.80",
"mensualidad": null,
"condicion": "Contado",
"poliza_texto": "",
"descuento": "0.00",
"moneda": "MXN",
"direccion_entrega": {
"id": 32980,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"folio": 208,
"folio_completo": "F208",
"centro_responsabilidad": {
"id": 4,
"numero": "3",
"nombre": "TERCERO"
},
"url_pdf": "http://{clave}.admintotal.com/admin/pdf_salida/4659569/",
"cliente": {
"id": 1850,
"activo": true,
"tipo_cliente": 2,
"razon_social": "Empresa cliente",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "HHH140305BI0",
"curp": "",
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 24827,
"municipio": "Hermosillo, Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Blvd Antonio Quiroga",
"colonia": "Real de Quiroga",
"cp": "83224",
"telefono": "",
"email": "email@empresa.com",
"numero_e": "142",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": null
},
"bloquear_vencido": true,
"dias_cortar_credito": 0,
"dias_credito": 0,
"regimen_fiscal": "616",
"creado": "2023-01-31T11:06:18.440186-07:00",
"usuario_creado": 23,
"direccion_txt": "Blvd Antonio Quiroga 142 C.P. 83224 Hermosillo, Sonora.",
"almacen_precios": {
"id": 9,
"codigo": "001",
"nombre": "001 Matriz"
},
"clasificacion": null,
"segmentacion": null
},
"metodo_pago": 0
},
...
]
}
```
{% endtab %}
{% endtabs %}
### Campos principales facturas
| Name | Type | Description | Values |
|---|
id | integer | Identificador único de la factura creada. | — |
status | integer | Identificador numérico del estado actual de la factura. | — |
status_display | string | Descripción legible del estado actual de la factura. | — |
almacen | integer | Identificador del almacén asociado a la factura. | — |
fecha | string | Fecha de la factura. | Formato: YYYY-MM-DD |
fecha_vencimiento | string | Fecha de vencimiento de la factura. | Formato: YYYY-MM-DD |
iva | decimal | Importe total correspondiente al IVA. | — |
subtotal | decimal | Importe de la factura antes de impuestos. | — |
total | decimal | Importe total de la factura. | — |
uso_cfdi | string | Clave de uso del CFDI asignada a la factura. | — |
comentarios | string | Comentarios asociados a la factura. | — |
mostrar_comentarios | boolean | Configurar si se desea mostrar los comentarios ingresados en la factura. | — |
forma_pago | string | Clave SAT correspondiente a la forma de pago. Si no se especifica, se intentará utilizar la configurada en el cliente. | — |
detalles | array | Productos incluidos en la factura. | — |
creado | datetime | Fecha y hora en que se creó el registro. | Formato: YYYY-MM-DDTHH:mm:ss±hh:mm |
xml_timbrado | string | Timbre Fiscal Digital autorizado y validado por el SAT. | — |
cfdi_uuid | string | UUID del xml de la factura. | — |
cfdi_status | string | Guarda el mensaje de error arrojado al intentar timbrar. | — |
cancelado | boolean | Saber si la factura se encuentra cancelada o no. | — |
motivo_cancelacion | string | Motivo por el cual la factura fue cancelada. | — |
usuario_cancelacion | integer | Identificador numérico del usuario que canceló la factura. | — |
fecha_cancelacion | string | Fecha de cancelación de la factura. | Formato: YYYY-MM-DD |
fecha_entrega | string | Fecha de entrega de la factura. | Formato: YYYY-MM-DD |
hora_entrega_a | string | Hora de inicio de la entrega. | Formato: HH:MM AM/PM |
hora_entrega_b | string | Hora de fin de la entrega. | Formato: HH:MM AM/PM |
factura_pagada | string | Indicador de la factura se encuentra pagada. | — |
vendedor | string | Nombre del vendedor de la factura. | — |
saldo | decimal | Total neto de la factura. | — |
mensualidad | integer | Identificador numérico de la mensualidad asociada a la factura. | — |
condicion | string | Plazo para la liquidación de la factura. | — |
poliza_texto | string | Número de Póliza. | — |
descuento | decimal | Descuento aplicado para la factura. | — |
moneda | string | Moneda en la que se expresan los importes de la factura. | — |
direccion_entrega | object | Dirección de entrega asociada a la factura. | — |
folio | integer | Número de folio asignado a la factura. | — |
folio_completo | string | Folio de la factura con el formato utilizado por el sistema. | — |
centro_responsabilidad | object | Centro de responsabilidad ligado a la factura. | — |
url_pdf | string | URL del PDF de la factura. | — |
cliente | object | Información del cliente asociado a la factura. | — |
metodo_pago | string | Método de pago del CFDI. Valores permitidos: PPD o PUE. Si no se especifica, se intentará utilizar el configurado en el cliente. | — |
Status ( status )
| Value | Description |
|---|
1 | Pendiente |
2 | Parciales |
3 | No pendiente |
4 | Cerrado |
5 | Aprobado |
21 | En proceso |
22 | Terminada |
23 | Entregada |
24 | Cancelada |
25 | Cerrada por cancelación backorder |
30 | Incidencia |
Formas de pago ( forma_pago )
| Value | Description |
|---|
01 | Efectivo. |
02 | Cheque nominativo. |
03 | Transferencia electrónica de fondos. |
04 | Tarjeta de crédito. |
05 | Monedero electrónico. |
06 | Dinero electrónico. |
08 | Vales de despensa. |
12 | Dación en pago. |
13 | Pago por subrogación. |
14 | Pago por consignación. |
15 | Condonación. |
17 | Compensación. |
23 | Novación. |
24 | Confusión. |
25 | Remisión de deuda. |
26 | Prescripción o caducidad. |
27 | A satisfacción del acreedor. |
28 | Tarjeta de débito. |
29 | Tarjeta de servicio. |
30 | Aplicación de anticipos. |
31 | Intermediario pagos. |
99 | Por definir. |
Detalles ( detalles )
El arreglo `detalles` contiene los productos o conceptos que conforman la factura.\
Cada elemento representa una partida de la factura.
```
[
{
"id": 33,
"producto": 8355,
"cantidad": "1.0000",
"precio_unitario": "130.000000",
"importe": "1560.000000",
"iva": "249.600000",
"ieps": "0.000000",
"entrega_domicilio": true
}
],
```
#### Campos de cada detalle.
| Name | Type | Description |
|---|
id | integer | Identificador único del detalle |
producto | integer | Identificador único del producto. |
cantidad | decimal | Cantidad del producto incluida en la factura. |
precio_unitario | decimal | Precio por unidad del producto. |
importe | string | Importe del producto. |
iva | decimal | IVA del producto. |
ieps | decimal | IEPS del producto. |
entrega_domicilio | boolean | Indicador que el producto requiere entregar a domicilio. |
Factura pagada ( factura_pagada )
La factura **se marca como pagada** cuando su saldo se reduce a cero.
| value | Description |
|---|
| "Si" | Factura pagada. |
| "No" | Factura NO pagada. |
| "Cancelada" | Factura cancelada. |
Centro de Responsabilidad ( centro_responsabilidad )
| Name | Type | Description |
|---|
id | integer | Identificador único del centro de responsabilidad. |
numero | string | Número que se le definió al centro de responsabilidad. |
nombre | string | Nombre del centro de responsabilidad. |
Dirección de entrega ( direccion_entrega )
El objeto `direccion_entrega` contiene la información del domicilio en el que se realizará la entrega.
| Name | Type | Descripcion |
|---|
nombre | string | Nombre utilizado para identificar la dirección de entrega. |
direccion | object | Datos completos del domicilio. |
es_sucuersal | boolena | Indica si la dirección corresponde a una sucursal registrada. |
**direccion\_entrega.direccion**
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
Cliente ( cliente )
| Name | Type | Description |
|---|
id | integer | Identificador único del cliente. |
activo | boolean | Indicador de actividad del cliente |
tipo_cliente | number | Tipo de cliente. |
razon_social | string | Razón social o nombre fiscal del cliente. |
codigo | string | Código interno utilizado para identificar al cliente. |
referencia | string | Referencia adicional asociada al cliente. |
nombre_comercial | string | Nombre comercial del cliente. |
sitio_web | string | Sitio web del cliente. |
rfc | string | RFC del cliente |
curp | string | CURP del cliente. |
limite_credito | decimal | Monto máximo de crédito autorizado para el cliente. |
representante_legal | string | Representante legal del cliente. |
direccion | object | Objeto de relacion con una direccion por Información del domicilio principal del cliente. |
bloquear_vencido | boolean | Restringir ventas con facturas vencidas. |
dias_cortar_credito | integer | Días de gracia por defecto para facturas vencidas. |
dias_credito | integer | Número de días de crédito otorgados al cliente. |
regimen_fiscal | string | Régimen Fiscal del cliente. |
creado | string | Identificador único del usuario que creó al cliente. |
usuario_creado | integer | Usuario que creó el registro del cliente. |
direccion_txt | string | Direccion escrita del cliente. |
almacen_precios | object | Precios por almacén del cliente. |
clasificacion | object | Clasificación del cliente. |
segmentacion | object | Segmentación del cliente. |
## Obtener una factura
Obtiene la información detallada de un cliente específico.
**GET** `https://{clave}.admintotal.com/api/v2/movimientos/facturas/{id}/`
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------- |
| Api-key | string | Token de autenticación. |
| {% endtab %} | | |
{% tab title="Respuesta 200" %}
```json
{
"id": 4659569,
"status": 1,
"status_display": "Pendientes",
"almacen": 9,
"fecha": "2026-09-03",
"fecha_vencimiento": "2026-09-03",
"iva": "20.800000",
"subtotal": "130.00",
"total": "150.800000",
"uso_cfdi": "G01",
"comentarios": "",
"mostrar_comentarios": true,
"forma_pago": "01",
"detalles": [
{
"id": 5323921,
"factura": null,
"producto": 8355,
"cantidad": "1.0000",
"precio_unitario": "130.000000",
"importe": "130.000000",
"iva": "20.800000",
"ieps": "0.000000",
"entrega_domicilio": true
}
],
"creado": "2026-09-03T16:58:23.884366-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"factura_pagada": "Si",
"vendedor": "",
"saldo": "150.80",
"mensualidad": null,
"condicion": "Contado",
"poliza_texto": "",
"descuento": "0.00",
"moneda": "MXN",
"direccion_entrega": {
"id": 32980,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"folio": 208,
"folio_completo": "F208",
"centro_responsabilidad": {
"id": 4,
"numero": "3",
"nombre": "TERCERO"
},
"url_pdf": "http://{clave}.admintotal.com/admin/pdf_salida/4659569/",
"campos_personalizados": [],
"movimiento_origen": null,
"movimientos_relacionados": [],
"cliente": {
"id": 1850,
"activo": true,
"tipo_cliente": 2,
"razon_social": "Empresa cliente",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "HHH140305BI0",
"curp": "",
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 24827,
"municipio": "Hermosillo, Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Blvd Antonio Quiroga",
"colonia": "Real de Quiroga",
"cp": "83224",
"telefono": "",
"email": "email@empresa.com",
"numero_e": "142",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": null
},
"bloquear_vencido": true,
"dias_cortar_credito": 0,
"dias_credito": 0,
"regimen_fiscal": "616",
"creado": "2023-01-31T11:06:18.440186-07:00",
"usuario_creado": 23,
"direccion_txt": "Blvd Antonio Quiroga 142 C.P. 83224 Hermosillo, Sonora.",
"almacen_precios": {
"id": 9,
"codigo": "001",
"nombre": "001 Matriz"
},
"clasificacion": null,
"segmentacion": null
},
"metodo_pago": 0
}
```
{% endtab %}
{% endtabs %}
### Campos adicionales disponibles al consultar una factura individual
{% hint style="info" %}
Cuando se consulta una factura de forma individual, se muestran campos adicionales que permiten obtener información más detallada sobre esa factura en especifico.
{% endhint %}
| Name | Type | Descripcion |
|---|
movimiento_origen | string | Describe desde que parte del sistema fue creada la factura. |
movimientos_relacionados | array | Muestra los documentos relacionados a la factura. |
campos_personalizados | array | Campos personalizados. |
Detalles ( detalles )
Campos adicionales en los detalles al consultar una factura individual.
| Name | Type | Description |
|---|
descripcion | string | Identificador único del detalle. |
descripcion_adicional | string | Identificador único del producto. |
## Crear Factura
Crea una nueva factura asociada a un cliente.
**POST** `https://{clave}.admintotal.com/api/v2/movimientos/facturas/`
### Request Body
{% tabs %}
{% tab title="Headers" %}
| Name | Type | Description |
| ------------ | ------ | ----------------------- |
| Api-key | string | Token de autenticación. |
| {% endtab %} | | |
{% tab title="Ejemplo Body" %}
#### Body básico para crear una factura.
El siguiente ejemplo muestra la estructura mínima o básica que puede enviarse en el cuerpo de la solicitud para crear una factura. Los campos pueden variar según los datos requeridos para cada cliente o factura.
```json
{
"fecha": null,
"cliente": 2647,
"almacen": null,
"comentarios": "",
"detalles": [
{
"producto": 8355,
"cantidad": "1.0000",
"um": {
"nombre": "Caja",
"factor": 12
},
"precio_unitario": "130.000000",
"descripcion_adicional": "Descripción de prueba 2"
}
],
"vendedor": null,
"mostrar_comentarios": false,
"campos_personalizados": [],
"cliente_rfc": "AMR091120QD6",
"cliente_cp": "",
"cliente_regimen_fiscal": "",
"uso_cfdi": "",
"codigo_cliente": "",
"codigo_almacen": "",
"forma_pago": ""
}
```
{% endtab %}
{% endtabs %}
| Name | Type | Required | Description |
|---|
fecha | string | No | Fecha de la factura.
Formato: YYYY-MM-DD |
cliente | integer | Si | Identificador único del cliente. Puede utilizarse cuando no se envía cliente_rfc. |
almacen | integer | No | Identificador único del almacén. Si no se especifica, se utilizará el primer almacén. |
direccion_entrega | object | No | Información de la dirección en la que se realizará la entrega. |
comentarios | string | No | Comentarios u observaciones asociados a la factura. |
detalles | array | Si | Lista de productos que conforman la factura.
(Para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor) |
vendedor | integer | No | Identificador único del empleado que será asignado como vendedor de la factura. |
mostrar_comentarios | boolean | No | Indica si los comentarios de la factura deben mostrarse. |
campos_personalizados | array | No | Lista de campos personalizados. |
cliente_rfc | string | No | RFC del cliente. Puede utilizarse para identificar al cliente cuando no se envía cliente. |
cliente_cp | string | No | Código postal del cliente. |
cliente_regimen_fiscal | string | No | Régimen fiscal del cliente. |
uso_cfdi | string | No | Clave del Uso de CFDI asignado a la factura, conforme al catálogo del SAT. |
codigo_cliente | string | No | Código asignado al cliente. |
codigo_almacen | string | No | Código asignado al almacén. |
carta_porte | object | No | Información requerida para generar el complemento Carta Porte. |
forma_pago | string | No | Clave SAT correspondiente a la forma de pago. Si no se especifica, se intentará utilizar la configurada en el cliente. |
nombre_direccion_entrega | string | No | Nombre asignada a la dirección de entrega. |
Status ( status )
| Value | Description |
|---|
1 | Pendiente |
2 | Parciales |
3 | No pendiente |
4 | Cerrado |
5 | Aprobado |
21 | En proceso |
22 | Terminada |
23 | Entregada |
24 | Cancelada |
25 | Cerrada por cancelación backorder |
30 | Incidencia |
Detalles ( detalles )
El arreglo `detalles` contiene los productos o conceptos que conforman la factura.\
Cada elemento representa una partida de la factura.
```
[
{
"producto": 3131,
"cantidad": 1,
"um": {
"nombre": "Caja",
"factor": 12,
},
"precio_unitario": "30.00",
"descripcion_adicional": "Concepto diferente para esta partida",
}
],
```
#### Campos de cada detalle.
| Name | Type | Description |
|---|
producto | integer | Identificador único del producto. |
cantidad | decimal | Cantidad del producto incluida en la factura. |
um | object | Unidad de medida utilizada para la partida. |
precio_unitario | decimal | Precio por unidad del producto. |
descripcion_adicional | string | Descripción adicional o personalizada de la partida. |
Dirección de entrega ( direccion_entrega )
El objeto `direccion_entrega` contiene la información del domicilio en el que se realizará la entrega.
| Name | Type | Descripcion |
|---|
nombre | string | Nombre utilizado para identificar la dirección de entrega. |
direccion | object | Datos completos del domicilio. |
es_sucuersal | boolena | Indica si la dirección corresponde a una sucursal registrada. |
**direccion\_entrega.direccion**
| Name | Type | Description |
|---|
municipio | string | Municipio de la dirección. |
localidad | string | Localidad de la dirección. |
estado | string | Estado o entidad federativa. |
calle | string | Nombre de la calle. |
colonia | string | Colonia de la dirección. |
cp | string | Código postal. |
telefono | string | Número telefónico asociado a la dirección. |
email | string | Correo electrónico asociado a la dirección. |
numero_e | string | Número exterior. |
numero_i | string | Número interior. |
pais_residencia | string | Clave del país de residencia. |
latitud | decimal | Latitud geográfica de la dirección. |
longitud | decimal | Longitud geográfica de la dirección. |
referencia | string | Información adicional para localizar el domicilio. |
Unidad de medida ( um )
| Name | Type | Description |
|---|
nombre | string | Nombre de la unidad de medida. |
factor | decimal | Factor de la unidad de medida. |
Formas de pago ( forma_pago )
| Value | Description |
|---|
01 | Efectivo. |
02 | Cheque nominativo. |
03 | Transferencia electrónica de fondos. |
04 | Tarjeta de crédito. |
05 | Monedero electrónico. |
06 | Dinero electrónico. |
08 | Vales de despensa. |
12 | Dación en pago. |
13 | Pago por subrogación. |
14 | Pago por consignación. |
15 | Condonación. |
17 | Compensación. |
23 | Novación. |
24 | Confusión. |
25 | Remisión de deuda. |
26 | Prescripción o caducidad. |
27 | A satisfacción del acreedor. |
28 | Tarjeta de débito. |
29 | Tarjeta de servicio. |
30 | Aplicación de anticipos. |
31 | Intermediario pagos. |
99 | Por definir. |
Métodos de pago ( metodo_pago )
| Value | Description |
| ----- | --------------------------------- |
| `PUE` | Pago en una sola exhibición. |
| `PPD` | Pago en parcialidades o diferido. |
Factura pagada ( factura_pagada )
La factura **se marca como pagada** cuando su saldo se reduce a cero.
| value | Description |
|---|
| "Si" | Factura pagada. |
| "No" | Factura NO pagada. |
| "Cancelada" | Factura cancelada. |
Carta Porte ( carta_porte )
El objeto `carta_porte` contiene la información necesaria para generar el complemento Carta Porte cuando la factura lo requiera.
Si la factura no utiliza Carta Porte, este objeto puede enviarse vacío.
| Name | Type | Required | Description |
|---|
| direccion_origen | object | Si | Dirección desde la cual inicia el traslado de las mercancías. |
| fecha_hora_origen | datetime | Si | Fecha y hora de salida desde el origen.
Formato: YYYY-MM-DDTHH:mm:ss±hh:mm
Ejemplo: 2026-08-11T07:06:01+00:00 |
| remitente | integer | Si | Identificador del remitente registrado en el sistema. |
| direccion_destino | object | Si | Dirección final de entrega de las mercancías. |
| fecha_hora_destino | datetime | Si | Fecha y hora estimada o registrada de llegada al destino.
Formato: YYYY-MM-DDTHH:mm:ss±hh:mm
Ejemplo: 2026-08-11T07:06:01+00:00 |
| destinatario | integer | Si | Identificador del cliente destinatario registrado en el sistema. |
| vehiculo | integer | No | Identificador del vehículo utilizado para el traslado. |
| operador | integer | No | Identificador del operador responsable del traslado. |
| distancia_destino | decimal | Si | Distancia recorrida o estimada hasta el destino. |
| remolques | array | No | Lista de placas de remolques asociados al traslado. |
| remitente_rfc | string | No | RFC del remitente. |
| remitente_nombre | string | No | Nombre o razón social del remitente. |
| destinatario_rfc | string | No | RFC del destinatario. |
| destinatario_nombre | string | No | Nombre o razón social del destinatario. |
| vehiculo_placa | string | No | Placa del vehículo utilizado para el traslado. |
| nombre_aseguradora | string | No | Nombre de la aseguradora del vehículo. |
| num_poliza_seguro | string | No | Número de la póliza de seguro. |
| num_permiso_sct | string | No | Número del permiso otorgado. |
| configuracion_vehicular | string | No | Clave de configuración vehicular utilizada en Carta Porte. |
| operador_clave | string | No | Clave interna utilizada para identificar al operador. |
| operador_rfc | string | No | RFC del operador. |
| operador_nombre | string | No | Nombre del operador. |
| operador_direccion | object | Si | Domicilio del operador. |
| num_licencia_operador | string | No | Número de licencia del operador. |
| ubicaciones_intermedias | array | No | Lista de ubicaciones intermedias del recorrido. |
| mercancias | array | No | Lista de mercancías incluidas en el traslado. |
### Respuesta 201 Created
{% tabs %}
{% tab title="201 Created" %}
```json
{
"id": 112,
"status": 1,
"status_display": "Pendientes",
"almacen": 9,
"fecha": "2026-09-08",
"fecha_vencimiento": "2026-10-08",
"iva": "249.600000",
"subtotal": "1560.00",
"total": "1809.600000",
"uso_cfdi": "",
"comentarios": "",
"mostrar_comentarios": false,
"forma_pago": "99",
"detalles": [
{
"id": 3536050,
"producto": 125072,
"cantidad": "3.0000",
"precio_unitario": "220.0000",
"importe": "660.000000",
"iva": "105.600000",
"ieps": "0.000000",
"entrega_domicilio": true
}
],
"creado": "2026-09-08T16:06:34.102774-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"factura_pagada": "No",
"vendedor": "",
"saldo": "",
"mensualidad": null,
"condicion": "",
"poliza_texto": "",
"descuento": "",
"moneda": "MXN",
"folio": 1,
"folio_completo": "",
"centro_responsabilidad": null,
"direccion_entrega": {
"id": 1,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"url_pdf": "",
"cliente": {
"id": 10,
"activo": true,
"tipo_cliente": 1,
"razon_social": "EMPRESA CLIENTE EJEMPLO",
"codigo": "1",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "",
"curp": "",
"limite_credito": "",
"representante_legal": "",
"direccion": {
"id": 1,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"bloquear_vencido": true,
"dias_cortar_credito": null,
"dias_credito": null,
"regimen_fiscal": "",
"creado": "2023-02-17T10:04:55.740310-07:00",
"usuario_creado": 23,
"direccion_txt": "",
"almacen_precios": null,
"clasificacion": null,
"segmentacion": null,
"monedero": "0"
},
"metodo_pago": 1
}
```
{% endtab %}
{% endtabs %}
## Obtener PDF's de facturas
Para consultar el PDF de una factura podemos usar la URL que se retorna en la propiedad `url_pdf` del objeto de factura agregando adicional el parámetro GET `access_token` ó `api_key` dependiendo el caso, ejemplo:
**Ejemplo de la URL si se tiene un token JWT**
https\://{clave}.admintotal.com/api/v2/movimientos/facturas/?access\_token={mi\_access\_token}
**Ejemplo de la URL si se tiene un api key**
https\://{clave}.admintotal.com/api/v2/movimientos/facturas/?api\_key={api\_key}
## Errores HTTP
Posibles códigos de error que puedes encontrar al consumir este recurso.
| | | |
|---|
400
Solicitud invalida | 403
Sin permiso | 404
Registro no encontrado | 500
Error interno del servidor |
# Líneas
## Obtener el listado de lineas de productos
`GET` `https://{clave}.admintotal.com/api/v2/lineas/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 241,
"next": "https://{clave}.admintotal.com/api/v2/lineas/",
"previous": null,
"results": [
{
"id": 1537,
"nombre": "ABARROTES"
},
...
]
}
```
{% endtab %}
{% endtabs %}
# Lista negra
## Lista negra
`GET` `https://{clave}.admintotal.com/api/v2/listanegra/`
#### Query Parameters
| Name | Type | Description |
| ------ | ------- | --------------------------------------------------------- |
| tipo | integer | 1: Definitivo
2: Desvirtuado
3: Presunto
|
| rfc | string | Filtrar los resultados por RFC |
| nombre | string | Filtrar los resultados por nombre de empresa |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Toke para autorizacion |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 11617,
"next": "https://{clave}.admintotal.com/api/v2/listanegra/",
"previous": null,
"results": [
{
"rfc": "AAA091014835",
"nombre": "AQUAERIS ACUACULTURA Y ARQUITECTURA SUSTENTABLE, S.C.",
"tipo": 2
},
{
"rfc": "AAA100303L51",
"nombre": "INGENIOS SANTOS, S.A. DE C.V.",
"tipo": 2
},
{
"rfc": "AAA120730823",
"nombre": "ASESORES Y ADMINISTRADORES AGRICOLAS, S. DE R.L. DE C.V.",
"tipo": 1
},
{
"rfc": "AAA121206EV5",
"nombre": "AMÉRICA ADMINISTRATIVA ARROLLO, S.A. DE CV.",
"tipo": 1
},
{
"rfc": "AAA140116926",
"nombre": "AVALOS & ASOCIADOS CONSULTORIA INTEGRAL, S.C.",
"tipo": 1
},
{
"rfc": "AAA151209DYA",
"nombre": "AYC ADMINISTRACION Y ASESORIA COMERCIAL, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAAA620217U54",
"nombre": "AMADOR AQUINO JOSÉ AVENAMAR",
"tipo": 1
},
{
"rfc": "AAAE910314EJ7",
"nombre": "ALVARADO ALMARAZ ESTEBAN JACOB",
"tipo": 1
},
{
"rfc": "AAAG7012036UA",
"nombre": "ARAGÓN AYALA GRICELDA",
"tipo": 1
},
{
"rfc": "AAAJ830204PA9",
"nombre": "ARAIZA ARAMBULA JUAN CARLOS",
"tipo": 1
},
{
"rfc": "AAAL440727T22",
"nombre": "ALMANZA ALONZO JOSÉ LUIS",
"tipo": 1
},
{
"rfc": "AAAM930220954",
"nombre": "AMADO ACOSTA MARCOS",
"tipo": 1
},
{
"rfc": "AAAT930326EY6",
"nombre": "AMADO AMADO TRINIDAD",
"tipo": 1
},
{
"rfc": "AAAV920808B1A",
"nombre": "ADAME ANTONIO VICTOR ALFONSO",
"tipo": 1
},
{
"rfc": "AAB1011024L8",
"nombre": "ASESORES ADMINISTRATIVOS BAIK S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AABJ650718RI4",
"nombre": "ALCALA BECERRA JUAN MANUEL",
"tipo": 1
},
{
"rfc": "AABK761214SL7",
"nombre": "ALMANZA BRAVO KARLA GRACIELA",
"tipo": 1
},
{
"rfc": "AABM490216DP5",
"nombre": "ALANIS BADILLO MINERVA ",
"tipo": 1
},
{
"rfc": "AABR711124971",
"nombre": "ALMANZA BRAVO ROCIO AMERICA",
"tipo": 3
},
{
"rfc": "AABV7103171I6",
"nombre": "ALMAGUER BARRIOS VERONICA PATRICIA",
"tipo": 1
},
{
"rfc": "AAC051003125",
"nombre": "ALMAGUER ACEROS, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC0608103B5",
"nombre": "ADITIVOS ALTERNOS DEL CENTRO S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC08052734A",
"nombre": "ASESORÍAS ADMINISTRATIVAS CANTÚ MARTÍNEZ, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC100420480",
"nombre": "ACEROS Y ALAMBRES DEL CENTRO, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC111109JE8",
"nombre": "ACRH ASESORES Y CONSULTORES, S.C.",
"tipo": 1
},
{
"rfc": "AAC120810NCA",
"nombre": "AAA ASESORIA Y CAPACITACION EMPRESARIAL, S.C.",
"tipo": 1
},
{
"rfc": "AAC130302DX4",
"nombre": "ADMIN ASESORÍA CORPORATIVA INTEGRAL, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC131022IU7",
"nombre": "ANKARA ASESOR CORPORATIVO, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC131030EPA",
"nombre": "ACES ADMINISTRACIÓN CORPORATIVA DEL SURESTE, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC1312027F4",
"nombre": "ARRENDAMIENTOS AOKI CONSTRUCTORES, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAC950309K87",
"nombre": "ACERO ARMENDARIZ CONSTRUCCIONES, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AACA7306273E2",
"nombre": "ARAUCO CASILLAS ALEJANDRO",
"tipo": 1
},
{
"rfc": "AACC7604146T1",
"nombre": "ALMANZA CHÁVEZ CÉSAR OCTAVIO",
"tipo": 1
},
{
"rfc": "AACG511129DS8",
"nombre": "ABRAHAM CASSALE GUILLERMO",
"tipo": 1
},
{
"rfc": "AACJ841120285",
"nombre": "ALMANZA CHAVEZ JULIAN",
"tipo": 1
},
{
"rfc": "AACL900520TRA",
"nombre": "ADAME CONTRERAS LUIS MANUEL",
"tipo": 1
},
{
"rfc": "AACR841120TD8",
"nombre": "ALMANZA CHÁVEZ RAÚL",
"tipo": 1
},
{
"rfc": "AAD090528LE2",
"nombre": "AP ADVERSITING S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAD121126PD6",
"nombre": "ASESORES ADSERLOG, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAD1305092S8",
"nombre": "ACR ARQUITECTURA Y DISEÑO VERTICAL, S.A DE C.V.",
"tipo": 1
},
{
"rfc": "AAD13080976A",
"nombre": "APDS ADMINISTRA Y DISTRIBUYE SERVICIOS, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AADF880829FV9",
"nombre": "ALBARRAN DIAZ FE DEL CARMEN",
"tipo": 1
},
{
"rfc": "AADH640831ID7",
"nombre": "ARANDA DELGADILLO HECTOR SALVADOR",
"tipo": 1
},
{
"rfc": "AADL9510079M6",
"nombre": "ARANDA DELGADO MA. LIZBETH",
"tipo": 1
},
{
"rfc": "AAE0909143R4",
"nombre": "ADE ADMINISTRACION EMPRESARIAL, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAE140101UX4",
"nombre": "AEI ALIUD EX INGENIA, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAE141208JXA",
"nombre": "ARQET ARQUITECTURA ESPACIO Y TIEMPO, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAEC880127NB8",
"nombre": "AMAYA ENRÍQUEZ CORAL WENDOLYNE",
"tipo": 1
},
{
"rfc": "AAF1307177L2",
"nombre": "AFFYS ASESORÍA FISCAL, FINANCIERA Y DE SEGUROS, S.C.",
"tipo": 1
},
{
"rfc": "AAFC820928KQ3",
"nombre": "ALTAMIRANO FIERRO CARLOS ALEJANDRO",
"tipo": 1
},
{
"rfc": "AAFO591114GI2",
"nombre": "ALCANTAR FLORES OSCAR TRINIDAD",
"tipo": 1
},
{
"rfc": "AAGA4505122T4",
"nombre": "ÁLVAREZ GARCÍA JOSÉ ALFONSO",
"tipo": 1
},
{
"rfc": "AAGD551022SW6",
"nombre": "ALVAREZ GUTIERREZ DIONISIO",
"tipo": 1
},
{
"rfc": "AAGD9110281PA",
"nombre": "ÁLVAREZ GUAJARDO DIEGO ANTONIO",
"tipo": 1
},
{
"rfc": "AAGE821012RNA",
"nombre": "ALVAREZ GARCIA EDGAR RODRIGO",
"tipo": 1
},
{
"rfc": "AAGJ700504133",
"nombre": "ALVARADO GARCIA JORGE",
"tipo": 1
},
{
"rfc": "AAGJ840914P74",
"nombre": "ALVARADO GARCIA JESUS",
"tipo": 1
},
{
"rfc": "AAGJ841016RG8",
"nombre": "ALANÍS GONZÁLEZ JAVIER",
"tipo": 1
},
{
"rfc": "AAGJ890312M1A",
"nombre": "ALVAREZ GUERRA JORGE LUIS",
"tipo": 1
},
{
"rfc": "AAGJ901007K86",
"nombre": "AMAYA GONZÁLEZ JUAN PABLO",
"tipo": 1
},
{
"rfc": "AAGM9208143U8",
"nombre": "AMAYA GONZÁLEZ MÓNICA LIZETH",
"tipo": 1
},
{
"rfc": "AAGN900909G80",
"nombre": "AYALA GARCIA NELIDA GABRIELA",
"tipo": 3
},
{
"rfc": "AAGP8105011D7",
"nombre": "ALFARO GONZÁLEZ PABLO ANTONIO",
"tipo": 1
},
{
"rfc": "AAGR6204035GA",
"nombre": "ARAUJO GARCÍA RICARDO",
"tipo": 1
},
{
"rfc": "AAGV671223684",
"nombre": "ALBARADO GRANADOS JOSE VICTOR",
"tipo": 1
},
{
"rfc": "AAHA5310243B1",
"nombre": "ALVARADO HERNÁNDEZ ANA MARÍA",
"tipo": 1
},
{
"rfc": "AAHE370605TU1",
"nombre": "ALCANTAR HERNÁNDEZ ELOÍSA",
"tipo": 1
},
{
"rfc": "AAHE730926N63",
"nombre": "ADAME HUIZAR ENRIQUE RENE",
"tipo": 1
},
{
"rfc": "AAHG620113QV1",
"nombre": "ALBA HERNANDEZ GEORGINA",
"tipo": 1
},
{
"rfc": "AAHV580710NF0",
"nombre": "ARANZABAL HERNANDEZ VICTOR ALFONSO",
"tipo": 1
},
{
"rfc": "AAHV7701315Y4",
"nombre": "ARAIZA HERNANDEZ VIRGINIA",
"tipo": 1
},
{
"rfc": "AAI0309047KA",
"nombre": "AR APOYO INDUSTRIAL, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAI1205147Z7",
"nombre": "ALTUS ASESORÍA EN IMAGEN Y EVENTOS, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAI140619CRA",
"nombre": "ACCIN, ACCIONES INTEGRALES DE NEGOCIO, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAI140918DR4",
"nombre": "ASFALTOS Y AGREGADOS INDUSTRIALES CAM, S.A. DE C.V. ",
"tipo": 1
},
{
"rfc": "AAI150415L20",
"nombre": "AINSA ASESORÍA INTEGRAL EN NEGOCIOS, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAJ140709TXA",
"nombre": "ALTIPLANO AGAVERO DE JALISCO, S.A. DE C.V. ",
"tipo": 1
},
{
"rfc": "AAL070515MQ3",
"nombre": "AGROINDUSTRIA DEL ALTIPLANO, S. DE R.L. DE C.V.",
"tipo": 1
},
{
"rfc": "AAL0810149K9",
"nombre": "ARRENDAMIENTOS Y ASESORÍAS LUVE, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAL081211JP0",
"nombre": "“A&L CONSULTORES”, S.C.",
"tipo": 1
},
{
"rfc": "AAL090331NXA",
"nombre": "ALIMENTOS ALIVEN S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAL120727SL0",
"nombre": "ADMINISTRADORA ALIANZA, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAL170328AT8",
"nombre": "AGROINDUSTRIALES ALCONCAR, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AALA930814HZ2",
"nombre": "ALVAREZ LOZORNIO ADRIANA ELIZABETH",
"tipo": 1
},
{
"rfc": "AALA950416PB3",
"nombre": "ÁLVAREZ LÓPEZ ALONDRA",
"tipo": 1
},
{
"rfc": "AALB850619540",
"nombre": "ARANDA LÓPEZ BENITO",
"tipo": 1
},
{
"rfc": "AALE621107AG9",
"nombre": "ALCALA LUEVANOS ERNESTO",
"tipo": 1
},
{
"rfc": "AALG9011301H5",
"nombre": "ÁLVAREZ LÓPEZ GUSTAVO",
"tipo": 1
},
{
"rfc": "AALL870304BL7",
"nombre": "ALVAREZ LOPEZ MARIA LUISA",
"tipo": 1
},
{
"rfc": "AALM861123J43",
"nombre": "ALTAMIRANO LÓPEZ JOSÉ MIGUEL",
"tipo": 1
},
{
"rfc": "AAM080220M73",
"nombre": "ABRASIVOS Y ARRENDAMIENTO DE MAQUINARIA, S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAM111107E70",
"nombre": "AMG ASSISTMENT MANAGEMENT S.A. DE C.V.",
"tipo": 1
},
{
"rfc": "AAM130118JYA",
"nombre": "ARQUITECTOS Y ASOCIADOS MOAL, S.A. DE C.V. ",
"tipo": 1
},
{
"rfc": "AAMA8509178Y6",
"nombre": "ARZAGA MENDOZA ARTURO",
"tipo": 1
},
{
"rfc": "AAME681224TW6",
"nombre": "ARAIZA MENDOZA EFRAIN",
"tipo": 1
},
{
"rfc": "AAMK750908MH9",
"nombre": "ALCALÁ MORENO KARINA",
"tipo": 1
},
{
"rfc": "AAML730105N15",
"nombre": "ALCÁNTARA MONTOYA LILIANA",
"tipo": 1
},
{
"rfc": "AAMR620927PRA",
"nombre": "ARZATE MOJICA RAÚL",
"tipo": 1
},
{
"rfc": "AAMR7312046L3",
"nombre": "ANASTASIO MEJIA MARIA DEL ROCIO",
"tipo": 3
},
{
"rfc": "AAMR840608355",
"nombre": "ALVARADO MANRIQUE RAUL GERARDO",
"tipo": 1
}
]
}
```
{% endtab %}
{% endtabs %}
# Mensualidades
## Obtener lista de mensualidades
`GET` `https://{clave}.admintotal.com/api/v2/mensualidades/`
#### Query Parameters
| Name | Type | Description |
| ------------- | ------- | ------------------------------------------------------- |
| id | integer | ID de la mensualidad |
| representante | string | Filtra por ID de representante de cliente de admintotal |
| rfc | string | Filtra por RFC de cliente de admintotal |
| dia\_envio | number | Filtrar por dia de envio |
| almacen | integer | Filtra por ID de almacen |
| cliente | integer | Filtra por ID de Cliente de admintotal |
#### Headers
| Name | Type | Description |
| ------- | ------ | ----------------------- |
| Api-key | string | Token para autorizacion |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
## Agregar nueva mensualidad
`POST` `https://{clave}.admintotal.com/api/v2/mensualidades/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ----------------------- |
| Api-key | string | Token para autorizacion |
#### Request Body
| Name | Type | Description |
| ---------------- | ------- | ---------------------------------------------------- |
| iva | number | IVA del prodcuto de la mensualidad |
| descuento | number | Cantidad de descuento del producto de la mensaulidad |
| importe | number | Importe del producto de la mensualidad |
| precio\_unitario | number | Precio unitario del prodcuto de la mensualidad |
| descripcion | string | Descripcion del producto de la mensualidad |
| cantidad | number | cantidad de prodcutos |
| comentarios | string | Comentarios de la mensualidad |
| moneda | number | Moneda, formatos: 1:"MXN" y 2:"USD" |
| hasta | string | Hasta, formato: dd/mm/aaaa |
| desde | string | Desde, formato: dd/mm/aaaa |
| dia | number | Dia de envio |
| condicion | integer | ID condicion |
| almacen | integer | ID almacen |
| cliente | integer | ID cliente de admintotal |
| codigo\_producto | string | Codigo de producto |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
# Notas de crédito
## Obtener un listado de Notas de Crédito
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/notas_credito/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 162,
"next": "https://{clave}.admintotal.com/api/v2/movimientos/notas_credito/",
"previous": null,
"results": [
{
"id": 25307,
"fecha": "2021-11-04",
"status_display": "Pendientes",
"direccion_entrega": {
"id": 3776,
"municipio": "Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Constitución 1 entre Benito Juarez y Cero",
"colonia": "Colinas",
"cp": "83145",
"telefono": "6622323232",
"email": "",
"numero_e": "432",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"folio": 2094,
"folio_completo": "2094",
"url_pdf": "https://{clave}.admintotal.com/admin/pdf_nota_credito/25307/",
"detalles": [
{
"id": 91861,
"factura": 25263,
"producto": 19782,
"precio_unitario": "40.2003",
"iva": "6.432050",
"importe": "40.200315"
}
],
"cliente": {
"id": 2754,
"activo": true,
"tipo_cliente": 1,
"razon_social": "101 ALVI DCANCUN SA DE CV",
"codigo": "21542",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "RAP970203V75",
"curp": "",
"limite_credito": "500000.00",
"representante_legal": "",
"direccion": {
"id": 3776,
"municipio": "Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Constitución 1 entre Benito Juarez y Cero",
"colonia": "Colinas",
"cp": "83145",
"telefono": "6622323232",
"email": "",
"numero_e": "432",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": 0,
"saldo_pendiente": "8896.3300",
"dias_credito": 0
}
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una Nota de crédito
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/notas_credito/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 162,
"next": "https://{clave}.admintotal.com/api/v2/movimientos/notas_credito/",
"previous": null,
"results": [
{
"id": 25307,
"fecha": "2021-11-04",
"status_display": "Pendientes",
"direccion_entrega": {
"id": 3776,
"municipio": "Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Constitución 1 entre Benito Juarez y Cero",
"colonia": "Colinas",
"cp": "83145",
"telefono": "6622323232",
"email": "",
"numero_e": "432",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"folio": 2094,
"folio_completo": "2094",
"url_pdf": "https://{clave}.admintotal.com/admin/pdf_nota_credito/25307/",
"detalles": [
{
"id": 91861,
"factura": 25263,
"producto": 19782,
"precio_unitario": "40.2003",
"iva": "6.432050",
"importe": "40.200315"
}
],
"cliente": {
"id": 2754,
"activo": true,
"tipo_cliente": 1,
"razon_social": "101 ALVI DCANCUN SA DE CV",
"codigo": "21542",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "RAP970203V75",
"curp": "",
"limite_credito": "500000.00",
"representante_legal": "",
"direccion": {
"id": 3776,
"municipio": "Hermosillo",
"localidad": "",
"estado": "Sonora",
"calle": "Constitución 1 entre Benito Juarez y Cero",
"colonia": "Colinas",
"cp": "83145",
"telefono": "6622323232",
"email": "",
"numero_e": "432",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": 0,
"saldo_pendiente": "8896.3300",
"dias_credito": 0
}
}
]
}
```
{% endtab %}
{% endtabs %}
# Notas de venta
## Obtener listado de notas de venta
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/notas_venta/`
#### Parámetros GET disponibles
| Name | Type | Description |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------- |
| cliente | integer | Filtro por ID de cliente |
| cliente\_razon\_social | string | Filtro por razón social de cliente |
| fecha | string | Filtro por fecha (formato YYYY-MM-DD) |
| desde | string | Filtro por fecha donde sea mayor o igual a este valor (formato YYYY-MM-DD) |
| hasta | string | Filtro por fecha donde sea menor o igual a este valor (formato YYYY-MM-DD) |
| folio | integer | Filtro por folio |
| serie | string | Filtro por serie |
| cancelado | int | Filtro por movimiento cancelado:
0 = Mostrará solo activos
1 = Mostrará solo cancelados
|
{% tabs %}
{% tab title="200 " %}
```
{
"count": 731,
"next": "https://{clave}.admintotal.com/api/v2/movimientos/notas_venta/",
"previous": null,
"results": [
{
"id": 25320,
"status": 1,
"almacen": 1545,
"fecha": "2021-11-09",
"fecha_vencimiento": "2021-11-09",
"iva": "33.103448",
"subtotal": "206.90",
"total": "240.000000",
"uso_cfdi": "P01",
"comentarios": "",
"mostrar_comentarios": true,
"forma_pago": 0,
"detalles": [
{
"id": 91874,
"producto": 11077,
"cantidad": "1.0000",
"precio_unitario": "206.8966",
"importe": "206.896552",
"iva": "33.103448"
}
],
"creado": "2021-11-09T10:40:50.974804-07:00",
"xml_timbrado": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"metodo_pago": "28",
"monto_efectivo": "0.0000",
"monto_tarjeta": "0.0000",
"monto_transferencia": "0.0000",
"monto_cheque": "0.0000",
"status_display": "Pendientes",
"direccion_entrega": {
"id": 3283,
"municipio": "",
"localidad": "",
"estado": "",
"calle": ".",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"folio": 606,
"folio_completo": "606",
"url_pdf": "https://{clave}.admintotal.com/admin/pdf_nota_venta/25320/",
"cliente": {
"id": 1522,
"activo": true,
"tipo_cliente": 1,
"razon_social": "PUBLICO EN GENERAL",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "XAXX010101000",
"curp": "",
"limite_credito": "10000000.00",
"representante_legal": "",
"direccion": {
"id": 3283,
"municipio": "",
"localidad": "",
"estado": "",
"calle": ".",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": 10,
"saldo_pendiente": "1796182.8100",
"dias_credito": 10
}
}
]
}
```
{% endtab %}
{% endtabs %}
## Crear nota de venta
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/notas_venta/`
Para habilitar la auto-facturación de los clientes, es necesario especificar un valores en las propiedades "id\_externo" y "clave\_autofacturacion
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| numero_tarjeta | integer | Últimos 4 digitos de la tarjeta |
| tipo_tarjeta | integer | 1: crédito
2: débito |
| monto_tarjeta | number | Monto de tarjeta |
| monto_efectivo | number | Monto de efectivo |
| detalles | array | Lista de objetos con la información de los productos de la factura (para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor), ejemplo: [
{
"producto": 3131,
"cantidad": 1,
"um": {
"nombre": "Caja",
"factor": 12
},
"precio_unitario": "30.00"
}
]
|
| direccion_entgrega | object | Objeto con la información de dirección de entrega, ejemplo: {
"nombre": "Ejemplo 1",
"direccion": {
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
}
}
|
| comentarios | string | Comentarios sobre la nota de venta |
| fecha | string | Fecha en formato ISO 8601 |
| almacen | integer | ID del almacén (en caso de no especificar se tomará el primer almacén) |
| cliente_rfc | string | RFC del cliente (este parámetro es opcional si se especifica cliente) |
| cliente | integer | ID de cliente (este parámetro es opcional si se especifica cliente_rfc) |
| id_externo | string | Identificador externo para esta nota de venta (ejemplo: puede ser el folio del sistema externo que genera esta nota de venta) |
| clave_facturacion | string | Clave de facturación (6 caracteres recomendado), esta clave la necesita el cliente para auto-facturarse en el portal de facturación (también necesita el id_externo). |
| campos_personalizados | array | Lista de campos personalizados (se validarán los campos personalizados de venta), ejemplo de estructura: [
{
"key": "codigo_reservacion",
"valor": "FKL4646"
},
{
"key": "origen",
"valor": "Sistema externo"
}
]
|
| moneda | string | (Opcional) nombre de la moneda de la nota de venta |
| tipo_cambio | string | (Opcional) tipo de cambio |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
# Ordenes de trabajo
## Obtener listado de OT's
`GET` `https://{clave}.admintotal.com/api/v2/ordenes_servicio/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Query Parameters
| Name | Type | Description |
| ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| status | integer | Filtrar las ordenes de trabajo por estado:
1 = "Abierta"
2 = "En proceso"
3 = "Terminada"
4 = "Cancelada"
5 = "Confirmada"
|
{% tabs %}
{% tab title="200 " %}
```
{
"count": 23,
"next": "https://{clave}.admintotal.com/api/v2/ordenes_servicio/",
"previous": null,
"results": [
{
"id": 11106,
"status": 5,
"prioridad": null,
"bitacora_inicio_cliente": null,
"bitacora_llegada_base": null,
"descripcion": "MANTENIMIENTO A INMUEBLES MANO DE OBRA
",
"status_display": "Confirmada",
"clave": "2761-13-1/1",
"periodicidad": "Mensual",
"prioridad_display": null,
"tipo_servicio": "MANO DE OBRA",
"sucursal": {
"id": 29,
"municipio": "Mérida",
"nombre": "CAC MERIDA IV ORIENTE",
"cliente": "MICLIENTE",
"direccion": "Direccion"
},
"cliente": {
"id": 1532,
"regimen_fiscal": "601",
"rfc": "XXXXX",
"razon_social": "MICLIENTE",
"direccion": "Dirección completa del cliente.",
"colonia": "Ampliación Granada",
"nombre": "MICLIENTE",
"telefono": "(999) 1111-0002",
"email": "",
"representante_legal": "MICLIENTE"
}
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una OT
`GET` `https://{clave}.admintotal.com/api/v2/ordenes_servicio/:id/`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ----------- |
| ID | integer | ID de la OT |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```json
{
"id": 11448,
"status": 5,
"prioridad": null,
"bitacora_inicio_cliente": "2026-01-01T09:44:27-06:00",
"bitacora_llegada_base": "2026-01-27T09:44:27-06:00",
"descripcion": "FALTA DE AGUA
",
"status_display": "Confirmada",
"clave": "7136-1-1/1",
"periodicidad": "-----",
"prioridad_display": null,
"tipo_servicio": "TRABAJOS CORRECTIVOS",
"sucursal": {
"id": 228,
"municipio": "Carmen",
"nombre": "XXXX CD DEL CARMEN",
"cliente": "Nombre del cliente",
"direccion": "Dirección ..."
},
"cliente": {
"id": 1547,
"regimen_fiscal": "601",
"rfc": "XXXXX",
"razon_social": "Nombre del cliente",
"direccion": "Dirección ...",
"colonia": "Hipódromo Condesa",
"nombre": "Nombre del cliente",
"telefono": "(999) 181-4338",
"email": "",
"representante_legal": "Nombre del cliente"
},
"empleados": [
{
"id": 1650,
"rfc": "XXXXXXXX",
"nombre": "NOMBRE DEL EMPLEADO",
"apellido_paterno": "DEL",
"apellido_materno": "EMPLEADO"
}
],
"archivos": [
{
"id": 554877,
"url": "https://....",
"titulo": "Antes del servicio - 20260127_150310.jpg",
"creado": "2026-01-27T22:20:56.787815+00:00"
}
]
}
```
{% endtab %}
{% endtabs %}
## Editar una OT
`PATCH` `https://{clave}.admintotal.com/api/v2/ordenes_servicio/:id/`
#### Request Body
| Name | Tipo | Descripción |
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| status | Integer | Estados disponibles:
1 = "Abierta"
2 = "En proceso"
3 = "Terminada"
4 = "Cancelada"
5 = "Confirmada"
|
| prioridad | integer | Prioridad de la OT, opciones disponibles:
1 = "Alta"
2 = "Media"
3 = "Baja"
|
| descripción | string | Descripción de la visita |
| bitacora\_inicio\_cliente | string | Formato ISO 8601 ejemplo:
2026-01-01T09:44:27-06:00
|
| bitacora\_llegada\_base | string | Formato ISO 8601 ejemplo:
2026-01-01T09:44:27-06:00
|
{% tabs %}
{% tab title="200 " %}
```json
{
"id": 11448,
"status": 5,
"prioridad": null,
"bitacora_inicio_cliente": "2026-01-01T09:44:27-06:00",
"bitacora_llegada_base": "2026-01-27T09:44:27-06:00",
"descripcion": "FALTA DE AGUA
",
"status_display": "Confirmada",
"clave": "7136-1-1/1",
"periodicidad": "-----",
"prioridad_display": null,
"tipo_servicio": "TRABAJOS CORRECTIVOS",
"sucursal": {
"id": 228,
"municipio": "Carmen",
"nombre": "XXXX CD DEL CARMEN",
"cliente": "Nombre del cliente",
"direccion": "Dirección ..."
},
"cliente": {
"id": 1547,
"regimen_fiscal": "601",
"rfc": "XXXXX",
"razon_social": "Nombre del cliente",
"direccion": "Dirección ...",
"colonia": "Hipódromo Condesa",
"nombre": "Nombre del cliente",
"telefono": "(999) 181-4338",
"email": "",
"representante_legal": "Nombre del cliente"
},
"empleados": [
{
"id": 1650,
"rfc": "XXXXXXXX",
"nombre": "NOMBRE DEL EMPLEADO",
"apellido_paterno": "DEL",
"apellido_materno": "EMPLEADO"
}
],
"archivos": [
{
"id": 554877,
"url": "https://....",
"titulo": "Antes del servicio - 20260127_150310.jpg",
"creado": "2026-01-27T22:20:56.787815+00:00"
}
]
}
```
{% endtab %}
{% endtabs %}
## Adjuntar imagen a la Visita de una OT
`POST` `https://{clave}.admintotal.com/api/v2/ordenes_servicio/:id/adjuntar_imagen/`
#### Query Parameters
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ----------- |
| ID | integer | ID de la OT |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
| ------- | ------- | ------------------------------------------------------------------------------------------------------- |
| titulo | string | Título de la imagen |
| proceso | integer | ID del proceso:
1 = Antes del servicio
2 = Durante el servicio
3 = Después del servicio
|
| imagen | string | Formato: Base64 |
{% tabs %}
{% tab title="201" %}
```json
{
"id": 555417,
"url": "https://...",
"titulo": "Imágen antes del servicio",
"creado": "2026-01-28T17:53:36.346193+00:00"
}
```
{% endtab %}
{% endtabs %}
# Pedidos
## Obtener listado de pedidos
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/pedidos/`
#### Parámetros GET disponibles
| Name | Type | Description |
| ---------------------- | ------- | ---------------------------------------------------------------------------------------------------- |
| cliente | integer | Filtro por ID de cliente |
| cliente\_razon\_social | string | Filtro por razón social de cliente |
| fecha | string | Filtro por fecha (formato YYYY-MM-DD) |
| desde | string | Filtro por fecha donde sea mayor o igual a este valor (formato YYYY-MM-DD) |
| hasta | string | Filtro por fecha donde sea menor o igual a este valor (formato YYYY-MM-DD) |
| folio | integer | Filtro por folio |
| serie | string | Filtro por serie |
| cancelado | int | Filtro por movimiento cancelado:
0 = Mostrará solo activos
1 = Mostrará solo cancelados
|
{% tabs %}
{% tab title="200 " %}
```
{
"count": 33282,
"next": "https://cliente.admintotal.com/api/v2/movimientos/pedidos/",
"previous": null,
"results": [
{
"id": 755484,
"status": 1,
"almacen": 9,
"fecha": "2021-03-03",
"iva": "105.600000",
"subtotal": "660.00",
"total": "765.600000",
"comentarios": "",
"detalles": [
{
"id": 3536050,
"producto": 125072,
"cantidad": "3.0000",
"precio_unitario": "220.0000",
"importe": "660.000000",
"iva": "105.600000"
}
],
"creado": "2021-02-02T11:00:41.741114-07:00",
"status_display": "Pendientes",
"direccion_entrega": {
"id": 32980,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"folio": 25148,
"folio_completo": "025148",
"cliente": {
"id": 3628,
"activo": true,
"tipo_cliente": 1,
"razon_social": "221 Proyectos SA de CV",
"codigo": "",
"referencia": null,
"nombre_comercial": "",
"sitio_web": "",
"rfc": "DVP140305BI0",
"curp": "",
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 24827,
"municipio": "Hermosillo, Hermosillo",
"localidad": "",
"estado": "Estado de México",
"calle": "Blvd Antonio Quiroga",
"colonia": "Real de Quiroga",
"cp": "83224",
"telefono": "",
"email": "jahaziel@admintotal.com",
"numero_e": "142",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": null
},
"saldo_pendiente": "0",
"dias_credito": 0
},
"contacto": null
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Crear pedido
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/pedidos/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| contacto | object | Objeto con la información del contacto, ejemplo: {
"nombre": "Nombre del ",
"celular": "6623232323",
"telefono": "",
"email": "micorreo@midominio.com",
"puesto": "",
"extension": ""
}
|
| detalles | array | Lista de objetos con la información de los productos de la factura (para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor), ejemplo: [
{
"producto": 3131,
"cantidad": 1,
"um": {
"nombre": "Caja",
"factor": 12
},
"precio_unitario": "30.00"
}
]
|
| direccion_entrega | object | Objeto con la información de dirección de entrega, ejemplo: {
"nombre": "Ejemplo 1",
"direccion": {
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
}
}
|
| comentarios | string | Comentarios sobre el pedido |
| fecha | string | Fecha del pedido en formato YYYY-MM-DD |
| almacen | integer | ID del almacén (en caso de no especificar se tomará el primer almacén) |
| rfc_cliente | string | RFC del cliente (este parámetro es opcional si se especifica cliente) |
| id_cliente | integer | ID de cliente (este parámetro es opcional si se especifica rfc_cliente) |
| codigo_cliente | String | ID de cliente (este parámetro es opcional si se especifica rfc_cliente o id_cliente) |
{% tabs %}
{% tab title="201 " %}
```
{
"id": 755484,
"status": 1,
"almacen": 9,
"fecha": "2021-03-03",
"iva": "105.600000",
"subtotal": "660.00",
"total": "765.600000",
"comentarios": "",
"detalles": [
{
"id": 3536050,
"producto": 125072,
"cantidad": "3.0000",
"precio_unitario": "220.0000",
"importe": "660.000000",
"iva": "105.600000"
}
],
"creado": "2021-02-02T11:00:41.741114-07:00",
"status_display": "Pendientes",
"direccion_entrega": {
"id": 32980,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
},
"folio": 25148,
"folio_completo": "025148",
"cliente": {
"id": 3628,
"activo": true,
"tipo_cliente": 1,
"razon_social": "Empresa cliente",
"codigo": "",
"referencia": null,
"nombre_comercial": "",
"sitio_web": "",
"rfc": "HHH140305BI0",
"curp": "",
"limite_credito": "0.00",
"representante_legal": "",
"direccion": {
"id": 24827,
"municipio": "Hermosillo, Hermosillo",
"localidad": "",
"estado": "Estado de México",
"calle": "Blvd Antonio Quiroga",
"colonia": "Real de Quiroga",
"cp": "83224",
"telefono": "",
"email": "email@empresa.com",
"numero_e": "142",
"numero_i": "",
"pais_residencia": "",
"latitud": "0.00000000",
"longitud": "0.00000000",
"referencia": null
},
"saldo_pendiente": "0",
"dias_credito": 0
},
"contacto": null
}
```
{% endtab %}
{% endtabs %}
# Productos
## Obtener listado de productos
`GET` `https://{clave}.admintotal.com/api/v2/productos/`
#### Query Parameters
| Name | Type | Description |
| ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| excluir | string | Nombres de los campos separados por coma de los cuales no se desean en la respuesta |
| almacenes\_existencias | string | ID's de almacenes separados por coma de los cuales se sumará la existencia. |
| q | string | Filtrar resultados donde la descripción del producto contenga el valor especificado |
| subsublinea | integer | Filtrar resultados por ID de subsublinea |
| sublinea | integer | Filtrar resultados por ID de sublinea |
| linea | integer | Filtrar resultados por ID de linea |
| almacen | integer | ID del almacén que se usará para precio y existencia, en caso de no especificarse precio será tomado del precio de venta especificado en el catálogo de productos y se omitirá el campo existencia |
| precio\_max | number | Filtrar de resultados por precio máximo |
| precio\_min | number | Filtrar de resultados por precio mínimo |
| codigo | string | Filtrar resultados por código de producto |
| medio\_distribucion | integer | Filtrar resultados por medio de distribución, las opciones son:
1 - Tienda
2 - Web
3 - Ambos
|
| codigos | String | Múltiples códgos de productos separados por coma, por ejemplo: "?codigos=AB001, AB002" |
| codigo\_origen | String | Filtrar resultados por código de origen |
| clasificacion\_precios | integer | Tiene que ser un id de Clasificacion de cliente. |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 12841,
"next": "https://{clave}.admintotal.com/api/v2/productos/",
"previous": null,
"results": [
{
"id": 15111,
"codigo": "PRODUCTO DE EJEMPLO",
"medio_distribucion": 3,
"descripcion": "Lorem ipsum dolor...",
"descripcion_adicional": "",
"ce_fraccion_arancelaria": "",
"descripcion_ingles": "",
"descripcion_ecommerce": "",
"tipo": 0,
"tipo_producto_sistema_cardonal": null,
"composiciones": [],
"unidad_aduana": "",
"imagen_url": "",
"costo_ensamble": 0,
"costo": 0.0,
"precio": 160.0,
"unidad": {
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
},
"unidades": [
{
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
}
]
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un producto
`GET` `https://{clave}.admintotal.com/api/v2/productos/:id/`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | -------------- |
| ID | integer | ID de producto |
#### Query Parameters
| Name | Type | Description |
| ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| almacen | integer | ID del almacén que se usará para precio y existencia, en caso de no especificarse precio será tomado del precio de venta especificado en el catálogo de productos y se omitirá el campo existencia |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"id": 15111,
"codigo": "PRODUCTO DE EJEMPLO",
"medio_distribucion": 3,
"descripcion": "Lorem ipsum dolor...",
"descripcion_adicional": "",
"ce_fraccion_arancelaria": "",
"descripcion_ingles": "",
"descripcion_ecommerce": "",
"tipo": 0,
"tipo_producto_sistema_cardonal": null,
"composiciones": [],
"unidad_aduana": "",
"imagen_url": "",
"costo_ensamble": 0,
"costo": 0.0,
"precio": 160.0,
"unidad": {
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
},
"unidades": [
{
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
}
]
}
```
{% endtab %}
{% endtabs %}
## Editar ensambles de un producto
`POST` `https://{clave}.admintotal.com/api/v2/productos/:id/editar_ensambles/`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | -------------- |
| ID | integer | ID de producto |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
| ------------ | ------- | --------------------------- |
| um\_nombre | string | Nombre de unidad de medida |
| factor | number | Factor, valor por defecto 1 |
| cantidad | number | Cantidad del ensamble |
| um\_id | integer | ID de unidad de medida |
| producto\_id | number | ID de producto |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
## Habilitar webhook a múltiples productos
`POST` `https://{clave}.admintotal.com/api/v2/productos/habilitar_webhook/`
Endpoint para habilitar la funcionalidad de webhooks a múltiples productos. Normalmente se utiliza cuando se tienen configurados webhooks de notificaciones de cambios de precios y existencias.
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
| ------- | ----- | -------------------------------------------------------- |
| codigos | array | Lista de códigos a los que se desea habilitar el webhook |
{% tabs %}
{% tab title="200 " %}
```
{
"actualizados": [
"01",
"123456",
"31-750",
"26-675",
...
]
}
```
{% endtab %}
{% endtabs %}
# Productos por Almacén
## Obtener listado de productos por almacén
`GET``https://{clave}.admintotal.com/api/v2/productos_almacen/?almacen={id_almacen}`
| Name | Type | Description |
| ------- | ------- | -------------------------------------------------------------------------------------- |
| almacen | Integer | ID del almacén. De no ser proporcionado se mostraran todos los productos del catálogo. |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 12841,
"next": "https://{clave}.admintotal.com/api/v2/productos_almacen/?almacen={id_almacen}",
"previous": null,
"results": [
{
"id": 15111,
"activo": true,
"existencia": "287.00000000",
"codigo": "PRODUCTO DE EJEMPLO",
"medio_distribucion": 3,
"descripcion": "Lorem ipsum dolor...",
"descripcion_adicional": "",
"ce_fraccion_arancelaria": "",
"descripcion_ingles": "",
"descripcion_ecommerce": "",
"tipo": 7,
"info_almacenes": [
{
"almacen": {
"id": 91,
"nombre": "001 ALMACEN GENERAL"
},
"disponible": 0.0,
"promociones": [],
"precio_unitario": 0.0,
"costo_reposicion": 0.0,
"precio_neto": 0.0
}
],
"composiciones": [
{
"id": 13393,
"codigo": "COMPOSICION DE EJEMPLO",
"parte__descripcion": "Lorem ipsum dolor..."
}
],
"unidad_aduana": "",
"imagen_url": "",
"costo_ensamble": 0,
"costo": 0.0,
"precio": 0.0,
"unidad": {
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
},
"unidades": [
{
"id": 1531,
"factor": 1.0,
"nombre": "PIEZA"
}
]
},
...
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un producto almacén
`GET` `https://{clave}.admintotal.com/api/v2/productos_almacen/:id/`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | -------------- |
| ID | Integer | ID de producto |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"id": 4465,
"activo": true,
"existencia": "0.00000000",
"codigo": "PRODUCTO DE EJEMPLO",
"medio_distribucion": 3,
"descripcion": "Lorem ipsum dolor...",
"descripcion_adicional": "",
"ce_fraccion_arancelaria": "",
"descripcion_ingles": "",
"descripcion_ecommerce": "",
"tipo": 7,
"info_almacenes": [
{
"almacen": {
"id": 91,
"nombre": "001 ALMACÉN GENERAL"
},
"disponible": 0.0,
"promociones": [],
"precio_unitario": 0.0,
"costo_reposicion": 0.0,
"precio_neto": 0.0
}
],
"composiciones": [
{
"id": 13393,
"codigo": "COMPOSICION DE EJEMPLO",
"parte__descripcion": "Lorem ipsum dolor..."
}
],
"unidad_aduana": "",
"imagen_url": "",
"costo_ensamble": 0.0,
"costo": 0.0,
"precio": 0.0,
"unidad": {
"id": 13393,
"factor": "1.000000",
"seleccionado": true,
"seleccionado_compra": true,
"codigo_barras": null,
"base": "70.0000",
"altura": "35.0000",
"profundidad": "60.0000",
"peso": "200.0000",
"nombre": "PIEZA"
},
"unidades": [
{
"id": 1531,
"factor": 1.0,
"nombre": "PIEZA"
}
]
}
```
{% endtab %}
{% endtabs %}
# Prospectos
## Obtener un listado de Prospectos
`GET` `https://{clave}.admintotal.com/api/v2/prospectos/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 33,
"next": "https://{clave}.admintotal.com/api/v2/prospectos/",
"previous": null,
"results": [
{
"id": 2,
"codigo": "02",
"empresa": "Mexicana",
"nombre_comercial": null,
"sucursal": null,
"nombre": "rogelio amarillas",
"rfc": null,
"recomendo": "claudia robles",
"status": 1,
"comentarios": "visitar hoy",
"stats_display": "Negociación",
"cotizaciones": []
}
]
}
```
{% endtab %}
{% endtabs %}
## Crear Prospecto
`POST` `https://{clave}.admintotal.com/api/v2/prospectos/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
#### Request Body
| Name | Type | Description |
|---|
| codigo | char | Codigo de prospecto |
| nombre | char | Nombre completo del prospecto |
| empresa | char | Nombre completo del prospecto |
| nombre_comercial | char | Nombre cormercial del prospecto |
| sucursal | char | Nombre sucursal del prospecto |
| rfc (opcional) | char | RFC del prospecto |
| recomendo | char | Nombre de la persona que recomendo al prospecto |
| status | integer | Status del prospecto 0 - "Nuevo"
1 - "Negociación"
2 - "Ganado"
3 - "Desactivado"
4 - "Perdido"
|
| direccion | object | Objeto con la información de dirección, ejemplo: {
"nombre": "Ejemplo 1",
"direccion": {
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Articulo 123",
"colonia": "Misión del sol",
"cp": "83100",
"telefono": "",
"email": "",
"numero_e": "93A",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": null,
"longitud": null,
"referencia": ""
}
}
|
## Obtener un Prospecto
`GET` `https://{clave}.admintotal.com/api/v2/prospectos/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 33,
"next": "https://{clave}.admintotal.com/api/v2/prospectos/",
"previous": null,
"results": [
{
"id": 2,
"codigo": "02",
"empresa": "Mexicana",
"nombre_comercial": null,
"sucursal": null,
"nombre": "rogelio amarillas",
"rfc": null,
"recomendo": "claudia robles",
"status": 1,
"comentarios": "visitar hoy",
"stats_display": "Negociación",
"cotizaciones": []
}
]
}
```
{% endtab %}
{% endtabs %}
# Repartidores
## Obtener listado de Repartidores
`GET` `https://{clave}.admintotal.com/api/v2/repartidores/`
## Obtener un Repartidor
`GET` `https://{clave}.admintotal.com/api/v2/repartidores/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 11,
"next": "https://{clave}.admintotal.com/api/v2/repartidores/",
"previous": null,
"results": [
{
"id": 1583,
"usuario_creado": null,
"usuario_modificado": null,
"activo": true,
"modificado": "2021-09-21T11:36:47.700607-07:00",
"creado": "2019-12-12T13:34:25.995206-07:00",
"comentarios": "",
"metodo_pago": 0,
"metodo_de_pago": "01",
"apodo": "",
"empresa_rfc": "",
"empresa_rfc_variable": "",
"user": null,
"clave": "00011",
"tipo_nomina": "s",
"nombre": "Lopez Heredia",
"apellido_paterno": "Ernesto",
"apellido_materno": "Daniel",
"almacen": 1552,
"es_vendedor": true,
"es_repartidor": true,
"almacenes": [],
"tipo_cobro": false,
"comision_venta": "0.00",
"categoria": 1,
"puesto": "Emprendimiento",
"direccion": {
"id": 772,
"municipio": "Hermosillo",
"localidad": "Hermosillo",
"estado": "Sonora",
"calle": "Huepac",
"colonia": "Altaria Residencial",
"cp": "83107",
"telefono": "",
"email": "",
"numero_e": "5",
"numero_i": "",
"pais_residencia": "MEX",
"latitud": "29.15921700",
"longitud": "-110.98094500",
"referencia": null
},
"rfc": "LOHD831214Q63",
"celular": null,
"curp": "LOHD831214HSRPRN01",
"foto_empleado": null,
"ife": null,
"comprobante": null,
"nss": "24998348536",
"imss_umf": null,
"sucursal_banco": "SANTANDER",
"fecha_nacimiento": "2020-01-15",
"lugar_nacimiento_estado": "",
"lugar_nacimiento_ciudad": "",
"tiene_infonavit": true,
"tipo_infonavit": 6,
"infonavit_numero": "1236478965",
"infonavit_vsm": "0.00000",
"infonavit_porcentaje": "0.0000",
"infonavit_cuota_fija": "0.0000",
"esta_activo": false,
"salario": "196.88",
"ultima_entrada": "2020-01-01",
"fecha": "2019-12-12",
"nombre_completo": "Ernesto Daniel Lopez Heredia",
"cuenta_bancaria": "2056632556320",
"banco_nombre": "",
"cantidad_fija": "0.00",
"cantidad_variable": "0.00",
"clase": null,
"factor_integracion": "1.04520",
"num_empleado": "",
"tipo_regimen": 9,
"departamento_empleado": 1,
"clabe": "",
"fecha_iniciorel_laboral": "2020-01-01",
"tipo_contrato": "02 Contrato de trabajo para obra determinada",
"tipo_jornada": "01 Diurna",
"riesgo_puesto": 1,
"salario_diario_integrado": "203.352767",
"registro_patronal": 1,
"meta_ventas": "0.00",
"meta_utilidad": "0.00",
"sexo": 1,
"estado_civil": null,
"usa_aguinaldo": false,
"usa_ptu": false,
"ptu": 2,
"tipo_empleado": 1,
"base_pago_sueldo": 1,
"clave_mesero": null,
"numero_comanda_inicial": 1,
"numero_comanda_final": null,
"ac_no": null,
"checador_monto_hora": "0.0000",
"checador_monto_bono": "0.0000",
"es_asesor_servicios": false,
"es_tecnico_servicios": false,
"vehiculo_entrega": 1,
"usa_prima_dominical": false,
"dias": 6,
"es_externo": false,
"tercero": 2041,
"licencia_conducir": null,
"requiere_licencia_conducir": false,
"numero_licencia": "",
"tipo_licencia": null,
"fecha_expedicion_licencia": null,
"fecha_vencimiento_licencia": null,
"pasaporte": null,
"requiere_pasaporte": false,
"numero_pasaporte": "",
"fecha_expedicion_pasaporte": null,
"fecha_vencimiento_pasaporte": null,
"usar_salario_mixto": false,
"tipo_trabajador": 1,
"tipo_salario": 0,
"jornada_reducida": 0,
"tipo_gasto": null,
"outsourcing": false,
"fecha_termino_infonavit": null,
"fecha_inicio_infonavit": null
}
]
}
```
{% endtab %}
{% endtabs %}
# Sublíneas
## Obtener el listado de subsublíneas de productos
`GET` `https://{clave}.admintotal.com/api/v2/sublineas/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 201,
"next": "https://{clave}.admintotal.com/api/v2/sublineas/",
"previous": null,
"results": [
{
"id": 1736,
"linea": 1638,
"nombre": "LÁCTEOS"
},
...
]
}
```
{% endtab %}
{% endtabs %}
# Subsublíneas
## Obtener listado de subsublíneas
`GET` `https://{clave}.admintotal.com/api/v2/subsublineas/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 201,
"next": "https://{clave}.admintotal.com/api/v2/subsublineas/",
"previous": null,
"results": [
{
"id": 1836,
"sublinea": 1736,
"nombre": "QUESOS"
},
...
]
}
```
{% endtab %}
{% endtabs %}
# Toma de Inventario
Recursos de integración para desarrolladores
Obtener listado de Tomas de Inventario
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/toma_inventario/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
{
"count": 1106,
"next": "https://{clave}.admintotal.com/api/v2/movimientos/toma_inventario/",
"previous": null,
"results": [
{
"id": 573455,
"status": 1,
"almacen": 9,
"fecha": "2026-03-04",
"fecha_vencimiento": "2026-03-04",
"iva": "0.00",
"subtotal": "0.00",
"total": "0.00",
"uso_cfdi": null,
"comentarios": "Toma de inventario",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [],
"creado": "2026-03-04T11:17:15.757397-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"centro_costo": 22,
"tipo_cuenta": 0,
"cuenta": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 292,
"folio_completo": "292",
"vendedor": "",
"url_pdf": "",
"proveedor": []
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener una sola Toma de Inventario
`GET` `https://{clave}.admintotal.com/api/v2/movimientos/toma_inventario/:id`
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | --------------------------- |
| ID | integer | ID de la Toma de Inventario |
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200" %}
```
{
"id": 573455,
"status": 1,
"almacen": 9,
"fecha": "2026-03-04",
"fecha_vencimiento": "2026-03-04",
"iva": "0.00",
"subtotal": "0.00",
"total": "0.00",
"uso_cfdi": null,
"comentarios": "Toma de inventario",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [
{
"id": 1831246,
"producto": {
"id": 37496,
"codigo": "PRODUCTO DE EJEMPLO",
"descripcion": "Lorem ipsum dolor..."
},
"cantidad": 4.0,
"descripcion_adicional": "",
"unidad": {
"id": 1531,
"nombre": "PIEZA",
"factor": "1.00000000"
},
"precio_um": "0.0",
"precio_unitario": "0.0",
"importe": "0.0",
"total": "0.0",
"iva": "0.0",
"ieps": "0.0"
}
],
"creado": "2026-03-04T11:17:15.757397-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"centro_costo": 22,
"tipo_cuenta": 0,
"cuenta": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 292,
"folio_completo": "292",
"vendedor": "",
"url_pdf": "",
"campos_personalizados": [],
"movimiento_origen": null,
"movimientos_relacionados": [],
"proveedor": {
"activo": false,
"tipo_cliente": null,
"razon_social": "",
"codigo": "",
"referencia": "",
"nombre_comercial": "",
"sitio_web": "",
"rfc": "",
"curp": "",
"limite_credito": null,
"representante_legal": "",
"direccion": {
"municipio": "",
"localidad": "",
"estado": "",
"calle": "",
"colonia": "",
"cp": "",
"telefono": "",
"email": "",
"numero_e": "",
"numero_i": "",
"pais_residencia": "",
"latitud": null,
"longitud": null,
"referencia": ""
},
"bloquear_vencido": false,
"dias_cortar_credito": null,
"dias_credito": null,
"regimen_fiscal": null
}
}
```
{% endtab %}
{% endtabs %}
## Crear una Toma de Inventario
`POST` `https://{clave}.admintotal.com/api/v2/movimientos/toma_inventario/`
#### Headers
| Name | Type | Description |
|---|
| Api-key | String | Token de autenticación |
| Name | Type | Description |
|---|
| almacén | Integer | ID del almacén |
| detalles | Array | Lista de objetos con la información de los productos de la toma de inventario (para especificar el producto puede ser por producto, producto_codigo o producto_codigo_proveedor), ejemplo: [
{
"cantidad": "1.00",
"producto_codigo": "PRODUCTO DE EJEMPLO",
"descripcion": "Liquidar orden de compra"
"precio_unitario": "100.00",
"um": {
"factor": 1,
"nombre": "Pieza"
}
}
]
|
{% tabs %}
{% tab title="200" %}
```
{
"id": 573457,
"status": 1,
"almacen": 9,
"fecha": "2026-03-05",
"fecha_vencimiento": "2026-03-05",
"iva": "0.00",
"subtotal": "0.00",
"total": "0.00",
"uso_cfdi": null,
"comentarios": "Toma de inventario",
"mostrar_comentarios": false,
"forma_pago": null,
"detalles": [],
"creado": "2026-03-05T15:09:06.998753-07:00",
"xml_timbrado": "",
"cfdi_uuid": "",
"cfdi_status": "",
"cancelado": false,
"motivo_cancelacion": "",
"usuario_cancelacion": null,
"fecha_cancelacion": null,
"fecha_entrega": null,
"hora_entrega_a": null,
"hora_entrega_b": null,
"centro_costo": 22,
"tipo_cuenta": 0,
"cuenta": null,
"status_display": "Pendientes",
"direccion_entrega": null,
"folio": 293,
"folio_completo": "293",
"vendedor": "",
"url_pdf": "",
"proveedor": []
}
```
{% endtab %}
{% endtabs %}
# Usuarios
## Obtener listado de usuarios
`GET` `https://{clave}.admintotal.com/api/v2/usuarios/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |
{% tabs %}
{% tab title="200 " %}
```
{
"count": 125,
"next": "https://{clave}.admintotal.com/api/v2/usuarios/",
"previous": null,
"results": [
{
"id": 23,
"username": "usuario1",
"email": "email@host.com",
"is_superuser": false,
"is_staff": false,
"perfil": {
"usuario_id": 23,
"seleccionar_almacen_iniciar_sesion": false,
"timezone": null,
"es_repartidor": false,
"menu_app": []
},
"roles": [
{
"id": 4,
"nombre": "Bancos"
},
{
"id": 6,
"nombre": "Compras"
},
{
"id": 7,
"nombre": "Contabilidad"
},
{
"id": 10,
"nombre": "Cuentas por pagar"
},
{
"id": 9,
"nombre": "cuentas por cobrar"
},
{
"id": 13,
"nombre": "Nómina"
},
{
"id": 5,
"nombre": "Caja"
},
{
"id": 19,
"nombre": "Gerente Administrativo"
},
{
"id": 2,
"nombre": "Almacenista"
},
{
"id": 12,
"nombre": "Inventario"
}
]
},
...
]
}
```
{% endtab %}
{% endtabs %}
# Vehículos Entrega
## Obtener listado de Vehículos de Entrega
`GET` `https://{clave}.admintotal.com/api/v2/vehiculos_entrega/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 9,
"next": "https://{clave}.admintotal.com/api/v2/vehiculos_entrega/",
"previous": null,
"results": [
{
"id": 2,
"activo": true,
"asegurado": false,
"matricula": "vwx-121",
"carga_maxima_kg": 10,
"comentarios": "Motocicleta Honda 250 modelo 2018",
"creado": "2019-10-10T13:08:54.025703-07:00",
"modificado": "2020-06-13T11:53:38.062226-07:00",
"alias": null,
"numero_serie": "46565465",
"kilometraje": 66666
}
]
}
```
{% endtab %}
{% endtabs %}
## Obtener un Vehículo de Entrega
`GET` `https://{clave}.admintotal.com/api/v2/vehiculos_entrega/:id/`
#### Headers
| Name | Type | Description |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"count": 9,
"next": "https://{clave}.admintotal.com/api/v2/vehiculos_entrega/",
"previous": null,
"results": [
{
"id": 2,
"activo": true,
"asegurado": false,
"matricula": "vwx-121",
"carga_maxima_kg": 10,
"comentarios": "Motocicleta Honda 250 modelo 2018",
"creado": "2019-10-10T13:08:54.025703-07:00",
"modificado": "2020-06-13T11:53:38.062226-07:00",
"alias": null,
"numero_serie": "46565465",
"kilometraje": 66666
}
]
}
```
{% endtab %}
{% endtabs %}