Reglas de descarga masiva

Las reglas de descarga masiva son un registro que funciona como plantilla para crear solicitudes de descarga CFDI o metadatos del SAT. Una regla de descarga contiene los datos repetitivos de una solicitud, por ejemplo la persona solicitante (RFC solicitante), la FIEL del solicitante, el tipo y estado de documentos a descargar, el tipo de descarga, etc. La regla se crea una sola vez y se reutiliza para crear múltiples solicitudes de descarga.

Modelo regla de descarga

El modelo regla de descarga contiene toda la información sobre una regla de descarga.

Properties

Name
id
Type
string?
Description
Id de la regla de descarga asignado por Fiscalapi.
Name
description
Type
string?
Description
Descripción o nombre de la regla de descarga.
Name
personId
Type
string?
expandible
Description
Id de la persona asociada a la regla de descarga. Vea emisores o receptores para entender el modelo de persona.
Name
tin
Type
string?
Description
RFC de la persona asociada a la regla de descarga.
Name
downloadRuleStatusId
Type
string?
expandible
Description
Id del estado de la regla de descarga.
Type
enum:
Values
"-1""1""2"
Name
satQueryTypeId
Type
string?
expandible
Description
Id del tipo de consulta asociado a la regla de descarga.
Type
enum:
Values
"CFDI""Metadata"
Name
downloadTypeId
Type
string?
expandible
Description
Id del tipo de descarga asociado a la regla de descarga.
Type
enum:
Values
"Emitidos""Recibidos"
Name
satInvoiceStatusId
Type
string?
expandible
Description
Id del estado asociado a las facturas de la que se descargará por la regla.
Type
enum:
Values
"Cancelado""Vigente"

GETdownload-rules

Listar reglas

Este endpoint devuelve una lista paginada de reglas de descarga. De forma predeterminada, se muestran diez reglas de descarga por página, pero puedes ajustar esto con los parámetros de consulta.

Query parameters

Name
pageNumber
Type
integer | number
required
Description
El número de página que se desea recuperar.
Default:
1
Name
pageSize
Type
integer | number
required
Description
Valor entre 1 y 50 inclusivo para indicar la cantidad de registros devueltos por página.
Default:
10

Request

GET

/api/v4/download-rules?pageNumber=1&pageSize=2

curl --location 'https://test.fiscalapi.com/api/v4/download-rules?pageNumber=1&pageSize=2' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>'

Response

{
    "data": {
        "items": [
            {
                "person": {
                    "legalName": "KARLA FUENTE NOLASCO",
                    "capitalRegime": null,
                    "email": "karla@gmail.com",
                    "phoneNumber": null,
                    "validTo": "2025-07-06T15:26:06.906",
                    "twoFactorEnabled": false,
                    "stripeCustomerId": "cus_RXpxlJC2145W9I",
                    "satTaxRegimeId": "626",
                    "satTaxRegime": {
                        "id": "626",
                        "description": "Régimen Simplificado de Confianza",
                        "createdAt": "2024-08-10T15:46:30.373",
                        "updatedAt": null
                    },
                    "satCfdiUseId": "G03",
                    "satCfdiUse": {
                        "id": "G03",
                        "description": "Gastos en general.",
                        "createdAt": "2024-08-10T15:46:30.373",
                        "updatedAt": null
                    },
                    "userTypeId": "C",
                    "userType": {
                        "id": "C",
                        "description": "Cliente",
                        "createdAt": "2024-08-10T15:46:30.373",
                        "updatedAt": null
                    },
                    "tin": "FUNK671228PH6",
                    "zipCode": "01160",
                    "base64Photo": null,
                    "taxPassword": "12345678a",
                    "stripePaymentMethodId": null,
                    "stripePaymentMethod": null,
                    "availableBalance": 2,
                    "committedBalance": 0,
                    "subscriptionStatus": null,
                    "tenantId": "102e5f13-e114-41dd-bea7-507fce177281",
                    "id": "78d380fd-1b69-4e3c-8bc0-4f57737f7d5f",
                    "createdAt": "2025-01-07T15:26:06.906",
                    "updatedAt": "2025-07-09T15:14:42.597"
                },
                "tin": "FUNK671228PH6",
                "description": "Regla de prueba descarga XML.",
                "downloadRuleStatus": {
                    "description": "Aprobada",
                    "id": "2",
                    "createdAt": "2024-08-10T15:46:30.373",
                    "updatedAt": null
                },
                "satQueryType": {
                    "description": "Facturas",
                    "id": "CFDI",
                    "createdAt": "2024-08-10T15:46:30.373",
                    "updatedAt": null
                },
                "downloadType": {
                    "description": "Recibidos",
                    "id": "Recibidos",
                    "createdAt": "2024-08-10T15:46:30.373",
                    "updatedAt": null
                },
                "satInvoiceStatus": {
                    "description": "Vigente",
                    "id": "Vigente",
                    "createdAt": "2024-08-10T15:46:30.373",
                    "updatedAt": null
                },
                "isTest": true,
                "id": "99d42dca-a555-4e77-b036-379652a3976a",
                "createdAt": "2025-08-16T10:34:25.040",
                "updatedAt": "2025-08-16T10:34:25.040"
            }
        ],
        "pageNumber": 1,
        "totalPages": 1,
        "totalCount": 1,
        "hasPreviousPage": false,
        "hasNextPage": false
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

POST/api/v4/download-rules

Crear regla

Este endpoint le permite crear una nueva regla de descarga.

Modelo

Name
personId
Type
string
required
Description
Id de la persona asociada a la regla de descarga.
Name
description
Type
string
required
Description
Descripción o nombre de la regla de descarga.
Name
satQueryTypeId
Type
string
required
Description
Id del tipo de consulta asociado a la regla de descarga.
Type
enum:
Values
"CFDI""Metadata"
Name
downloadTypeId
Type
string
required
Description
Id del tipo de descarga asociado a la regla de descarga.
Type
enum:
Values
"Emitidos""Recibidos"
Name
satInvoiceStatusId
Type
string
required
Description
Id del estado asociado a las facturas de la que se descargará por la regla.
Type
enum:
Values
"Cancelado""Vigente"

Request

POST

/api/v4/download-rules

curl --location 'https://test.fiscalapi.com/api/v4/download-rules' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
  "personId": "b0c1cf6c-153a-464e-99df-5741f45d6695",
  "description": "Regla Regla Demo1",
  "satQueryTypeId": "CFDI",
  "downloadTypeId": "Recibidos",
  "satInvoiceStatusId": "Vigente"
}'

Response

{
    "data": {
        "person": null,
        "tin": "FUNK671228PH6",
        "description": "Regla Regla Demo1",
        "downloadRuleStatus": null,
        "satQueryType": null,
        "downloadType": null,
        "satInvoiceStatus": null,
        "isTest": false,
        "id": "a376039a-58b7-46a1-b2de-8282938c9d7d",
        "createdAt": "2025-08-14T19:14:25.239",
        "updatedAt": "2025-08-14T19:14:25.239"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

GET/api/v4/download-rules/<id>

Obtener regla por ID

Este endpoint te permite obtener una regla de descarga por su ID.

Request

GET

/api/v4/download-rules/<id>

curl --location 'https://test.fiscalapi.com/api/v4/download-rules/2c6aafcf-8cd2-4fb1-94a8-687adc671380' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>'

Response

{
    "data": {
        "person": {
            "legalName": "KARLA FUENTE NOLASCO",
            "capitalRegime": null,
            "email": "karla@gmail.com",
            "phoneNumber": null,
            "validTo": "2025-07-06T15:26:06.906",
            "twoFactorEnabled": false,
            "stripeCustomerId": "cus_RXpxlJC2145W9I",
            "satTaxRegimeId": "626",
            "satTaxRegime": null,
            "satCfdiUseId": "G03",
            "satCfdiUse": null,
            "userTypeId": "C",
            "userType": null,
            "tin": "FUNK671228PH6",
            "zipCode": "01160",
            "base64Photo": null,
            "taxPassword": "12345678a",
            "stripePaymentMethodId": null,
            "stripePaymentMethod": null,
            "availableBalance": 2,
            "committedBalance": 0,
            "subscriptionStatus": null,
            "tenantId": "102e5f13-e114-41dd-bea7-507fce177281",
            "id": "78d380fd-1b69-4e3c-8bc0-4f57737f7d5f",
            "createdAt": "2025-01-07T15:26:06.906",
            "updatedAt": "2025-07-09T15:14:42.597"
        },
        "tin": "FUNK671228PH6",
        "description": "Regla de prueba descarga XML.",
        "downloadRuleStatus": {
            "description": "Aprobada",
            "id": "2",
            "createdAt": "2024-08-10T15:46:30.373",
            "updatedAt": null
        },
        "satQueryType": {
            "description": "Facturas",
            "id": "CFDI",
            "createdAt": "2024-08-10T15:46:30.373",
            "updatedAt": null
        },
        "downloadType": {
            "description": "Recibidos",
            "id": "Recibidos",
            "createdAt": "2024-08-10T15:46:30.373",
            "updatedAt": null
        },
        "satInvoiceStatus": {
            "description": "Vigente",
            "id": "Vigente",
            "createdAt": "2024-08-10T15:46:30.373",
            "updatedAt": null
        },
        "isTest": true,
        "id": "3a14c528-8315-4d47-a9ef-65aca7c0a95e",
        "createdAt": "2025-08-14T17:52:41.192",
        "updatedAt": "2025-08-14T17:52:41.192"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

PUT/api/v4/download-rules/<id>

Actualizar regla

Este endpoint te permite actualizar una regla de descarga.

Modelo

Name
id
Type
string
required
Description
Id de la regla de descarga asignado por Fiscalapi.
Name
description
Type
string
required
Description
Descripción o nombre de la regla de descarga.

Request

PUT

/api/v4/download-rules/<id>

curl --location --request PUT 'http://localhost:5001/api/v4/download-rules/8d5905f3-d7e1-46b7-b0f4-9f3a2528bb56' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
  "id": "8d5905f3-d7e1-46b7-b0f4-9f3a2528bb56",
  "description": "REGLA DESCARGA CFDI KARLA FUENTES"
}'

Response

{
    "data": {
        "person": null,
        "tin": "FUNK671228PH6",
        "description": "REGLA DESCARGA CFDI KARLA FUENTES",
        "downloadRuleStatus": null,
        "satQueryType": null,
        "downloadType": null,
        "satInvoiceStatus": null,
        "isTest": true,
        "id": "8d5905f3-d7e1-46b7-b0f4-9f3a2528bb56",
        "createdAt": "2025-08-15T17:09:20.359",
        "updatedAt": "2025-08-15T17:19:52.886"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

DELETE/api/v4/download-rules/<id>

Eliminar regla

Este endpoint te permite eliminar una regla de descarga por su ID.

Request

DELETE

/api/v4/download-rules/<id>

curl --location --request DELETE 'https://test.fiscalapi.com/api/v4/download-rules/5d2dfd35-9e1c-4263-973e-5121aef74087' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>'

Response

{
    "data": true,
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}