Ir al contenido

Crear cliente

POST
/clients
curl --request POST \
--url https://api.dev.lade.com.mx/clients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "teamId": "550e8400-e29b-41d4-a716-446655440000", "name": "Empresa ABC", "rfc": "XAXX010101000", "email": "contacto@empresaabc.com", "phone": "+5212345678901", "cfdiUse": "G03", "taxRegime": "601" }'

Crea un nuevo cliente para el equipo

Media typeapplication/json
object
teamId
required
string format: uuid
name
required
string
>= 1 characters <= 100 characters
nameRelated
string
<= 100 characters
description
string
<= 1000 characters
rfc
string
<= 13 characters
email
string format: email
phone
string
<= 20 characters
cfdiUse
string
default: G03 <= 10 characters
taxRegime
string
default: 601 <= 10 characters
zipCode
string
<= 10 characters
address
object
street
string
<= 300 characters
extNumber
string
<= 50 characters
intNumber
string
<= 50 characters
neighborhood
string
<= 100 characters
city
string
<= 100 characters
state
string
<= 100 characters
country
string
default: Mexico <= 100 characters
zipCode
string
<= 10 characters
creditLimit
integer
0 <= 999999999
paymentTerms
integer
0 <= 365
notes
string
<= 1000 characters
Example
{
"teamId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Empresa ABC",
"rfc": "XAXX010101000",
"email": "contacto@empresaabc.com",
"phone": "+5212345678901",
"cfdiUse": "G03",
"taxRegime": "601"
}

Cliente creado

Media typeapplication/json
object
id
string format: uuid
teamId
string format: uuid
name
string
nameRelated
string
nullable
description
string
nullable
rfc
string
nullable <= 13 characters
email
string format: email
nullable
phone
string
nullable
cfdiUse
string
default: G03
taxRegime
string
default: 601
zipCode
string
nullable
status
string
Allowed values: ACTIVE INACTIVE SUSPENDED
address
object
street
string
<= 300 characters
extNumber
string
<= 50 characters
intNumber
string
<= 50 characters
neighborhood
string
<= 100 characters
city
string
<= 100 characters
state
string
<= 100 characters
country
string
default: Mexico <= 100 characters
zipCode
string
<= 10 characters
creditLimit
integer
paymentTerms
integer
<= 365
notes
string
nullable
createdAt
string format: date-time
Example
{
"cfdiUse": "G03",
"taxRegime": "601",
"status": "ACTIVE",
"address": {
"country": "Mexico"
}
}

Solicitud inválida

Media typeapplication/json
object
error
required
string
message
string
field
string
Example
{
"error": "Validation failed",
"field": "email",
"message": "Invalid email format"
}

No autenticado

Media typeapplication/json
object
error
required
string
message
string
field
string
Example
{
"error": "Unauthorized",
"message": "Invalid or expired token"
}

Sin permisos

Media typeapplication/json
object
error
required
string
message
string
field
string
Example
{
"error": "Forbidden",
"message": "You don't have permission to access this resource"
}