1. Home
  2. SW API´S
  3. Efisco® API
  1. Home
  2. Efisco
  3. Efisco® API

Efisco® API

Efisco® permite gestionar la descarga masiva de XML y generar reportes de los archivos descargados. Para poder generar las descargas es necesario contar con un token de acceso temporal o token infinito válido.

🧰 Url Producción : https://api.sw.com.mx

Proceso de descarga

🔎 Visualizar

Documentación

Documentación
requestType
RequestType Valor Descripción
WebService 0 Petición realizada vía servicio web
WebPortal 1 Petición realizada desde el portal del SAT | Scraping
Metadata 2 Petición de información metadatos

documentType
DocumentType Valor Descripción
Emisión 0 Documento que emitió el RFC que genera la solicitud
Recepción 1 Documento que recibió el RFC que genera la solicitud

processType
ProcessType Valor Descripción
XmlReport 0 Generación de reportes y descargas de archivos XML
PDF 1 Generación de archivos PDF de los archivos XML descargados
MetadataReport 2 Generación de reportes centrados en información de metadatos

statusRequest
statusRequest Valor Descripción
InProgress 1 Petición en curso
Error 3 Ocurrió un error durante el proceso
Expired 4 Petición expirada o ya no disponible
Completed 6 Proceso terminado con éxito

cfdiType
cfdiType Valor Descripción
Todos null Recuperar todos los tipos de comprobante
Pagos P Comprobante de tipo Pagos
Nómina N Comprobante de tipo Nómina
Ingreso I Comprobante de tipo Ingreso
Egreso E Comprobante de tipo Egreso
Traslados T Comprobante de tipo Traslados

cfdiComplement
cfdiComplement Valor Descripción
Todos null Recupera todos los complementos
Acreditamiento de IEPS acreditamientoieps10 Complemento de Acreditamiento de IEPS
Aerolíneas aerolineas Complemento de Aerolíneas
Certificado de Destrucción certificadodedestruccion Complemento de Certificado de Destrucción
CFDI Registro Fiscal cfdiregistrofiscal Complemento de CFDI Registro Fiscal
Comercio Exterior comercioexterior10 Complemento de Comercio Exterior
Comercio Exterior 1.1 comercioexterior11 Complemento de Comercio Exterior 1.1
Comprobante comprobante Complemento de Comprobante
Consumo de Combustibles consumodecombustibles Complemento de Consumo de Combustibles
Consumo de Combustibles 1.1 consumodecombustibles11 Complemento de Consumo de Combustibles 1.1
Sector de Ventas a Detalle detallista Complemento de Sector de Ventas a Detalle
Compra Venta de Divisas divisas Complemento de Compra Venta de Divisas
Donatarias donat11 Complemento de Donatarias
Estado de Cuenta de Combustibles de Monederos Electrónicos ecc11 Complemento de Estado de Cuenta de Combustibles de Monederos Electrónicos
Estado de Cuenta de Combustibles 1.2 ecc12 Complemento de Estado de Cuenta de Combustibles 1.2
Gastos de Hidrocarburos gastoshidrocarburos10 Complemento de Gastos de Hidrocarburos
Instituciones Educativas Privadas iedu Complemento de Instituciones Educativas Privadas
Otros Derechos e Impuestos implocal Complemento de Otros Derechos e Impuestos
INE 1.1 ine11 Complemento de INE 1.1
Ingresos de Hidrocarburos ingresoshidrocarburos Complemento de Ingresos de Hidrocarburos
Leyendas Fiscales leyendasfiscales Complemento de Leyendas Fiscales
Recibo de Pago de Salarios nomina11 Complemento de Recibo de Pago de Salarios
Recibo de Pago de Salarios 1.2 nomina12 Complemento de Recibo de Pago de Salarios 1.2
Notarios Públicos notariospublicos Complemento de Notarios Públicos
Obras de arte y antigüedades obrasarteantiguedades Complemento de Obras de arte y antigüedades
Pago en Especie pagoenespecie Complemento de Pago en Especie
Recepción de Pagos pagos10 Complemento de Recepción de Pagos
Persona Física Integrante de Coordinado pfic Complemento de Persona Física Integrante de Coordinado
Sustitución y Renovación Vehicular renovacionysustitucionvehiculos Complemento de Sustitución y Renovación Vehicular
Servicios Parciales de Construcción servicioparcialconstruccion Complemento de Servicios Parciales de Construcción
SPEI de Tercero a Tercero spei Complemento de SPEI de Tercero a Tercero
Terceros terceros11 Complemento de Terceros
Turista o Pasajero Extranjero turistapasajeroextranjero Complemento de Turista o Pasajero Extranjero
Vales de Despensa valesdedespensa Complemento de Vales de Despensa
Vehículo Usado vehiculousado Complemento de Vehículo Usado
Venta de Vehículos ventavehiculos11 Complemento de Venta de Vehículos

Servicio para trabajar con certificados

FIEL
Almacenar FIEL

Almacenar FIEL

Almacena una nueva FIEL en el sistema.

Endpoint

MétodoRuta
POST/gestion/v1/api/certificates/create/fiel

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
privatekeystring Requerido Key en Base64
publickeystringRequeridoCSD en Base64
passwordstringRequeridoContraseña del certificado

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/certificates/create/fiel' 
--header 'Authorization: Bearer {{token}}' 
--header 'Content-Type: application/json' 
--data-raw '{
	"privatekey": "{{base64Key}}",
	"publickey": "{{base64Cer}}",
	"password" : "12345678a"
}'

Ejemplo Response

Response OK
{
    "data": {
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "taxId": "CACX7605101P8",
        "createdDate": "2025-04-11T18:31:04.9935201+00:00",
        "serialNumber": "30001000000500003282",
        "name": "XOCHILT CASAS CHAVEZ",
        "notBefore": "2023-05-09T18:05:49+00:00",
        "notAfter": "2027-05-08T18:05:49+00:00",
        "encryptedPfx": "8nFGs1nqir...",
        "encryptedPK": "nxG25f9lPwt...",
        "encryptedPassword": "g109dSBauF8P3Fb7BNwBbg=="
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Verifique que el certificado y la contraseña sean correctos",
    "messageDetail": ""
}


Obtener certificados paginados

Obtener certificados paginados

Consulta paginada de llaves FIEL pertenecientes al usuario del token.

Endpoint

MétodoRuta
POST/gestion/v1/api/certificates/get/fiel?page=1&per_page=10

Parámetros Query

PropiedadUsoDescripción
pageRequeridoPagina que se extrae en la consulta
per_pageRequeridoNumero de registros por pagina

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/certificates/get/fiel?page=1&per_page=10' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 2,
            "totalCount": 2,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": [
            {
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T18:39:09",
                "serialNumber": "30001000000500003282",
                "name": "XOCHILT CASAS CHAVEZ",
                "notBefore": "2023-05-09T18:05:49",
                "notAfter": "2027-05-08T18:05:49"
            },
            {
                "taxId": "XIQB891116QE4",
                "createdDate": "2025-04-11T18:44:05",
                "serialNumber": "30001000000500003301",
                "name": "BERENICE XIMO QUEZADA",
                "notBefore": "2023-05-09T18:42:24",
                "notAfter": "2027-05-08T18:42:24"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 0,
            "totalCount": 0,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": []
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Obtener certificado por RFC

Obtener certificado por RFC

Consulta la llave FIEL específica de un RFC perteneciente al usuario del token.

Endpoint

MétodoRuta
POST/gestion/v1/api/certificates/get/fiel?filter={taxId}

Parámetros Query

PropiedadUsoDescripción
filterRequeridoRFC de la FIEL a buscar

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/certificates/get/fiel?filter={taxId}' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 1,
            "totalCount": 1,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": [
            {
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T18:39:09",
                "serialNumber": "30001000000500003282",
                "name": "XOCHILT CASAS CHAVEZ",
                "notBefore": "2023-05-09T18:05:49",
                "notAfter": "2027-05-08T18:05:49"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 0,
            "totalCount": 0,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": []
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Eliminar certificados

Eliminar certificados

Borra una FIEL almacenada.

Endpoint

MétodoRuta
DELETE/gestion/v1/api/certificates/{taxId}

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Parámetros Path

PropiedadUsoDescripción
taxIdRequeridoRFC de la FIEL a eliminar

Ejemplo Request

curl --location --request DELETE 'https://api.sw.com.mx/gestion/v1/api/certificates/{taxId}' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": "Certificado 30001000000500003282 eliminado exitosamente.",
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "El certificado que se intenta eliminar no se encuentra en la base de datos.",
    "messageDetail": ""
}



CIEC
ℹ️Nota: Si solo se carga la CIEC en Efisco, las descargas estarán limitadas al método de Portal del SAT | Scraping.
Almacenar CIEC

Almacenar CIEC

Almacena una nueva CIEC en el sistema.

Endpoint

MétodoRuta
POST/gestion/v1/api/ciecs

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
taxIdstring Requerido RFC relacionado a la CIEC
passwordstringRequeridoContraseña CIEC

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/ciecs' 
--header 'Authorization: Bearer {{token}}' 
--header 'Content-Type: application/json' 
--data '{
    "taxId": "EKU9003173C9",
    "password": "12345678a"
}'

Ejemplo Response

Response OK
{
    "data": {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idUser": "6fa459ea-ee8a-11e3-ac10-0800200c9a66",
        "idDealer": "6fa459ea-ee8a-11e3-ac10-0800200c9a66",
        "taxId": "EKU9003173C9",
        "password": "QXJnb...",
        "createdDate": "2025-04-11T13:56:37.9289642"
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Password no valido para RFC.",
    "messageDetail": ""
}


Obtener CIEC por ID

Obtener CIEC por ID

Consulta por ID de una CIEC perteneciente al usuario del token.

Endpoint

MétodoRuta
GET/gestion/v1/api/ciecs/{id}

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Parámetros Path

PropiedadTipoUsoDescripción
idstring Requerido ID relacionado a la CIEC cargada

Ejemplo Request

curl --location --request GET 'https://api.sw.com.mx/gestion/v1/api/ciecs/{id}' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "id": "9615e32e-d5ef-445f-938c-ff2809d9d963",
        "idUser": "6fa459ea-ee8a-11e3-ac10-0800200c9a66",
        "idDealer": "6fa459ea-ee8a-11e3-ac10-0800200c9a66",
        "taxId": "EKU9003173C9",
        "createdDate": "2025-04-11T14:01:11"
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Object reference not set to an instance of an object.",
    "messageDetail": ""
}


Obtener CIEC´s paginadas

Obtener CIEC´s paginadas

Consulta paginada de CIEC´s perteneciente al usuario del token.

Endpoint

MétodoRuta
GET/gestion/v1/api/ciecs?page=1&per_page=10

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Parámetros Query

PropiedadUsoDescripción
page Requerido Pagina que se extrae en la consulta
per_pageRequeridoNumero de registros por pagina

Ejemplo Request

curl --location --request GET 'https://api.sw.com.mx/gestion/v1/api/ciecs?page=1&per_page=10' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 2,
            "totalCount": 2,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": [
            {
                "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T13:56:38"
            },
            {
                "id": "6fa459ea-ee8a-11e3-ac10-0800200c9a66",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "taxId": "EKU9003173C9",
                "createdDate": "2025-04-11T14:01:11"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 10,
            "pageCount": 0,
            "totalCount": 0,
            "links": {
                "current": "?page=1&per_page=10"
            }
        },
        "records": []
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Actualizar CIEC

Actualizar CIEC

Actualizar CIEC perteneciente al usuario del token.

Endpoint

MétodoRuta
PUT/gestion/v1/api/ciecs/{id}

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros Path

PropiedadUsoDescripción
id Requerido ID relacionado con la CIEC a actualizar

Ejemplo Request

curl --location --request PUT 'https://api.sw.com.mx/gestion/v1/api/ciecs/{id}' 
--header 'Authorization: Bearer {{token}}' 
--header 'Content-Type: application/json' 
--data '{
    "taxId": "EKU9003173C9",
    "password": "12345678a"
}'

Ejemplo Response

Response OK
{
    "data": {
        "id": "9615e32e-d5ef-445f-938c-ff2809d9d963",
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "taxId": "EKU9003173C9",
        "password": "12345678a",
        "createdDate": "2025-04-11T12:41:37"
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Password no valido para RFC.",
    "messageDetail": ""
}


Eliminar CIEC

Eliminar CIEC

Eliminar CIEC perteneciente al usuario del token.

Endpoint

MétodoRuta
DELETE/gestion/v1/api/ciecs/{id}

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Parámetros Path

PropiedadUsoDescripción
id Requerido ID relacionado con la CIEC a eliminar

Ejemplo Request

curl --location --request DELETE 'https://api.sw.com.mx/gestion/v1/api/ciecs/{id}' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": "Ciec con id f47ac10b-58cc-4372-a567-0e02b2c3d479 eliminado correctamente.",
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "No se encontro ciec con ese id.",
    "messageDetail": ""
}



Crear solicitud de descarga masiva

Portal del SAT | Scraping

Portal del SAT | Scraping

ℹ️Notas
  • Único servicio que permite obtener archivos XML con estatus cancelado.
  • Límite diario de 2,000 documentos, con un tiempo de respuesta promedio de 24 horas.

Endpoint

MétodoRuta
POST/gestion/v1/api/massiveservicemanager/request/create/webportal

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
documentTypestring Requerido Tipo de documento a descargar
startDatestring Requerido Fecha de inicio (“aaaa-mm-dd”)
endDatestring Requerido Fecha de fin (“aaaa-mm-dd”)
taxIdstring Requerido RFC
generatePDFboolRequerido(Default = false) Especificar si se generaran los PDFs de los documentos descargadas
googleDriveboolOpcional(Default = false) Especificar si se guarda la descarga en Google Drive (si existe cuenta vinculada)

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/massiveservicemanager/request/create/webportal' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "documentType": "Emision",
    "startDate": "2025-01-01",
    "endDate": "2025-01-29",
    "taxId": "XIQB891116QE4",
    "generatePDF": false,
    "googleDrive": false
}'

Ejemplo Response

Response OK
{
    "data": {
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "requestId": "0dc44f00-b66b-495c-acce-5a0aeee88fec",
        "taxId": "XIQB891116QE4",
        "createdDate": "2025-04-11T15:05:40.7868786",
        "dateFrom": "2025-01-01T00:00:00",
        "dateTo": "2025-01-31T23:59:59",
        "requestType": 1,
        "documentType": 0,
        "statusRequest": 1,
        "message": "La solicitud de descarga de xml se encuentra en progreso",
        "totalFiles": 0,
        "rfcEmisor": null,
        "rfcReceptor": null,
        "efosIndicator": 0,
        "rfcTPAccount": null,
        "cfdiType": null,
        "cfdiComplement": null,
        "processes": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "0dc44f00-b66b-495c-acce-5a0aeee88fec",
                "processType": 0,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:05:40.7868786"
            },
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "0dc44f00-b66b-495c-acce-5a0aeee88fec",
                "processType": 1,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:05:40.7868786"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Ya existe una solicitud con los mismos parámetros : 2025-01-01-2025-01-31 . RFC XIQB891116QE4",
    "messageDetail": ""
}


Web Service

Web Service

ℹ️Notas
  • Solo recupera XML vigentes, permitiendo descargar información histórica (hasta 5 años) y del ejercicio actual.
  • Límite por petición de hasta 200,000 documentos, con un tiempo de respuesta de hasta 6 días.

Endpoint

MétodoRuta
POST/gestion/v1/api/massiveservicemanager/request/create/webservice

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
documentTypestring Requerido Tipo de documento a descargar
startDatestring Requerido Fecha de inicio (“aaaa-mm-dd hh:mm:ss”)
endDatestring Requerido Fecha de fin (“aaaa-mm-dd hh:mm:ss”)
taxIdstring Requerido RFC del usuario
generatePDFboolRequerido(Default = false) Especifica si se generaran los PDFs de los documentos descargadas
googleDriveboolRequerido(Default = false) Especificar si se guarda la descarga en Google Drive (si existe cuenta vinculada)
rfcReceptorarrayOpcional(Default = empty) Especifica el RFC receptor a buscar en los XML descargados (en caso de descarga de tipo Emisión
cfdiTypestringOpcional(Default = null) Especifica el tipo de comprobante a descargar (si es null busca todos los tipos de comprobantes)
cfdiComplementstringOpcional(Default = null) Especifica el tipo de complemento a buscar (si es null busca todos los tipos de complementos)

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/massiveservicemanager/request/create/webservice' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "documentType": "Emision",
    "startDate": "2025-01-01 00:00:00",
    "endDate": "2025-01-31 23:59:58",
    "taxId": "CACX7605101P8",
    "generatePDF": true,
    "googleDrive": false,
    "rfcReceptor": [],
    "cfdiType": null,
    "cfdiComplement": null
}'

Ejemplo Response

Response OK
{
    "data": {
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "requestId": "b72ef0e3-27e6-4082-bfbc-f91c240a3063",
        "taxId": "CACX7605101P8",
        "createdDate": "2025-04-11T15:24:57.4954099",
        "dateFrom": "2025-01-01T00:00:00",
        "dateTo": "2025-01-31T23:59:58",
        "requestType": 0,
        "documentType": 0,
        "statusRequest": 1,
        "message": "La solicitud de descarga de xml se encuentra en progreso",
        "totalFiles": 0,
        "rfcEmisor": null,
        "rfcReceptor": "",
        "efosIndicator": 0,
        "rfcTPAccount": null,
        "cfdiType": null,
        "cfdiComplement": null,
        "processes": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "b72ef0e3-27e6-4082-bfbc-f91c240a3063",
                "processType": 0,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:24:57.4954099"
            },
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "b72ef0e3-27e6-4082-bfbc-f91c240a3063",
                "processType": 1,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:24:57.4954099"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Ya existe una solicitud con los mismos parámetros : 2025-01-01 00:00:00-2025-01-31 23:59:58 . RFC CACX7605101P8",
    "messageDetail": ""
}


Metadata

Metadata

ℹ️Notas
  • Permite descargar hasta 1 millon de registros por petición.
  • Únicamente retorna la información metadata de los comprobantes, con un tiempo de respuesta de hasta 6 días.

Endpoint

MétodoRuta
POST/gestion/v1/api/MassiveServiceManager/request/create/webservice/metadata

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
documentTypestring Requerido Tipo de documento a descargar
startDatestring Requerido Fecha de inicio (“aaaa-mm-dd hh:mm:ss”)
endDatestring Requerido Fecha de fin (“aaaa-mm-dd hh:mm:ss”)
taxIdstring Requerido RFC

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/MassiveServiceManager/request/create/webservice/metadata' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "documentType": "Emision",
    "startDate": "2025-01-01 00:00:00",
    "endDate": "2025-01-31 23:59:58",
    "taxId": "CACX7605101P8"
}'

Ejemplo Response

Response OK
{
    "data": {
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "requestId": "5705cbf0-4886-4132-8c98-94fdfd8f2b93",
        "taxId": "CACX7605101P8",
        "createdDate": "2025-04-11T15:32:53.3265727",
        "dateFrom": "2025-01-01T00:00:00",
        "dateTo": "2025-01-31T23:59:58",
        "requestType": 2,
        "documentType": 0,
        "statusRequest": 1,
        "message": "La solicitud de descarga se encuentra en progreso",
        "totalFiles": 0,
        "rfcEmisor": null,
        "rfcReceptor": null,
        "efosIndicator": 0,
        "rfcTPAccount": null,
        "cfdiType": null,
        "cfdiComplement": null,
        "processes": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "5705cbf0-4886-4132-8c98-94fdfd8f2b93",
                "processType": 2,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:32:53.3265727"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "El certificado del RFC es inválido, por favor actualícelo. (305)",
    "messageDetail": ""
}


Descarga programada

Descarga programada

Se crea tarea programada de descarga de CFDI periódicamente.

Endpoint

MétodoRuta
POST/gestion/v1/api/gestionxml/scheduler/create

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
activeint Requerido Estatus de la descarga
schedulestring Requerido Hora de ejecución de la descarga, siempre se ejecuta a las 00:00:00 hrs
documentTypestring Requerido Tipo de documento a descargar
taxIdstring Requerido RFC del usuario
lapseDaysint Requerido Rango de días de la información a descargar
processTypeintRequeridoTipo de proceso a ejecutar
frecuencyInDaysintRequeridoFrecuencia en dias con la que se hará la descarga
generatePdfintOpcional (Default = 0) Especificar si se generaran los PDFs de los documentos descargadas
googleDriveintOpcional(Default = 0) Especificar si se guarda la descarga en Google Drive (si existe cuenta vinculada)
cfdiTypestringOpcional(Default = null) Especifica el tipo de comprobante a descargar (si es null busca todos los tipos de comprobantes)
cfdiComplementstringOpcional(Default = null) Especifica el tipo de complemento a buscar (si es null busca todos los tipos de complementos)

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/gestionxml/scheduler/create' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '[
    {
        "active": 1,
        "schedule": "00:00:00",
        "documentType": 2,
        "taxId": "CACX7605101P8",
        "lapseDays": 1,
        "processType": 2,
        "frecuencyInDays": 2,
        "generatePdf": 0,
        "googleDrive": 0,
        "cfdiType": null,
        "cfdiComplement": null
    }
]'

Ejemplo Response

Response OK
{
    "data": "Datos insertados.",
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "Rfc no declarado o vacío",
    "messageDetail": ""
}


Consulta solicitudes de descarga masiva

Consulta paginada

Consulta paginada

Consulta paginada de solicitudes creadas pertenecientes al usuario del token.

Endpoint

MétodoRuta
GET/gestion/v1/api/gestionxml/request?page=1&per_page=1

Parámetros Query

PropiedadUsoDescripción
pageRequeridoPagina que se extrae en la consulta
per_pageRequeridoNumero de registros por pagina

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Ejemplo Request

curl --location --request GET 'https://api.sw.com.mx/gestion/v1/api/gestionxml/request?page=1&per_page=1' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 3,
            "pageCount": 3,
            "totalCount": 56,
            "links": {
                "current": "?page=1&per_page=3",
                "next": "?page=2&per_page=3"
            }
        },
        "records": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "14624457-0134-4e1d-993d-7862861ccf2c",
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T15:41:33",
                "dateFrom": "2025-02-01T00:00:00",
                "dateTo": "2025-02-28T23:59:59",
                "requestType": 2,
                "documentType": 1,
                "statusRequest": 1,
                "message": "La solicitud de descarga de xml se encuentra en progreso",
                "totalFiles": 0,
                "rfcEmisor": null,
                "rfcReceptor": null,
                "efosIndicator": 0,
                "rfcTPAccount": null,
                "cfdiType": null,
                "cfdiComplement": null,
                "processes": [
                    {
                        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "requestId": "14624457-0134-4e1d-993d-7862861ccf2c",
                        "processType": 2,
                        "statusProcess": 1,
                        "message": "",
                        "url": null,
                        "createdDate": "2025-04-11T15:41:33"
                    }
                ]
            },
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "d7e649c6-5241-41db-bd0f-84b4c6229e79",
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T15:41:22",
                "dateFrom": "2025-03-01T00:00:00",
                "dateTo": "2025-03-31T23:59:59",
                "requestType": 1,
                "documentType": 1,
                "statusRequest": 1,
                "message": "La solicitud de descarga de xml se encuentra en progreso",
                "totalFiles": 0,
                "rfcEmisor": null,
                "rfcReceptor": null,
                "efosIndicator": 0,
                "rfcTPAccount": "",
                "cfdiType": null,
                "cfdiComplement": null,
                "processes": [
                    {
                        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "requestId": "d7e649c6-5241-41db-bd0f-84b4c6229e79",
                        "processType": 0,
                        "statusProcess": 1,
                        "message": "",
                        "url": null,
                        "createdDate": "2025-04-11T15:41:22"
                    },
                    {
                        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "requestId": "d7e649c6-5241-41db-bd0f-84b4c6229e79",
                        "processType": 1,
                        "statusProcess": 1,
                        "message": "",
                        "url": null,
                        "createdDate": "2025-04-11T15:41:22"
                    }
                ]
            },
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "bb17ab8b-7913-4c9b-b3b4-330a6640ca28",
                "taxId": "CACX7605101P8",
                "createdDate": "2025-04-11T15:41:12",
                "dateFrom": "2025-03-01T00:00:00",
                "dateTo": "2025-03-31T23:59:59",
                "requestType": 0,
                "documentType": 0,
                "statusRequest": 3,
                "message": " No se encontró la información con los datos proporcionados, inténtalo con otros parámetros de búsqueda (5004)",
                "totalFiles": 0,
                "rfcEmisor": null,
                "rfcReceptor": null,
                "efosIndicator": 0,
                "rfcTPAccount": "",
                "cfdiType": null,
                "cfdiComplement": null,
                "processes": [
                    {
                        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "requestId": "bb17ab8b-7913-4c9b-b3b4-330a6640ca28",
                        "processType": 0,
                        "statusProcess": 3,
                        "message": " No se encontró la información con los datos proporcionados, inténtalo con otros parámetros de búsqueda (5004)",
                        "url": null,
                        "createdDate": "2025-04-11T15:41:12"
                    },
                    {
                        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                        "requestId": "bb17ab8b-7913-4c9b-b3b4-330a6640ca28",
                        "processType": 1,
                        "statusProcess": 1,
                        "message": "",
                        "url": null,
                        "createdDate": "2025-04-11T15:41:12"
                    }
                ]
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 3,
            "pageCount": 0,
            "totalCount": 0,
            "links": {
                "current": "?page=1&per_page=3"
            }
        },
        "records": []
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Consulta por requestId

Consulta por requestId

Consulta por requestId de solicitud creada perteneciente al usuario del token.

Endpoint

MétodoRuta
GET/gestion/v1/api/gestionxml/{requestId}

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Parámetros Path

PropiedadUsoDescripción
idRequestRequeridoID de la solicitud

Ejemplo Request

curl --location -g --request GET 'https://api.sw.com.mx/gestion/v1/api/gestionxml/{requestId}' 
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "requestId": "14624457-0134-4e1d-993d-7862861ccf2c",
        "taxId": "CACX7605101P8",
        "createdDate": "2025-04-11T15:41:33",
        "dateFrom": "2025-02-01T00:00:00",
        "dateTo": "2025-02-28T23:59:59",
        "requestType": 2,
        "documentType": 1,
        "statusRequest": 1,
        "message": "La solicitud de descarga de xml se encuentra en progreso",
        "totalFiles": 0,
        "rfcEmisor": null,
        "rfcReceptor": null,
        "efosIndicator": 0,
        "rfcTPAccount": null,
        "cfdiType": null,
        "cfdiComplement": null,
        "processes": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "requestId": "14624457-0134-4e1d-993d-7862861ccf2c",
                "processType": 2,
                "statusProcess": 1,
                "message": "",
                "url": null,
                "createdDate": "2025-04-11T15:41:33"
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Consulta peticiones programadas

Consulta peticiones programadas

Consulta registros de peticiones programadas creadas pertenecientes al usuario del token.

Endpoint

MétodoRuta
GET/gestion/v1/api/gestionxml/scheduler?page=1&perPage=2

Parámetros Query

PropiedadUsoDescripción
pageRequeridoPagina que se extrae en la consulta
per_pageRequeridoNumero de registros por pagina

Autenticación y Headers

HeaderValue
AuthorizationBearer Token

Ejemplo Request

curl --location --request GET 'https://api.sw.com.mx/gestion/v1/api/gestionxml/scheduler?page=1&perPage=2' \
--header 'Authorization: Bearer {{token}}'

Ejemplo Response

Response OK
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 2,
            "pageCount": 2,
            "totalCount": 2,
            "links": {
                "current": "?page=1&per_page=2"
            }
        },
        "records": [
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "active": 0,
                "lapseDays": 90,
                "schedule": "00:00:00",
                "documentType": 0,
                "taxId": "CACX7605101P8",
                "token": "T2lYQ0t4L0...",
                "visited": "2025-04-09T16:21:37",
                "processType": 0,
                "nextSchedule": "2025-05-11T00:00:00",
                "frequencyInDays": 90,
                "generatePdf": 1,
                "googleDrive": 1,
                "cfdiType": null,
                "cfdiComplement": null
            },
            {
                "idDealer": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "idUser": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
                "active": 1,
                "lapseDays": 180,
                "schedule": "00:00:00",
                "documentType": 1,
                "taxId": "CACX7605101P8",
                "token": "T2lYQ0t4L0...",
                "visited": "2025-04-11T14:21:37",
                "processType": 0,
                "nextSchedule": "2025-04-24T00:00:00",
                "frequencyInDays": 90,
                "generatePdf": 1,
                "googleDrive": 1,
                "cfdiType": null,
                "cfdiComplement": null
            }
        ]
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": {
        "metaData": {
            "page": 1,
            "perPage": 2,
            "pageCount": 0,
            "totalCount": 0,
            "links": {
                "current": "?page=1&per_page=2"
            }
        },
        "records": []
    },
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}


Descarga de solicitud

Obtener URL de descarga pública

Obtener URL de Descarga Pública

Genera path público de descarga de documentos mediante el path privado de S3.

Endpoint

MétodoRuta
POST/gestion/v1/api/file

Autenticación y Headers

HeaderValue
AuthorizationBearer Token
Content-Typeapplication/json

Parámetros JSON

PropiedadTipoUsoDescripción
pathFilestring Requerido Path privado de S3

Ejemplo Request

curl --location --request POST 'https://api.sw.com.mx/gestion/v1/api/file' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "pathFile": "f47ac10b-58cc-4372-a567-0e02b2c3d479/11-04-2025/Report_6fa459ea-ee8a-11e3-ac10-0800200c9a66.zip"
}'

Ejemplo Response

Response OK
{
    "data": "https://smarter-gestion-xml-s3-prod.s3.amazonaws.com/f47ac10b-58cc-4372-a567-0e02b2c3d479/11-04-2025/Report_6fa459ea-ee8a-11e3-ac10-0800200c9a66.zip?AWSAccessKeyId=AKIEVRP5AMYOYVPEJ3XV&Expires=1744491409&Signature=IZAshfH7k%2F7%2B4%2F8b3ycoaEDhmOc%3D",
    "status": "success",
    "message": "OK",
    "messageDetail": ""
}

Response Error
{
    "data": null,
    "status": "error",
    "message": "La ruta del archivo no corresponde al usuario de la petición",
    "messageDetail": ""
}


Códigos de error devueltos por el SAT

Códigos de errores SAT
Código Mensaje Descripción
304 Certificado Revocado o Caduco El certificado fue revocado o bien la fecha de vigencia expiró.
305 Certificado Inválido El certificado puede ser inválido por múltiples razones como son el tipo, la vigencia, etc.
404 Error no controlado Error no controlado devuelto por el SAT
5002 Se han agotado las solicitudes de por vida Se ha alcanzado el límite de solicitudes, con el mismo criterio
5003 Tope máximo Indica que con base en los parámetros de consulta se está superando el tope máximo de CFDI o Metadata, por solicitud de descarga masiva.
5004 No se encontró la información No se encontró la información con los datos proporcionados, inténtalo con otros parámetros de búsqueda.
5006 Error interno en el proceso Error interno en el proceso devuelto por el SAT


En SW® somos mejores para TI, es por ello que tu opinión es muy importante, por favor ayúdanos calificando este articulo y dejando tus comentarios.

How useful was this post?

Click on a star to rate it!

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?

Updated on abril 16, 2025

Related Articles