Clientes

Da de alta las cuentas de facturación de tus clientes con sus datos fiscales del SAT, actualízalas, suspéndelas y reactívalas.

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

GEThttps://invoice.taxo.ws/mx/partners/v1/clients

Ver en la referencia

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
curl https://invoice.taxo.ws/mx/partners/v1/clients \
-H "Authorization: Bearer <token>" \
-H "F-Sandbox-Mode: true"

Crear un cliente

POSThttps://invoice.taxo.ws/mx/partners/v1/clients

Ver en la referencia

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
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

CampoTipoRequeridoDescripción
nametextoSíNombre del cliente.
emailtextoSíCorreo electrónico del cliente.

Datos fiscales: tax_information

CampoTipoRequeridoDescripción
tax_idtextoSíRFC del cliente.
legal_nametextoSíNombre o razón social, tal como aparece en su constancia de situación fiscal.
postal_codetextoSíCódigo postal de su domicilio fiscal.
invoice_use_keytextoSíClave de uso del CFDI del catálogo del SAT, por ejemplo G01.
tax_regimetextoSíClave de régimen fiscal del catálogo del SAT, por ejemplo 601.

Plan: product

CampoTipoRequeridoDescripción
uuidtextoSíuuid del plan.
vigency_uuidtextoSíuuid de la vigencia del plan, dentro de vigencies.

Actualizar un cliente

PATCHhttps://invoice.taxo.ws/mx/partners/v1/clients/{uuid}

Ver en la referencia

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
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:

CampoTipoDescripción
countrytextoPaís.
statetextoEstado.
citytextoCiudad.
neighborhoodtextoColonia.
addresstextoCalle y número.
additional_emailtextoCorreo electrónico adicional del cliente.

Suspender clientes

POSThttps://invoice.taxo.ws/mx/partners/v1/clients/suspend

Ver en la referencia

Suspende uno o varios clientes a la vez. Responde 404 si alguno no existe.

CampoTipoRequeridoDescripción
uuidsarregloSíuuid de los clientes a suspender.
messagetextoNoMensaje que recibirá el cliente.
keep_foliosbooleanoNoSi los folios disponibles deben conservarse.
cURL
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

POSThttps://invoice.taxo.ws/mx/partners/v1/clients/reactivate

Ver en la referencia

Reactiva uno o varios clientes suspendidos. Envía sus identificadores en uuids. Responde 404 si alguno no existe.

cURL
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

POSThttps://invoice.taxo.ws/mx/partners/v1/clients/{uuid}/resend-credentials

Ver en la referencia

Reenvía por correo los accesos de la cuenta del cliente. No lleva cuerpo. Responde 404 si el cliente no existe.

cURL
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"