getCustomer()
Obtiene los datos guardados de un cliente de la cuenta.
Permiso: customer:read
getCustomer( id: string, options?: RequestOptions): Promise<CustomerRecord>Referencia HTTP: GET /customers/{id}
- Un recurso inexistente o ajeno a la cuenta devuelve un error HTTP 404.
Parámetros
Sección titulada «Parámetros»| Argumento | Tipo | Obligatorio | Uso |
|---|---|---|---|
id | string | Sí | ID de FactuCat del cliente, en formato UUID. |
options | RequestOptions | No | signal e idempotencyKey; consulta las opciones por solicitud. |
Opciones por solicitud: signal e idempotencyKey.
Ejemplo
Sección titulada «Ejemplo»Usa el cliente factucat de Instala y conecta. Los IDs y datos fiscales de este ejemplo son ilustrativos: reemplázalos por los registros de tu cuenta y ambiente.
const resultado = await factucat.getCustomer( "10112233-4455-4677-8899-aabbccddeeff",)console.log(resultado)Respuesta
Sección titulada «Respuesta»Resuelve una Promise<CustomerRecord>. El valor recibido es directamente data, sin el envoltorio HTTP ni sus metadatos.
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
id | string | Sí | ID de FactuCat del recurso. No es el UUID fiscal.Formato: uuid |
userId | string | Sí | ID de la cuenta propietaria del recurso.Mínimo 1 carácter |
legalName | string | Sí | Nombre o razón social del receptor. |
rfc | string | Sí | RFC del receptor. |
postalCode | string | Sí | Código postal fiscal, como cadena de cinco dígitos. |
taxRegime | string | Sí | Clave del régimen fiscal del receptor. |
preferredCfdiUse | string | null | No | Uso de CFDI preferido del cliente (clave SAT, por ejemplo G03). Opcional. |
fiscalResidence | string | No | Clave del país de residencia fiscal, cuando aplica. |
taxId | string | No | Identificación tributaria extranjera, cuando aplica. |
email | string | No | Correo del cliente.Formato: email |
whatsappPhone | string | No | Teléfono de WhatsApp del cliente. |
sendInvoices | boolean | Sí | Preferencia de entrega de comprobantes al cliente; las opciones del timbrado también controlan los envíos. |
invoiceLanguage | "es" | "en" | Sí | Idioma preferido del cliente para la factura. |
currency | "MXN" | "USD" | "EUR" | Sí | Moneda del cliente o del comprobante. |
createdAt | string | Sí | Fecha y hora de creación en formato ISO 8601; se devuelve como string.Formato: date-time |
updatedAt | string | Sí | Fecha y hora de última actualización en formato ISO 8601.Formato: date-time |
Ejemplo de respuesta
{ "id": "10112233-4455-4677-8899-aabbccddeeff", "userId": "usuario_ejemplo", "legalName": "EMPRESA DE EJEMPLO", "rfc": "AAA010101AAA", "postalCode": "06000", "taxRegime": "601", "sendInvoices": false, "invoiceLanguage": "es", "currency": "MXN", "createdAt": "2026-09-08T12:00:00Z", "updatedAt": "2026-09-08T12:00:00Z"}Las fechas se entregan como cadenas ISO 8601. Un campo opcional puede estar ausente. Tipos, paginación y archivos.
La promesa se rechaza si la API devuelve un error, falla la conexión o los datos no cumplen el contrato. Cómo manejar los errores.