Facturapi (2.0)
Download OpenAPI specification:Download
En esta página enlistamos todos los métodos disponibles en la API de Facturapi, así como la referencia completa de los parámetros que acepta cada uno. Para ver las propiedades anidadas de un objeto o arreglo de objetos, puedes hacer clic sobre el nombre del campo y expandirlo.
La API de Facturapi está diseñada con el estándar REST en mente. Los endpoints de la API están agrupados por recursos, tienen URLs predecibles, las respuestas tienen formato JSON y usamos códigos HTTP de respuesta, autenticación y verbos estándar.
Durante el desarrollo, puedes usar la API de Facturapi en ambiente Test y las facturas que emitas no se enviarán al SAT ni tendrán validez fiscal.
La llave secreta que utilices para autenticarte determinará tanto el ambiente en el que se creará la factura (Test o Live), así como la organización a utilizar como emisor de tu factura, o bien como dueña del recurso que solicites crear.
Crear cliente
Registra un nuevo cliente en Facturapi.
Esta llamada valida que los datos fiscales coincidan con los registros del SAT para ese RFC, de lo contrario, la llamada devolverá un error indicando el problema.
Una vez creado el cliente y obtenido un objeto de respuesta, te recomendamos guardar el ID en tu base de datos junto a la información de tu cliente. Posteriormente, puedes llamar al encpoint de Crear Factura pasando el ID del cliente en lugar de repetir la información.
Por último, ten en cuenta que los clientes que crees en ambiente Test no se comparten con el ambiente Live.
Authorizations:
Request Body schema: application/jsonrequired
legal_name required | string Nombre Fiscal o Razón Social del cliente. sin el régimen societario (ej.: S.A. de C.V.). |
tax_id required | string En clientes de México contiene el RFC del cliente. Para extranjeros es opcional y representa el número de registro de identificacón tributaria, es decir, el equivalente al RFC en el país del cliente. |
tax_system required | string = 3 characters Requerido para clientes nacionales. Clave del régimen fiscal del cliente, del catálogo de Regímenes Fiscales. |
required | object Domicilio fiscal. |
string <email> Dirección de correo electrónico al cual enviar las facturas generadas. | |
phone | string Teléfono del cliente. |
Responses
Request samples
- Payload
- cURL
- Node.js
- C#
- PHP
{- "legal_name": "Dunder Mifflin",
- "tax_id": "ABC101010111",
- "tax_system": "601",
- "email": "email@example.com",
- "phone": 6474010101,
- "address": {
- "street": "Blvd. Atardecer",
- "exterior": 142,
- "interior": 4,
- "neighborhood": "Centro",
- "city": "Huatabampo",
- "municipality": "Huatabampo",
- "zip": 86500,
- "state": "Sonora",
- "country": "MEX"
}
}
Response samples
- 200
- 201
- 400
- 401
- 404
- 500
{- "id": "590ce6c56d04f840aa8438af",
- "created_at": "2017-05-05T20:55:33.468Z",
- "livemode": false,
- "legal_name": "Dunder Mifflin",
- "tax_id": "ABC101010111",
- "tax_system": "601",
- "email": "email@example.com",
- "phone": 6474010101,
- "address": {
- "street": "Blvd. Atardecer",
- "exterior": 142,
- "interior": 4,
- "neighborhood": "Centro",
- "city": "Huatabampo",
- "municipality": "Huatabampo",
- "zip": 86500,
- "state": "Sonora",
- "country": "MEX"
}
}
Listar clientes
Regresa una lista paginada de todos los clientes de una organización o realiza una búsqueda de acuerdo a parámetros
Authorizations:
query Parameters
q | string Consulta. Texto a buscar en |
object (DateRange) Objeto con rango de fechas solicitado. | |
page | integer >= 1 |