POST
/api/mod/contabilidad/{espacio}/push/customerEncola un cliente
Deja un cliente en la cola para darlo de alta como tercero en tu software contable.
- PERMISOescribe
- CRÉDITOSno gasta
- AUTENTICACIÓNBearer bth_…
PARÁMETROS
| CAMPO | TIPO | REQUERIDO | QUÉ ES |
|---|---|---|---|
| espacio | string | SÍ | El id del espacio (sale en GET /api/companies). Tiene que tener el módulo Contabilidad. |
CUERPO · JSON
| CAMPO | TIPO | REQUERIDO | QUÉ ES |
|---|---|---|---|
| referencia_interna | string | SÍ | Tu id del cliente. Impide darlo de alta dos veces. No la dejes vacía. |
| cliente | object | SÍ | Sus datos: ver cliente. |
RESPUESTA 202
La entrada en la cola. Guarda su outbox_id.
| CAMPO | TIPO | QUÉ ES |
|---|---|---|
| outbox_id | string | El id de la entrada. |
| estado | string | pending si es nueva; si ya existía, el suyo de ahora. |
| idempotent_replay | boolean | true si esa referencia_interna ya estaba encolada: no se creó otra. |
CLIENTE
| CAMPO | TIPO | QUÉ ES |
|---|---|---|
| tipo_id | "NIT" | "CC" | "CE" | "PASAPORTE" | El tipo de documento. Por defecto CC. |
| identificacion | string | El número. |
| nombre | string | Nombre o razón social. |
| email · telefono | string | Opcionales. |
| raw | object | Campos extra, con los nombres de tu software, que se mandan tal cual al crear el cliente. Al facturar no se usan. |
ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}
| STATUS | CUÁNDO | DETAIL LITERAL |
|---|---|---|
| 403 | El espacio no tiene el módulo Contabilidad | módulo no habilitado para este espacio. |
| 403 | La clave es de solo lectura | Tu cuenta es de solo lectura en este espacio. |
| 502 | El módulo no está disponible en este momento: reintenta en unos minutos | — |
| 422 | Falta un campo obligatorio o uno no tiene su tipo (detail es una lista) | — |
Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.
CONVIENE SABER
- Encolar no manda nada todavía: el envío ocurre al procesar la cola. Síguelo con GET push/{entrada}.
- Encolar dos veces la misma
referencia_internano duplica nada: devuelve la entrada que ya existía, conidempotent_replay: truey su estado de ahora.