Saltar a contenido

Referencia

  • https://api.csfacturacion.com/buzon-tributario

API REST application/json

Credenciales de contratación vigente mediante Http Basic

Documentos

Solicitar la descarga de los siguientes documentos desde el Buzón Tributario:

  • Constancia De Situación Fiscal (CSF)
  • Opinión De Cumplimiento (32D)

Constancia De Situación Fiscal

/buzon-tributario/csf Solicita la Descarga de la CSF

Petición

Tipo

application/json

Cuerpo

Campo Descripción Tipo
rfc* RFC de autenticación ante el SAT String
ciec* CIEC de autenticación ante el SAT String
webhook Recurso HTTP donde se notificará el resultado de la solicitud String (URL)

Ejemplo
POST /buzon-tributario/csf HTTP/1.1
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com
Content-Length: 47

{
    "rfc": "AAA010101AAA",
    "ciec": "CIEC"
}

Response

200 OK

application/json

Ejemplo
{
    "id": "69a8ab74-6bb4-441c-9e4a-e241d658c364"
}
422 Datos Inválidos

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Please check your input",
        "details": [
            {
                "message": "This value should not be blank.",
                "field": "[ciec]"
            }
        ]
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
401 Sin Credenciales

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Provide a supported auth schema",
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
/buzon-tributario/csf/{id} Detalle de CSF

Query String

Parámetro Descripción
id Identificador Único del Documento

Ejemplo
GET /buzon-tributario/csf/d8fb74b0-789a-4d3e-959b-0f17eb67860b HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 OK

application/json

Ejemplo
{
    "id": "d8fb74b0-789a-4d3e-959b-0f17eb67860b",
    "rfc": "AAA010101AAA",
    "created_at": "2023-05-07 16:33:11",
    "pdf": "{BASE64_CONTENT}"
}
404 Documento no existente

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "The Entity was not found"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
/buzon-tributario/csf Listado de CSF

Query String

Parámetro Descripción
rfc Filtar mediante clave RFC
created_at Filtar mediante fecha de descarga
page Número de página a consultar (paginado)
limit Número de elementos por página

Ejemplo
GET /buzon-tributario/csf?rfc=BBB010101BBB HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 OK

application/json

Ejemplo
{
    "data": [
        {
            "id": "1540ba76-073e-40f9-89a1-7a19b79e45f7",
            "rfc": "BBB010101BBB",
            "created_at": "2023-06-08 14:20:53"
        }
    ],
    "page": 1,
    "per_page": 10,
    "page_count": 1,
    "total_count": 1
}

Opinión De Cumplimiento

/buzon-tributario/c32d Solicita la Descarga de la Opinión De Cumplimiento

Petición

Tipo

application/json

Cuerpo

Campo Descripción Tipo
rfc* RFC de autenticación ante el SAT String
ciec* CIEC de autenticación ante el SAT String
webhook Recurso HTTP donde se notificará el resultado de la solicitud String (URL)

Ejemplo
POST /buzon-tributario/c32d HTTP/1.1
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com
Content-Length: 47

{
    "rfc": "AAA010101AAA",
    "ciec": "CIEC"
}

Response

200 OK

application/json

Ejemplo
{
    "id": "69a8ab74-6bb4-441c-9e4a-e241d658c364"
}
422 Datos Inválidos

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Please check your input",
        "details": [
            {
                "message": "This value should not be blank.",
                "field": "[ciec]"
            }
        ]
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
401 Sin Credenciales

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Provide a supported auth schema",
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
/buzon-tributario/c32d/{id} Detalle de Opinión De Cumplimiento

Parámetros

Parámetro Descripción
id Identificador Único del Documento

Ejemplo
GET /buzon-tributario/c32d/d8fb74b0-789a-4d3e-959b-0f17eb67860b HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 OK

application/json

Ejemplo
{
    "id": "d8fb74b0-789a-4d3e-959b-0f17eb67860b",
    "rfc": "AAA010101AAA",
    "created_at": "2023-05-07 16:33:11",
    "pdf": "{BASE64_CONTENT}"
}
404 Documento no existente

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "The Entity was not found"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
/buzon-tributario/c32d Listado De Opinión De Cumplimiento

Query String

Parámetro Descripción
rfc Filtar mediante clave RFC
created_at Filtar mediante fecha de descarga
page Número de página a consultar (paginado)
limit Número de elementos por página

Ejemplo
GET /buzon-tributario/c32d?rfc=BBB010101BBB HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 OK

application/json

Ejemplo
{
    "data": [
        {
            "id": "1540ba76-073e-40f9-89a1-7a19b79e45f7",
            "rfc": "BBB010101BBB",
            "created_at": "2023-06-08 14:20:53"
        }
    ],
    "page": 1,
    "per_page": 10,
    "page_count": 1,
    "total_count": 1
}

Webhook

Campo Descripción Tipo
query_id Identificador único de la solicitud String (UUID)
document_id Identificador único del documento String (UUID)
rfc Clave RFC del documento String
document Contenido del documento (PDF) codificado en base64 String (Base64Binary)
success Indica si el documento fue obtenido satisfactoriamente Bool
status Estatus de la solicitud String
metadata Valores establecidos por el cliente en la solicitud Object / Null
EXITO

application/json

Ejemplo
{
    "query_id": "22132816-6e27-42b7-a4b5-08e3c596e009",
    "document_id": "52d4d365-da97-469a-84d5-2b9638f54fa9",
    "rfc": "AAA010101AAA",
    "document": "{BASE64_CONTENT}",
    "success": true,
    "status": "EXITO",
    "metadata": {
        "foo": "bar"
    }
}
ERROR_AUTENTICACION

application/json

Ejemplo
{
    "query_id": "22132816-6e27-42b7-a4b5-08e3c596e009",
    "rfc": "AAA010101AAA",
    "success": false,
    "status": "ERROR_AUTENTICACION",
    "metadata": {
        "foo": "bar"
    }
}

Solicitudes (Queries)

/buzon-tributario/queries/{id} Detalle de Solicitud

Parámetros

Parámetro Descripción
id Identificador Único de la solicitud

Ejemplo
GET /buzon-tributario/queries/2f599ae7-455e-43e7-86fb-1d903e9a8f1b HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 EXITO

application/json

Ejemplo
{
    "id": "2f599ae7-455e-43e7-86fb-1d903e9a8f1b",
    "status": "EXITO",
    "created_at": "2023-06-06 17:35:31",
    "document_type": "CSF",
    "document": {
        "id": "c3a28b6a-45f4-466e-8816-8a9ac9ae4f3d",
        "rfc": "AAA010101AAA",
        "created_at": "2023-06-06 17:37:04"
    }
}
200 EN_PROCESO

application/json

Ejemplo
{
    "id": "2f599ae7-455e-43e7-86fb-1d903e9a8f1b",
    "status": "EN_PROCESO",
    "created_at": "2023-06-06 17:35:31",
    "document_type": "CSF",
    "document": null
}
404 Solicitud no existente

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "The Entity was not found"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
/buzon-tributario/queries Listado De Solicitudes

Query String

Parámetro Descripción Notas
rfc Filtrar mediante clave RFC
status Filtrar mediante estatus de solicitud
documentType Filtrar mediante tipo de documento C32D, CSF
page Número de página a consultar (paginado)
limit Número de elementos por página

Ejemplo
GET /buzon-tributario/queries?rfc=BBB010101BBB HTTP/1.1
Accept: application/json
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com

Respuesta

200 OK

application/json

Ejemplo
{
    "data": [
        {
            "id": 14,
            "status": "EXITO",
            "created_at": "2023-05-30 12:20:07",
            "document_type": "C32D",
            "document": {
                "id": 6,
                "rfc": "BBB010101BBB",
                "created_at": "2023-05-30 12:20:36"
            }
        }
    ],
    "page": 1,
    "per_page": 10,
    "page_count": 1,
    "total_count": 1
}

Tramites

No se realizan tramites actualmente.