Ir al contenido
POST
/cloud/plataforma/clientes
curl --request POST \
--url https://app.openfactura.co/cloud/plataforma/clientes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "nombre": "Casa Barista", "externalId": "cliente-482", "datos": { "nit": "0614-290786-102-3", "nrc": "123456-7", "razonSocial": "example", "nombreComercial": "example", "correo": "[email protected]", "telefono": "example" } }'

Crea un cliente pendiente con su propio espacio (organización aislada). Lo que ya sabes de él (datos) llega prellenado a su alta.

Media typeapplication/json
object
nombre
required
string
>= 2 characters <= 120 characters

Example

Casa Barista
externalId

Tu propio id del cliente; único en tu cuenta.

string | null
<= 120 characters

Example

cliente-482
datos

Lo que ya sabes del cliente; prellena su alta.

object
nit
string

Example

0614-290786-102-3
nrc
string

Example

123456-7
razonSocial
string
nombreComercial
string
correo
string format: email
telefono
string

Cliente creado.

Media typeapplication/json
object
id
string
nombre
string
externalId
string | null
estado
string
Allowed values: pendiente activo desactivado
datos

Lo que ya sabes del cliente; prellena su alta.

object
nit
string
nrc
string
razonSocial
string
nombreComercial
string
correo
string format: email
telefono
string
organizationId

Su espacio (existe desde que lo creas).

string | null
preparacion
string | null
Allowed values: conectado pruebas produccion
falta
string | null
enlaceExpira
integer | null
aceptado
integer | null
creado
integer

Example

{
"estado": "pendiente",
"datos": {
"nit": "0614-290786-102-3",
"nrc": "123456-7"
},
"preparacion": "conectado",
"falta": "Sus credenciales de producción"
}

Datos inválidos

Media typeapplication/json
object
error
object
code
string
message
string
details

Example

{
"error": {
"code": "plan_requerido"
}
}

Tu plan no lo incluye (plan_requerido)

Media typeapplication/json
object
error
object
code
string
message
string
details

Example

{
"error": {
"code": "plan_requerido"
}
}

Sin permiso o clave no habilitada para Plataforma (clave_sin_plataforma)

Media typeapplication/json
object
error
object
code
string
message
string
details

Example

{
"error": {
"code": "plan_requerido"
}
}

Conflicto (p. ej. cliente_no_pendiente, external_id_repetido)

Media typeapplication/json
object
error
object
code
string
message
string
details

Example

{
"error": {
"code": "plan_requerido"
}
}

Límite de empresas del plan (limite_plan)

Media typeapplication/json
object
error
object
code
string
message
string
details

Example

{
"error": {
"code": "plan_requerido"
}
}

Para asistentes de IA: llms.txt ·llms-full.txt ·cada página en Markdown añadiendo .md a su ruta.