{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f9e8ed57-efb9-4b0d-b2ba-6ab202de2756","name":"Facture App API","description":"Webservice para consumo de la plataforma Facture App, última versión 17 11 2023.\n\n# Descripción\n\n

La presente documentación puede ser usada como referencia para consumir el Webservice de tipo RESTFul expuesto por Facture App y cuya finalidad es el uso de la plataforma a través de una API.

\n\n

El objetivo de este servicio es brindar la posibilidad a usuarios registrados de crear aplicaciones cliente, para que otros usuarios a la vez puedan hacer uso de su cuenta a través estas aplicaciones mediante la API. En el presente manual de integración encontrará la información necesaria para poder:

\n\n\n\n

Aplicación cliente: Un usuario registrado en Facture App puede crear una o varias aplicaciones cliente, al hacerlo obtendrá un client_id y un client_secret que le permitirán a otros usuarios vincularse a la misma.

\n\n

Permiso aplicación: Un usuario registrado en Facture App puede vincularse a una aplicación cliente, una vez que haya intercambiado sus credenciales de acceso y concedido los permisos necesarios obtendrá un access token y un refresh token mismos que pueden ser usados para consumir la API.

\n\n

Para crear un aplicación cliente siga los siguientes pasos:

\n\n
  1. Ingrese a la aplicación Aquí.
  2. Vaya al menú de la izquierda y diríjase al apartado Administración.
  3. De clic en la parte inferior del botón configuración.
  4. De clic en el menú Aplicaciones.
  5. Cree una nueva aplicación.
\n\n

Para gestionar los permisos a aplicaciones siga los siguientes pasos:

\n\n
  1. Ingrese a la aplicación Aquí.
  2. Vaya al menú de la izquierda y diríjase al apartado Administración.
  3. De clic en la parte inferior del botón configuración.
  4. De clic en el menú Permisos aplicaciones.
  5. Gestione los permisos concedidos.
\n\n

Recuerda que puedes apoyarte con nosotros en el siguiente correo Desarrollo.

\n\n# Autenticación\n\n

La autenticacion está dada según las especificaciones de OAuth2, el desarrollador deberá crear una aplicación cliente para obtener un cliente id y un client secret.

\n\n

En todas las peticiones deberá envíar el Header Authorization con el access token obtenido mediante:

\n\n\n\nEjemplo de header:\n\n```\nauthorization: Bearer 1cc64f77f98da67960b178d0c2776872\n\n ```\n\n

Es importante mencionar que un usuario puede generar hasta 3 token de acceso por aplicación, después de este número la API no podrá generar nuevos, el usuario que se desea vincular a la aplicación cliente será el responsable de ir a Permiso aplicación y borrar algún token de acceso no usado para poder generar uno nuevo.

\n\n# Límite de uso\n\n

Por favor tome en cuenta que los usuarios que consuman en Webservice deberán apegarse a los limites propios del timbrado y cancelación versus los créditos comprados desde la plataforma.

\n\n


Para aquellos puntos de enlace fuera del timbrado y cancelación no hay límite de uso, pero se monitoreará cualquier abuso.

\n\n# Filtrado\n\n


En los métodos Find de cada uno de los puntos de enlace podrá realizar el filtrado de la lista de resultados, para aplicar un filtro deberá agregar un parametro en la URL de nombre filter que deberá cumplir con las siguientes caracteristicas:

\n\n```\nfilter=property:comparision!value\n\n ```\n\nDonde:\n\n\n\nEs posible anidar más de un filtro de la siguiente manera:\n\n```\nfilter=empresa.rfc:like!LIO11,activo:eq!true\n\n ```\n\n# Ordenamiento\n\n


En los métodos Find de cada uno de los puntos de enlace podrá realizar un ordenamiento de la lista de resultados, para aplicar un ordenamiento deberá agregar un parametro en la URL de nombre orderby que deberá cumplir con las siguientes caracteristicas:

\n\n```\norderby=property:cardinality\n\n ```\n\nDonde:\n\n\n\nEs posible anidar más de un ordenamiento de la siguiente manera:\n\n```\norderby=empresa.rfc:asc,total:desc\n\n ```\n\n# Resultados\n\n


La estructura de la respuesta para un método es generalmente la misma y contendrá atributos que aparecen 'siempre' u atributos que aparecen 'condicionalmente'. Donde:

\n\n\n\nUn resultado con error se verá de la siguiente manera:\n\n```\n{\n \"succeed\": false,\n \"code\": 5003,\n \"message\": \"Access token incorrecto, verifique por favor.\",\n ...\n}\n\n ```\n\nMientras que uno satisfactorio se verá de la siguiente manera:\n\n```\n{\n \"succeed\": true,\n \"code\": 2000,\n \"message\": \"Petición satisfactoria.\",\n \"entity\": {\n \"data\": {\n \"id\": 81717,\n ...\n }\n }\n}\n\n ```\n\nPara los resultados de tipo pagination o result usted podrá enviar un parametro en la URL para definir si necesita el objeto completo o solo deltas del mismo.\n\n```\n/find?offset=0&size=10&type=movil\n\n ```\n\nObtendrá los objetos con algunas propiedades, especialmente pensado para clientes moviles. Si omite el parametro type, por defecto obtendra un listado de los objetos completos.\n\n# Peticiones\n\n


La estructura de la peticion para un método es generalmente la misma y contendrá el objeto entity y data además del/los objeto(s) necesario(s) para el recurso que se esté solicitando. Ejemplo:

\n\n```\n{\n \"entity\": {\n \"data\":{\n \"comprobantes\":[\n {\n \"requestUuid\" : \"123e4567-e89b-12d3-a456-426655440000\",\n \"encode\": \"PD...==\"\n } \n ],\n \"sucursal\": {\n \"id\" : 17694\n },\n ...\n }\n }\n}\n\n ```\n\n# Scopes\n\n


Los scopes válidos para el Webservice de Facture App son los siguientes:

\n\n
Scope
URL
Descripción
cliente
/cliente, /cliente/find
Leer, crear, actualizar y eliminar clientes del catálogo.
concepto
/concepto, /concepto/find
Leer, crear, actualizar y eliminar conceptos del catálogo.
emisor
/emisor, /emisor/find
Leer, crear, actualizar y eliminar emisores del catálogo.
sucursal
/sucursal, /sucursal/find
Leer, crear, actualizar y eliminar sucursales que pertenecen a un emisor del catálogo.
serie
/serie, /serie/find
Leer, crear, actualizar y eliminar series que pertenecen a una sucursal del catálogo.
moneda
/moneda, /moneda/find
Leer, crear, actualizar y eliminar monedas del catálogo.
impuesto
/impuesto, /impuesto/find
Leer, crear, actualizar y eliminar impuestos del catálogo.
timbrado
/timbrado32/pruebas, /timbrado32/produccion, /timbrado
Timbrar comprobantes de cualquier emisor vinculado al usuario.
facturacion
/facturacion/default, /facturacion/preview, /facturacion/enviar, /facturacion, /facturacion/find
Leer, obtener xml o pdf, envíar por correo electrónico comprobantes timbrados.
cancelacion
/cancelacion, /cancelacion/acuse
Cancelar y obtener acuses de cancelación de comprobantes timbrados.
item_usuario
/itemusuario, /itemsusuario/find
Leer y actualizar items comprados en la plataforma.
autofactura
/autofactura,/autofactura/find
Crear, leer y eliminar autofacturas.
descarga_masiva
/descargaMasiva,/descargaMasiva/find,/descargaMasiva/create,/descargaMasiva/verify,/descargaMasiva/download,/descargaMasiva/process
Crear, leer, verificar, descargar y procesar solicitudes de descarga masiva.
comprobante_recibido
/comprobanteRecibido,/comprobanteRecibido/find
Leer comprobantes recibidos dentro de la plataforma.
\n\n# Ambiente de pruebas\n\n


Para los puntos de enlace de Timbrado y Cancelación podrá realizar pruebas dando de alta Emisores de prueba, nuestro webservice automáticamente al detectar alguno de los RFC usará una implementación de prueba y no timbrados y/o cancelaciones reales.
La lista de emisores de prueba se encuentran en la siguiente tabla:

\n\n
Nombre
RFC
Enlace al CSD
ESCUELA KEMPER URGATE SA DE CV
EKU9003173C9
CSD
INNOVACION VALOR Y DESARROLLO SA
IVD920810GU2
CSD
ZAPATERIA URTADO ÑERI SA DE CV
ZUÑ920208KL4
CSD
XAIME WEIR ROJO
WERX631016S30
CSD
\n\n


En cada archivo del CSD encontrará el archivo \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*.cer y \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*.key junto con la contraseña del mismo, puede dar de alta desde la plataforma o a través del webservice el emisor y realizar las pruebas pertinentes.

\n\n

Es importante aclarar que para los emisores antes mencionados no se descontarán créditos de la cuenta desde la cual se realicen las pruebas para los puntos de enlance y métodos de timbrado y cancelación.

\n\n

Recomendaciones.- Pruebe registrar una cuenta demo desde el siguiente enlace Registro para que los timbrados de prueba se queden vinculados a esa cuenta y cuando esté listo su pase a producción registre la cuenta que quedará en producción.

\n\n

También recuerde que debe crear un client_id y client_secret desde Administración, Configuración y Aplicaciones para comenzar a usar nuestra API.

\n\n

UPDATE 17/11/2023

\n\n

Datos actualizados para la versión CFDI 4.0

\n\n
RFC
Nombre
Código postal
EKU9003173C9
ESCUELA KEMPER URGATE
42501
IVD920810GU2
INNOVACION VALOR Y DESARROLLO
63901
ZUÑ920208KL4
ZAPATERIA URTADO ÑERI
34541
WERX631016S30
XAIME WEIR ROJO
01279
\n\n# Codigos de respuesta\n\n\n\n

Videos tutoriales

\n\n

Para una mejor comprensión del funcionamiento de la API, puede consultar los tutoriales en video que hemos preparado. Estos le guiarán paso a paso a través de las principales funcionalidades, resolviendo posibles dudas y facilitando su integración con la API.

\n\n

Tutotial para generar el access token

\n\n\n\n

Tutotial para uso general de la API (find, get, timbrado, recuperar archivos)

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25362435","collectionId":"f9e8ed57-efb9-4b0d-b2ba-6ab202de2756","publishedId":"2s8ZDX437x","public":true,"publicUrl":"https://api.facture.com.mx","privateUrl":"https://go.postman.co/documentation/25362435-f9e8ed57-efb9-4b0d-b2ba-6ab202de2756","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-23T22:46:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://facture.com.mx/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.facture.com.mx/view/metadata/2s8ZDX437x"}