Saltar al contenido
API v1 · https://bentho.org/api
POST/api/mod/contabilidad/{espacio}/push/customer

Encola 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

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Contabilidad.

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
referencia_internastringSÍTu id del cliente. Impide darlo de alta dos veces. No la dejes vacía.
clienteobjectSÍSus datos: ver cliente.

RESPUESTA 202

La entrada en la cola. Guarda su outbox_id.

CAMPOTIPOQUÉ ES
outbox_idstringEl id de la entrada.
estadostringpending si es nueva; si ya existía, el suyo de ahora.
idempotent_replaybooleantrue si esa referencia_interna ya estaba encolada: no se creó otra.

CLIENTE

CAMPOTIPOQUÉ ES
tipo_id"NIT" | "CC" | "CE" | "PASAPORTE"El tipo de documento. Por defecto CC.
identificacionstringEl número.
nombrestringNombre o razón social.
email · telefonostringOpcionales.
rawobjectCampos 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": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Contabilidadmódulo no habilitado para este espacio.
403La clave es de solo lecturaTu cuenta es de solo lectura en este espacio.
502El módulo no está disponible en este momento: reintenta en unos minutos—
422Falta 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_interna no duplica nada: devuelve la entrada que ya existía, con idempotent_replay: true y su estado de ahora.