Clientes
Un cliente es una cuenta de facturación con sus datos fiscales: RFC, razón social, régimen fiscal y uso de CFDI. Al darlo de alta le asignas un plan y una de sus vigencias.
Todas las peticiones de esta página llevan Authorization: Bearer <token> (ver
Autenticación). Agrega F-Sandbox-Mode: true para
trabajar en sandbox.
Consultar clientes
Devuelve el listado de tus clientes. De aquí sale el uuid de cada cliente, que
usan el resto de operaciones de esta página.
curl https://invoice.taxo.ws/mx/partners/v1/clients \
-H "Authorization: Bearer <token>" \
-H "F-Sandbox-Mode: true"
Crear un cliente
Registra la cuenta del cliente y le asigna un plan. Antes necesitas el uuid del
plan y el uuid de la vigencia que vas a asignar: los obtienes al
consultar tus planes.
curl https://invoice.taxo.ws/mx/partners/v1/clients \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-H "F-Sandbox-Mode: true" \
-d '{
"client": {
"name": "MARTIN LOPEZ",
"email": "[email protected]"
},
"tax_information": {
"tax_id": "FUNK671228PH1",
"legal_name": "MARTIN LOPEZ",
"postal_code": "06600",
"invoice_use_key": "G01",
"tax_regime": "601"
},
"product": {
"uuid": "<uuid-del-plan>",
"vigency_uuid": "<uuid-de-la-vigencia>"
}
}'
Responde 200 si el cliente se registra, o 422 con el detalle en errors si algún
dato no es válido.
Datos del cliente: client
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | texto | Sí | Nombre del cliente. |
email | texto | Sí | Correo electrónico del cliente. |
Datos fiscales: tax_information
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
tax_id | texto | Sí | RFC del cliente. |
legal_name | texto | Sí | Nombre o razón social, tal como aparece en su constancia de situación fiscal. |
postal_code | texto | Sí | Código postal de su domicilio fiscal. |
invoice_use_key | texto | Sí | Clave de uso del CFDI del catálogo del SAT, por ejemplo G01. |
tax_regime | texto | Sí | Clave de régimen fiscal del catálogo del SAT, por ejemplo 601. |
Plan: product
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
uuid | texto | Sí | uuid del plan. |
vigency_uuid | texto | Sí | uuid de la vigencia del plan, dentro de vigencies. |
Actualizar un cliente
Modifica los datos generales y fiscales del cliente. Ningún campo es obligatorio:
envía solo los que cambian. Responde 404 si el cliente no existe.
curl -X PATCH https://invoice.taxo.ws/mx/partners/v1/clients/<uuid-del-cliente> \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-H "F-Sandbox-Mode: true" \
-d '{
"tax_information": {
"postal_code": "44100",
"state": "Jalisco",
"city": "Guadalajara"
}
}'
Además de los campos de client y tax_information del alta, tax_information
acepta los datos de domicilio y un correo adicional:
| Campo | Tipo | Descripción |
|---|---|---|
country | texto | País. |
state | texto | Estado. |
city | texto | Ciudad. |
neighborhood | texto | Colonia. |
address | texto | Calle y número. |
additional_email | texto | Correo electrónico adicional del cliente. |
Suspender clientes
Suspende uno o varios clientes a la vez. Responde 404 si alguno no existe.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
uuids | arreglo | Sí | uuid de los clientes a suspender. |
message | texto | No | Mensaje que recibirá el cliente. |
keep_folios | booleano | No | Si los folios disponibles deben conservarse. |
curl https://invoice.taxo.ws/mx/partners/v1/clients/suspend \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-H "F-Sandbox-Mode: true" \
-d '{
"uuids": ["<uuid-del-cliente>"],
"message": "Tu cuenta fue suspendida por falta de pago.",
"keep_folios": true
}'
Reactivar clientes
Reactiva uno o varios clientes suspendidos. Envía sus identificadores en uuids.
Responde 404 si alguno no existe.
curl https://invoice.taxo.ws/mx/partners/v1/clients/reactivate \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-H "F-Sandbox-Mode: true" \
-d '{ "uuids": ["<uuid-del-cliente>"] }'
Reenviar accesos
Reenvía por correo los accesos de la cuenta del cliente. No lleva cuerpo. Responde
404 si el cliente no existe.
curl -X POST https://invoice.taxo.ws/mx/partners/v1/clients/<uuid-del-cliente>/resend-credentials \
-H "Authorization: Bearer <token>" \
-H "F-Sandbox-Mode: true"