Catálogos de descarga masiva
El Servicio de Administración Tributaria (SAT) proporciona un conjunto de catálogos estandar para la descarga masiva de CFDI o Metadatos en México. Estos catálogos contienen codigos y descripciones que se utilizan de manera obligatoria en la descarga masiva de CFDI o Metadatos.
Tip: Revise la introducción al módulo para familiarizarse con los conceptos de descarga masiva.
Catálogos disponibles
Fiscalapi proporciona acceso a todos los catálogos oficiales de descarga masiva através del recurso /api/v4/download-catalogs.
| Catálogo | Descripción |
|---|---|
| SatInvoiceTypes | Tipos de CFDI disponibles, como Ingreso, Egreso, Nómina, entre otros. |
| SatInvoiceComplements | Complementos de CFDI disponibles, como Pagos, Nómina, Impuestos locales, etc. |
| SatInvoiceStatuses | Estados del CFDI disponibles, como Vigente y Cancelado. |
| SatQueryTypes | Tipos de consultas de CFDI disponibles, como Facturas y Metadatos. |
| SatRequestStatuses | Estados de las solicitudes de descarga del SAT, como Aceptada y En proceso. |
| SatStatuses | Estados globales de la solicitud de descarga, como XML mal formado o Sello mal formado. |
| DownloadTypes | Tipos de descarga disponibles, como Emitidos o Recibidos. |
| DownloadRequestTypes | Tipos de solicitud de descarga, como Automática o Manual |
| DownloadRequestStatuses | Estados de Fiscalapi para las solicitudes de descarga, como Esperando SAT o Esperando API |
| DownloadRuleStatuses | Estados de Fiscalapi para las reglas de descarga, como Pendiente, Aprobada o Rechazada. |
Modelo CatalogDto
El modelo CatalogDto representa un registro de un catálogo del SAT y es el modelo de estandar en fiscalapi para representar los registros de los catálogos. Este recurso sirve catalogos de descarga masiva por lo cual las respuestas son objetos CatalogDto.
Propiedades
- Name
id- Type
- string?
- Description
Codigo único del registro en el catálogo.
- Name
description- Type
- string?
- Description
Descripción del registro en el catálogo.
Listar catálogos
Este endpoint devuelve una lista no paginada de los catálogos disponibles.
Estos nombres de catálogo se utilizan para listar los registros de un catálogo en particular via: /api/v4/download-catalogs/<catalogName>.
Request
curl --location 'https://test.fiscalapi.com/api/v4/download-catalogs' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
Response
{
"data": [
"SatInvoiceTypes",
"SatInvoiceComplements",
"SatInvoiceStatuses",
"SatQueryTypes",
"SatRequestStatuses",
"SatStatuses",
"DownloadTypes",
"DownloadRequestTypes",
"DownloadRequestStatuses",
"DownloadRuleStatuses"
],
"succeeded": true,
"message": "",
"details": "",
"httpStatusCode": 200
}
Listar catálogo
Este endpoint permite listar los registros de un catálogo específico pasando el nombre del catálogo como parámetro.
Un nombre de catálogo que no existe responde 404 con details No existe el catálogo '<catalogName>'. (el nombre distingue mayúsculas y minúsculas; los válidos son los de GET /api/v4/download-catalogs).
Request
curl --location 'https://test.fiscalapi.com/api/v4/download-catalogs/SatInvoiceTypes' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
Response
{
"data": [
{
"description": "Todos",
"id": "",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
},
{
"description": "Egreso",
"id": "E",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
},
{
"description": "Ingreso",
"id": "I",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
},
{
"description": "Nomina",
"id": "N",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
},
{
"description": "Pago",
"id": "P",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
},
{
"description": "Traslado",
"id": "T",
"createdAt": "2024-08-10T15:46:30.373",
"updatedAt": null
}
],
"succeeded": true,
"message": "",
"details": "",
"httpStatusCode": 200
}