¿Preguntas?

Más información en nuestro Centro de Ayuda.

Centro de Ayuda
Contacto

Envíanos un mail con tu duda o sugerencia.

Contacto

API SAT

Todas las requests deben incluir el API Key, ya sea usando el header X-API-Key o el parametro api_key en la url.


Especificación OpenAPI

Login

Endpoint: POST /login/

Parámetros Descripción
provider

Proveedor: sat

rfc

Número de RFC.

password

Contraseña de acceso.

scope

Tipo de login a realizar * cfdi descarga de facturas * siat consultar la opinión de cumplimiento.

Respuesta:

Status Descripción
status
  • wrong_credentials usuario o password inválidos.

  • missing_credentials falta un campo de credenciales.

  • logged_in sesión iniciada correctamente.

session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes (no estará presente si el status es un error).

message

Mensaje obtenido en caso de que las credenciales sean erróneas.

missing_fields

Campos faltantes para la consulta (no estará presente ante un inicio de sesión exitoso).

El login puede demorar hasta 20s en generar una respuesta dependiendo de la carga que tenga la página de la Hacienda.

Login

POST /login/ HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

provider=sat&rfc=RFC&password=PASSWORD&scope=cfdi

Respuesta:

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta con interacción requerida:

{
    "context": "/captcha/a9bff7e2ff97582c69aa00a785c3e191.jpg",
    "field": "captcha",
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "status": "interaction_required"
}

Respuesta errónea:

{
    "status" : "wrong_credentials",
    "message" : "El RFC o contraseña son incorrectos. Verifique su información e inténtelo de nuevo."
}

Respuesta errónea por falta de parámetros:

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
curl -X POST "https://fiscal.sandbox.prometeoapi.com/login/" -d "provider=sat&rfc=RFC&password=PASSWORD&scope=cfdi" -H "X-API-Key: <API KEY>"

Respuesta:

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta con interacción requerida:

{
    "context": "/captcha/a9bff7e2ff97582c69aa00a785c3e191.jpg",
    "field": "captcha",
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "status": "interaction_required"
}

Respuesta errónea:

{
    "status" : "wrong_credentials",
    "message" : "El RFC o contraseña son incorrectos. Verifique su información e inténtelo de nuevo."
}

Respuesta errónea por falta de parámetros:

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
import requests

requests.post('https://fiscal.sandbox.prometeoapi.com/login/', data={
    'provider': 'sat',
    'rfc': 'RFC',
    'password': 'PASSWORD',
    'scope': 'cfdi',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta con interacción requerida:

{
    "context": "/captcha/a9bff7e2ff97582c69aa00a785c3e191.jpg",
    "field": "captcha",
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "status": "interaction_required"
}

Respuesta errónea:

{
    "status" : "wrong_credentials",
    "message" : "El RFC o contraseña son incorrectos. Verifique su información e inténtelo de nuevo."
}

Respuesta errónea por falta de parámetros:

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
var request = require('request');

request.post({
  "url": "https://fiscal.sandbox.prometeoapi.com/login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "form": {
    "provider": "sat",
    "rfc": "RFC",
    "password": "PASSWORD",
    "scope": "cfdi"
  }
});

Respuesta:

{
    "status" : "logged_in",
    "session_key" : "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
}

Respuesta con interacción requerida:

{
    "context": "/captcha/a9bff7e2ff97582c69aa00a785c3e191.jpg",
    "field": "captcha",
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "status": "interaction_required"
}

Respuesta errónea:

{
    "status" : "wrong_credentials",
    "message" : "El RFC o contraseña son incorrectos. Verifique su información e inténtelo de nuevo."
}

Respuesta errónea por falta de parámetros:

{
    "status" : "missing_credentials",
    "missing_fields" : [
        "password"
    ]
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}

Logout

Endpoint: GET /logout/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta:

Status Descripción
status
  • logged_out sesión cerrada con éxito

Luego de realizar el logout, la session key usada ya no sera válida para hacer más llamadas.

Logout

GET /logout/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "status" : "logged_out",
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/logout/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "status" : "logged_out",
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/logout/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "status" : "logged_out",
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/logout/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "status" : "logged_out",
}

Respuesta errónea por falta de API KEY:

{
    "data": null,
    "error": "Missing API key"
}

Opinión de cumplimiento

Endpoint: GET /obligations/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Opinión de cumplimiento

GET /obligations/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "obligations": {
        "credits": ["152112177429527C12005"],
        "obligations": [
            {
                "name": "Pago provisional mensual de ISR por servicios profesionales. Régimen deActividades Empresariales y Profesionales.",
                "periods": [
                    "Enero/2014"
                ]
            }
        ],
        "pdf_url": "/pdf/bd13ff994b8f855cfae856221e384c8d.pdf"
    },
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/obligations/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "obligations": {
        "credits": ["152112177429527C12005"],
        "obligations": [
            {
                "name": "Pago provisional mensual de ISR por servicios profesionales. Régimen deActividades Empresariales y Profesionales.",
                "periods": [
                    "Enero/2014"
                ]
            }
        ],
        "pdf_url": "/pdf/bd13ff994b8f855cfae856221e384c8d.pdf"
    },
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/obligations/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "obligations": {
        "credits": ["152112177429527C12005"],
        "obligations": [
            {
                "name": "Pago provisional mensual de ISR por servicios profesionales. Régimen deActividades Empresariales y Profesionales.",
                "periods": [
                    "Enero/2014"
                ]
            }
        ],
        "pdf_url": "/pdf/bd13ff994b8f855cfae856221e384c8d.pdf"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/obligations/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "obligations": {
        "credits": ["152112177429527C12005"],
        "obligations": [
            {
                "name": "Pago provisional mensual de ISR por servicios profesionales. Régimen deActividades Empresariales y Profesionales.",
                "periods": [
                    "Enero/2014"
                ]
            }
        ],
        "pdf_url": "/pdf/bd13ff994b8f855cfae856221e384c8d.pdf"
    },
    "status": "success"
}

Descarga de Facturas Emitidas

Endpoint: GET /cfdi/emitted/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

date_start

Fecha Inicial de Emisión, formato (DD/MM/AAAA).

date_end

Fecha Final de Emisión, formato (DD/MM/AAAA).

status
  • cancelledd cancelado

  • valid vigente

  • any cualquier estado

action
  • bulk_download descarga masiva

  • metadata_download descarga de metadata

  • pdf_export exportar resultados a pdf

  • list lista las facturas encontradas

type
Tipo de comprobante.
Este campo es opcional.
- recepcion_pagos

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Si el rango de fechas especificado es mayor a 12 meses, se generaran varias descargas, cada una abarcando un periodo máximo de 12 meses.

Descarga de Facturas Emitidas

GET /cfdi/emitted/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

date_start=01%2F05%2F2017&date_end=07%2F06%2F2018&status=cancelled&action=bulk_download

Respuesta de descarga masiva o de metadata exitosa:

{
    "emitted": [
        {
            "request_id": "50AD2BA1-27AE-4CC3-84FD-265E585A1F67"
        },
        {
            "request_id": "A6326A6B-68D0-4580-9FAD-A22F987FE43E"
        }
    ],
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "emitted": [
        {
            "pdf_url": "/pdf/655ea3b7d0ec5fa1914aca7809e72449.pdf"
        }
    ],
    "status": "success"
}

Respuesta de listado de facturas:

{
    "emitted": [
        {
            "certification_date": "2018-08-29T20:50:04",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-29T20:50:03",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "DDAA8B0B-4FDC-43D7-A633-F307B898AB3C",
            "receiver_reason": "Jane Doe",
            "receiver_rfc": "ZXYW740519633",
            "status": "valid",
            "total_value": 174.36
        },
        {
            "certification_date": "2018-08-30T09:43:55",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-30T09:43:55",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "EB758D6A-07F5-4947-ACD5-98BF0B61654F",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ASD030224ES6",
            "status": "valid",
            "total_value": 106.22
        },
        {
            "certification_date": "2018-06-12T05:34:19",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-06-12T05:34:19",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD790408BJ2",
            "id": "FB8C12A1-DA2C-47B0-B2FF-F10A718DB673",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ZXC050315240",
            "status": "cancelled",
            "total_value": 231.41
        }
    ],
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8" -d "date_start=01%2F05%2F2017&date_end=07%2F06%2F2018&status=cancelled&action=bulk_download" -H "X-API-Key: <API KEY>"

Respuesta de descarga masiva o de metadata exitosa:

{
    "emitted": [
        {
            "request_id": "50AD2BA1-27AE-4CC3-84FD-265E585A1F67"
        },
        {
            "request_id": "A6326A6B-68D0-4580-9FAD-A22F987FE43E"
        }
    ],
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "emitted": [
        {
            "pdf_url": "/pdf/655ea3b7d0ec5fa1914aca7809e72449.pdf"
        }
    ],
    "status": "success"
}

Respuesta de listado de facturas:

{
    "emitted": [
        {
            "certification_date": "2018-08-29T20:50:04",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-29T20:50:03",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "DDAA8B0B-4FDC-43D7-A633-F307B898AB3C",
            "receiver_reason": "Jane Doe",
            "receiver_rfc": "ZXYW740519633",
            "status": "valid",
            "total_value": 174.36
        },
        {
            "certification_date": "2018-08-30T09:43:55",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-30T09:43:55",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "EB758D6A-07F5-4947-ACD5-98BF0B61654F",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ASD030224ES6",
            "status": "valid",
            "total_value": 106.22
        },
        {
            "certification_date": "2018-06-12T05:34:19",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-06-12T05:34:19",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD790408BJ2",
            "id": "FB8C12A1-DA2C-47B0-B2FF-F10A718DB673",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ZXC050315240",
            "status": "cancelled",
            "total_value": 231.41
        }
    ],
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, data={
    'date_start': '01/05/2017',
    'date_end': '07/06/2018',
    'status': 'cancelled',
    'action': 'bulk_download',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta de descarga masiva o de metadata exitosa:

{
    "emitted": [
        {
            "request_id": "50AD2BA1-27AE-4CC3-84FD-265E585A1F67"
        },
        {
            "request_id": "A6326A6B-68D0-4580-9FAD-A22F987FE43E"
        }
    ],
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "emitted": [
        {
            "pdf_url": "/pdf/655ea3b7d0ec5fa1914aca7809e72449.pdf"
        }
    ],
    "status": "success"
}

Respuesta de listado de facturas:

{
    "emitted": [
        {
            "certification_date": "2018-08-29T20:50:04",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-29T20:50:03",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "DDAA8B0B-4FDC-43D7-A633-F307B898AB3C",
            "receiver_reason": "Jane Doe",
            "receiver_rfc": "ZXYW740519633",
            "status": "valid",
            "total_value": 174.36
        },
        {
            "certification_date": "2018-08-30T09:43:55",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-30T09:43:55",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "EB758D6A-07F5-4947-ACD5-98BF0B61654F",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ASD030224ES6",
            "status": "valid",
            "total_value": 106.22
        },
        {
            "certification_date": "2018-06-12T05:34:19",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-06-12T05:34:19",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD790408BJ2",
            "id": "FB8C12A1-DA2C-47B0-B2FF-F10A718DB673",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ZXC050315240",
            "status": "cancelled",
            "total_value": 231.41
        }
    ],
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  },
  "form": {
    "date_start": "01/05/2017",
    "date_end": "07/06/2018",
    "status": "cancelled",
    "action": "bulk_download"
  }
});

Respuesta de descarga masiva o de metadata exitosa:

{
    "emitted": [
        {
            "request_id": "50AD2BA1-27AE-4CC3-84FD-265E585A1F67"
        },
        {
            "request_id": "A6326A6B-68D0-4580-9FAD-A22F987FE43E"
        }
    ],
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "emitted": [
        {
            "pdf_url": "/pdf/655ea3b7d0ec5fa1914aca7809e72449.pdf"
        }
    ],
    "status": "success"
}

Respuesta de listado de facturas:

{
    "emitted": [
        {
            "certification_date": "2018-08-29T20:50:04",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-29T20:50:03",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "DDAA8B0B-4FDC-43D7-A633-F307B898AB3C",
            "receiver_reason": "Jane Doe",
            "receiver_rfc": "ZXYW740519633",
            "status": "valid",
            "total_value": 174.36
        },
        {
            "certification_date": "2018-08-30T09:43:55",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-08-30T09:43:55",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD90408BJ2",
            "id": "EB758D6A-07F5-4947-ACD5-98BF0B61654F",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ASD030224ES6",
            "status": "valid",
            "total_value": 106.22
        },
        {
            "certification_date": "2018-06-12T05:34:19",
            "certification_pac": "FIN1203015JA",
            "effect": "Ingreso",
            "emitted_date": "2018-06-12T05:34:19",
            "emitter_reason": "John Doe",
            "emitter_rfc": "ABCD790408BJ2",
            "id": "FB8C12A1-DA2C-47B0-B2FF-F10A718DB673",
            "receiver_reason": "Company Name",
            "receiver_rfc": "ZXC050315240",
            "status": "cancelled",
            "total_value": 231.41
        }
    ],
    "status": "success"
}

Descarga individual de XML de Facturas Emitidas

Endpoint: GET /cfdi/emitted/{id}/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

id

Folio fiscal. Retornado como campo id al listar facturas.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Descarga individual de XML de Facturas Emitidas

GET /cfdi/emitted/{id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/{id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/{id}/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/emitted/{id}/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}

Descarga de Facturas Recibidas

Endpoint: GET /cfdi/received/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

year

Año de emisión.

month

Mes de emisión.

status
  • cancelledd cancelado

  • valid vigente

  • any cualquier estado

action
  • bulk_download descarga masiva

  • metadata_download descarga de metadata

  • pdf_export exportar resultados a pdf

  • list lista las facturas encontradas

type
Tipo de comprobante.
Este campo es opcional.
- recepcion_pagos

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Descarga de Facturas Recibidas

GET /cfdi/received/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

year=2018&month=1&status=valid&action=pdf_export

Respuesta de descarga masiva o de metadata exitosa:

{
    "received": {
        "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948"
    },
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "received": {
        "pdf_url": "/pdf/5e0039b00fe101d11114576c2acc2a1b.pdf"
    },
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/received/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8" -d "year=2018&month=1&status=valid&action=pdf_export" -H "X-API-Key: <API KEY>"

Respuesta de descarga masiva o de metadata exitosa:

{
    "received": {
        "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948"
    },
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "received": {
        "pdf_url": "/pdf/5e0039b00fe101d11114576c2acc2a1b.pdf"
    },
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/received/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, data={
    'year': '2018',
    'month': '1',
    'status': 'valid',
    'action': 'pdf_export',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta de descarga masiva o de metadata exitosa:

{
    "received": {
        "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948"
    },
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "received": {
        "pdf_url": "/pdf/5e0039b00fe101d11114576c2acc2a1b.pdf"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/received/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  },
  "form": {
    "year": "2018",
    "month": "1",
    "status": "valid",
    "action": "pdf_export"
  }
});

Respuesta de descarga masiva o de metadata exitosa:

{
    "received": {
        "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948"
    },
    "status": "success"
}

Respuesta de exportación de PDF exitosa:

{
    "received": {
        "pdf_url": "/pdf/5e0039b00fe101d11114576c2acc2a1b.pdf"
    },
    "status": "success"
}

Descarga individual de XML de Facturas Recibidas

Endpoint: GET /cfdi/received/{id}/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

id

Folio fiscal, retornado como campo id al listar facturas.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Descarga individual de XML de Facturas Emitidas

GET /cfdi/received/{id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/received/{id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/received/{id}/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/received/{id}/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "download": {
        "download_url": "/download/4f3882b1d413f761ced91b6bd583f6ee.xml"
    },
    "status": "success"
}

Listar Descargas de CFDI disponibles

Endpoint: GET /cfdi/download/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Listar Descargas de CFDI disponibles

GET /cfdi/download/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "downloads": [
        {
            "count": 2,
            "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948",
            "type": "CFDI"
        },
        {
            "count": 73,
            "request_id": "4B7659B0-1EEA-4200-BC26-F6826E6189B1",
            "type": "Metadata"
        }
    ],
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/download/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "downloads": [
        {
            "count": 2,
            "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948",
            "type": "CFDI"
        },
        {
            "count": 73,
            "request_id": "4B7659B0-1EEA-4200-BC26-F6826E6189B1",
            "type": "Metadata"
        }
    ],
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/download/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "downloads": [
        {
            "count": 2,
            "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948",
            "type": "CFDI"
        },
        {
            "count": 73,
            "request_id": "4B7659B0-1EEA-4200-BC26-F6826E6189B1",
            "type": "Metadata"
        }
    ],
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/download/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "downloads": [
        {
            "count": 2,
            "request_id": "CAF80916-71AC-4CEA-BECF-F2AC3F394948",
            "type": "CFDI"
        },
        {
            "count": 73,
            "request_id": "4B7659B0-1EEA-4200-BC26-F6826E6189B1",
            "type": "Metadata"
        }
    ],
    "status": "success"
}

Obtener Descarga de CFDI

Endpoint: GET /cfdi/download/{request_id}/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

request_id

id de la petición, retornado cuando se genera o listan las descargas.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Listar Descargas de CFDI disponibles

GET /cfdi/download/{request_id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "download": {
        "download_url": "/download/e0ed6ded7505571251123d379f7b5f00.zip"
    },
    "status": "success"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/cfdi/download/{request_id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "download": {
        "download_url": "/download/e0ed6ded7505571251123d379f7b5f00.zip"
    },
    "status": "success"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/cfdi/download/{request_id}/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "download": {
        "download_url": "/download/e0ed6ded7505571251123d379f7b5f00.zip"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/cfdi/download/{request_id}/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "download": {
        "download_url": "/download/e0ed6ded7505571251123d379f7b5f00.zip"
    },
    "status": "success"
}

Listar Acuses

Endpoint: GET /ccee/acknowledgment/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

year

Año.

month_start

Mes inicial.

month_end

Mes fin.

motive
  • all todos

  • af acto de fiscalización

  • de devolución

  • co compensación

  • fc fiscalización compulsa

  • monthly envío mensual

document_type
  • all todos

  • ct catálogos de cuentas

  • b balanzas de comprobación

  • pl pólizas de periodo

  • xf auxiliares de folios

  • xc auxiliares de cuentas

status
  • all todos

  • received recibidos

  • accepted aceptados

  • rejected rechazados

send_type
  • all todos

  • n normal

  • c complementaria

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Listar Acuses

GET /ccee/acknowledgment/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

year=2019&month_start=1&month_end=6&motive=all&document_type=all&status=all&send_type=all

Respuesta:

{
    "results": [
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201801BN.zip",
            "id": "0002180100000000325368",
            "motive": "Envío Mensual",
            "period": "2018-01",
            "reception_date": "15/05/2019 12:10:02",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201802BN.zip",
            "id": "0002180200000000313193",
            "motive": "Envío Mensual",
            "period": "2018-02",
            "reception_date": "15/05/2019 12:10:41",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201803BN.zip",
            "id": "0002180300000000303749",
            "motive": "Envío Mensual",
            "period": "2018-03",
            "reception_date": "15/05/2019 12:31:45",
            "send_type": "Normal",
            "status": "Aceptado"
        },
    ]
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8" -d "year=2019&month_start=1&month_end=6&motive=all&document_type=all&status=all&send_type=all" -H "X-API-Key: <API KEY>"

Respuesta:

{
    "results": [
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201801BN.zip",
            "id": "0002180100000000325368",
            "motive": "Envío Mensual",
            "period": "2018-01",
            "reception_date": "15/05/2019 12:10:02",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201802BN.zip",
            "id": "0002180200000000313193",
            "motive": "Envío Mensual",
            "period": "2018-02",
            "reception_date": "15/05/2019 12:10:41",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201803BN.zip",
            "id": "0002180300000000303749",
            "motive": "Envío Mensual",
            "period": "2018-03",
            "reception_date": "15/05/2019 12:31:45",
            "send_type": "Normal",
            "status": "Aceptado"
        },
    ]
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, data={
    'year': '2019',
    'month_start': '1',
    'month_end': '6',
    'motive': 'all',
    'document_type': 'all',
    'status': 'all',
    'send_type': 'all',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "results": [
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201801BN.zip",
            "id": "0002180100000000325368",
            "motive": "Envío Mensual",
            "period": "2018-01",
            "reception_date": "15/05/2019 12:10:02",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201802BN.zip",
            "id": "0002180200000000313193",
            "motive": "Envío Mensual",
            "period": "2018-02",
            "reception_date": "15/05/2019 12:10:41",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201803BN.zip",
            "id": "0002180300000000303749",
            "motive": "Envío Mensual",
            "period": "2018-03",
            "reception_date": "15/05/2019 12:31:45",
            "send_type": "Normal",
            "status": "Aceptado"
        },
    ]
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  },
  "form": {
    "year": "2019",
    "month_start": "1",
    "month_end": "6",
    "motive": "all",
    "document_type": "all",
    "status": "all",
    "send_type": "all"
  }
});

Respuesta:

{
    "results": [
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201801BN.zip",
            "id": "0002180100000000325368",
            "motive": "Envío Mensual",
            "period": "2018-01",
            "reception_date": "15/05/2019 12:10:02",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201802BN.zip",
            "id": "0002180200000000313193",
            "motive": "Envío Mensual",
            "period": "2018-02",
            "reception_date": "15/05/2019 12:10:41",
            "send_type": "Normal",
            "status": "Aceptado"
        },
        {
            "document_type": "Balanzas de Comprobación",
            "file_name": "MOP1010266D3201803BN.zip",
            "id": "0002180300000000303749",
            "motive": "Envío Mensual",
            "period": "2018-03",
            "reception_date": "15/05/2019 12:31:45",
            "send_type": "Normal",
            "status": "Aceptado"
        },
    ]
}

Descargar Acuse

Endpoint: GET /ccee/acknowledgment/{document_id}/

Parámetros Descripción
session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

id

id Id del acuse. Retornado en el lsitado de acuses.

Respuesta:

Status Descripción
status
  • success la informacion ha sido accedida correctamente.

  • error la sesión o la key es inválida.

Descargar Acuse

GET /ccee/acknowledgment/{document_id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8 HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

Respuesta:

{
    "download": {
        "download_url": "/download/45d0ba8dcc406001fb977a265ada6ac4.zip"
    },
    "status": "success"
}

Acuse no encontrado:

{
    "message": "Not found",
    "status": "not_found"
}
curl -X GET "https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/{document_id}/?session_key=4d16be85-554e-4d26-a74d-cd1a3c0f93b8"  -H "X-API-Key: <API KEY>"

Respuesta:

{
    "download": {
        "download_url": "/download/45d0ba8dcc406001fb977a265ada6ac4.zip"
    },
    "status": "success"
}

Acuse no encontrado:

{
    "message": "Not found",
    "status": "not_found"
}
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/{document_id}/', params={
    'session_key': '4d16be85-554e-4d26-a74d-cd1a3c0f93b8',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
    "download": {
        "download_url": "/download/45d0ba8dcc406001fb977a265ada6ac4.zip"
    },
    "status": "success"
}

Acuse no encontrado:

{
    "message": "Not found",
    "status": "not_found"
}
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/ccee/acknowledgment/{document_id}/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "session_key": "4d16be85-554e-4d26-a74d-cd1a3c0f93b8"
  }
});

Respuesta:

{
    "download": {
        "download_url": "/download/45d0ba8dcc406001fb977a265ada6ac4.zip"
    },
    "status": "success"
}

Acuse no encontrado:

{
    "message": "Not found",
    "status": "not_found"
}