FiscalAPI

https://docs.fiscalapi.com/
Admin
FiscalAPI is a modern, robust RESTful API platform for issuing CFDI 4.0 digital tax invoices in...
Tokens:41,175
Snippets:267
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /api/v4/download-requests

Source: https://docs.fiscalapi.com/download-requests

Obtiene una lista de las solicitudes de descarga registradas.

```APIDOC
## GET /api/v4/download-requests

### Description
Obtiene una lista de las solicitudes de descarga de CFDI o metadatos registradas en el sistema.

### Method
GET

### Endpoint
/api/v4/download-requests
```

--------------------------------

### Obtener solicitud por ID con cURL

Source: https://docs.fiscalapi.com/download-requests

Realiza una petición GET para obtener la información de una solicitud de descarga específica.

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

--------------------------------

### Obtener datos de empleado mediante cURL

Source: https://docs.fiscalapi.com/employee-data

Realiza una solicitud GET al endpoint de empleados incluyendo las cabeceras de autenticación y configuración necesarias.

```bash
curl --location 'https://test.fiscalapi.com/api/v4/people/<personId>/employee' \
--header 'X-TENANT-KEY: <tenant_key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api_key>'
```

--------------------------------

### Listar movimientos con cURL

Source: https://docs.fiscalapi.com/stamps

Ejemplo de solicitud GET para obtener una lista paginada de movimientos utilizando cURL.

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

--------------------------------

### Listar meta-items con cURL

Source: https://docs.fiscalapi.com/download-requests

Realiza una solicitud GET para obtener los metadatos de una solicitud de descarga específica. Requiere los encabezados de autenticación y configuración de zona horaria.

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

--------------------------------

### Obtener XMLs por ID mediante cURL

Source: https://docs.fiscalapi.com/download-requests

Realiza una solicitud GET al endpoint de descarga utilizando los encabezados de autenticación requeridos.

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

--------------------------------

### Obtener movimiento de timbres por ID

Source: https://docs.fiscalapi.com/stamps

Realiza una petición GET para recuperar los detalles de un movimiento específico. Requiere las cabeceras de autenticación X-TENANT-KEY y X-API-KEY.

```cURL
curl --location 'https://test.fiscalapi.com/api/v4/stamps/77678d6d-94b1-4635-aa91-15cdd7423aab' \
--header 'X-TENANT-KEY: <tenant>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api_key>' \
--data ''
```

--------------------------------

### Consultar solicitudes de descarga vía cURL

Source: https://docs.fiscalapi.com/download-requests

Ejemplo de solicitud GET para listar solicitudes de descarga incluyendo encabezados de autenticación y configuración de zona horaria.

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

--------------------------------

### Employee Data Response Structure

Source: https://docs.fiscalapi.com/employee-data

Example of a successful JSON response returned by the employee data endpoint.

```json
{
    "data": {
        "personId": "bef56254-0892-4558-95c3-f9c8729e4b0e",
        "employerRegistration": "B5510768108",
        "originEmployerTin": "URE180429TM6",
        "satFundSource": null,
        "ownResourceAmount": null,
        "id": "23f0b555-68bc-48fd-bb90-deb36ed25ef6",
        "createdAt": "2025-09-18T20:17:44.175",
        "updatedAt": "2025-09-18T20:17:44.175"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Raw Response JSON Structure

Source: https://docs.fiscalapi.com/download-requests

Example of the JSON response body returned when successfully fetching a raw SAT file.

```json
{
    "data": {
        "base64File": "PHM6RW52ZWxvcGUgeG1sbnM6cz0iaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvc29hcC9lbnZlbG9wZS8iPjxzOkJvZHkgeG1sbnM6eHNpPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYS1pbnN0YW5jZSIgeG1sbnM6eHNkPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSI+PFZlcmlmaWNhU29saWNpdHVkRGVzY2FyZ2FSZXNwb25zZSB4bWxucz0iaHR0cDovL0Rlc2NhcmdhTWFzaXZhVGVyY2Vyb3Muc2F0LmdvYi5teCI+PFZlcmlmaWNhU29saWNpdHVkRGVzY2FyZ2FSZXN1bHQgQ29kRXN0YXR1cz0iNTAwMCIgRXN0YWRvU29saWNpdHVkPSIxIiBDb2RpZ29Fc3RhZG9Tb2xpY2l0dWQ9IjUwMDAiIE51bWVyb0NGRElzPSIwIiBNZW5zYWplPSJTb2xpY2l0dWQgQWNlcHRhZGEiLz48L1ZlcmlmaWNhU29saWNpdHVkRGVzY2FyZ2FSZXNwb25zZT48L3M6Qm9keT48L3M6RW52ZWxvcGU+",
        "fileName": "RawResponse_cd9959d1-3c6d-40d7-bf13-551b2265dded.xml",
        "fileExtension": ".xml"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Descargar paquete de facturas con cURL

Source: https://docs.fiscalapi.com/download-requests

Realiza una solicitud GET para descargar el paquete comprimido utilizando las cabeceras de autenticación y configuración requeridas.

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

--------------------------------

### GET /api/v4/stamps

Source: https://docs.fiscalapi.com/stamps

Retrieves a list of stamp transactions.

```APIDOC
## GET /api/v4/stamps

### Description
Retrieves a list of stamp transactions. The results can be queried individually or in a paginated format.

### Method
GET

### Endpoint
/api/v4/stamps

### Response
#### Success Response (200)
- **consecutive** (integer) - Folio consecutive of the movement.
- **fromPerson** (object) - The person sending the stamps.
- **toPerson** (object) - The person receiving the stamps.
- **amount** (integer) - Quantity of stamps involved.
- **transactionType** (integer) - Type of movement.
- **transactionStatus** (integer) - Status of the movement.
- **referenceId** (string) - Reference identifier.
- **comments** (string) - Transaction comments.
- **id** (string) - Unique identifier of the movement.
```

--------------------------------

### GET /api/v4/stamps

Source: https://docs.fiscalapi.com/stamps

Retrieves a paginated list of stamp movements.

```APIDOC
## GET /api/v4/stamps

### Description
This endpoint returns a paginated list of stamp movements. By default, ten movements are shown per page, but this can be adjusted using query parameters.

### Method
GET

### Endpoint
/api/v4/stamps

### Parameters
#### Query Parameters
- **pageNumber** (integer) - Optional - The page number to retrieve. Default: 1
- **pageSize** (integer) - Optional - The number of records per page (1-50). Default: 10

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

### Response
#### Success Response (200)
- **data** (object) - Contains the list of items and pagination metadata.
- **succeeded** (boolean) - Indicates if the request was successful.
- **httpStatusCode** (integer) - The HTTP status code.

#### Response Example
{
    "data": {
        "items": [
            {
                "consecutive": 11,
                "amount": 500,
                "id": "e22e17d1-48c5-49a5-af71-a56cae4bdd95"
            }
        ],
        "pageNumber": 1,
        "totalPages": 21,
        "totalCount": 207
    },
    "succeeded": true,
    "httpStatusCode": 200
}
```

--------------------------------

### Get API Key by ID

Source: https://docs.fiscalapi.com/api-keys

Retrieves a specific API key by its unique identifier.

```APIDOC
## GET /api/v4/apikeys/<id>

### Description
This endpoint allows you to retrieve an API key by its ID.

### Method
GET

### Endpoint
/api/v4/apikeys/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the API key to retrieve.

### Response
#### Success Response (200)
- **data** (object) - Contains the details of the API key.
  - **environment** (string) - The environment the API key belongs to.
  - **apiKeyValue** (string) - The API key value used for authentication.
  - **personId** (string) - The unique identifier of the person the API key belongs to.
  - **tenantId** (string) - The unique identifier of the tenant the API key belongs to.
  - **apiKeyStatus** (integer) - The status of the API key.
  - **description** (string) - The name or description of the API key.
  - **id** (string) - The unique identifier of the API key.
  - **createdAt** (string) - The date and time the API key was created.
  - **updatedAt** (string) - The date and time the API key was last updated.
- **succeeded** (boolean) - Indicates if the request was successful.
- **message** (string) - Any message associated with the response.
- **details** (string) - Additional details about the response.
- **httpStatusCode** (integer) - The HTTP status code of the response.

### Response Example
```json
{
    "data": {
        "environment": "Test",
        "apiKeyValue": "sk_test_...",
        "personId": "5fd9f48c-a6a2-474f-944b-88a01751d432",
        "tenantId": "102e5f13-e114-41dd-bea7-507fce177281",
        "apiKeyStatus": 0,
        "description": null,
        "id": "539d247f-6624-4086-86fc-170715af9fbd",
        "createdAt": "2025-01-07T15:24:22.1446925",
        "updatedAt": "2025-01-07T15:24:45.7387097"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```
```

--------------------------------

### List Available Catalogs (cURL)

Source: https://docs.fiscalapi.com/catalogs

Use this cURL command to retrieve a non-paginated list of all available catalogs. Ensure you include your tenant and API keys in the headers.

```curl
curl --location 'https://test.fiscalapi.com/api/v4/catalogs' \
--header 'X-TENANT-KEY: <tenant>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
```

--------------------------------

### GET /api/v4/download-requests/<id>/xmls

Source: https://docs.fiscalapi.com/download-requests

Retrieves the XMLs downloaded for a specific request by its ID.

```APIDOC
## GET /api/v4/download-requests/<id>/xmls

### Description
Este endpoint te permite obtener los xmls descargados de una solicitud por su Id.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>/xmls

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the download request.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of XML items.

#### Response Example
{
    "data": {
        "items": [
            {
                "downloadRequestId": "e9b2bf4b-9aa0-4be7-8ed6-63896979d137",
                "version": "4.0",
                "series": "F",
                "number": "FUNK671228PH6-90",
                "date": "2025-06-18T12:58:30.000",
                "total": 226.15,
                "currency": "MXN"
            }
        ]
    }
}
```

--------------------------------

### GET /api/v4/download-requests/<id>

Source: https://docs.fiscalapi.com/download-requests

Retrieves the details of a specific download request by its unique ID.

```APIDOC
## GET /api/v4/download-requests/<id>

### Description
This endpoint allows you to retrieve a download request by its ID.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the download request.

### Response
#### Success Response (200)
- **data** (object) - The download request details.
- **succeeded** (boolean) - Indicates if the request was successful.
- **message** (string) - Status message.
- **httpStatusCode** (integer) - The HTTP status code.

### Response Example
{
    "data": {
        "consecutive": 12,
        "satRequestId": "2f7713dd-030b-40e6-8e58-a449210ce496",
        "id": "e9b2bf4b-9aa0-4be7-8ed6-63896979d137"
    },
    "succeeded": true,
    "message": "",
    "httpStatusCode": 200
}
```

--------------------------------

### GET /api/v4/people/<personId>/employee

Source: https://docs.fiscalapi.com/employee-data

Retrieves the employee data associated with a specific person.

```APIDOC
## GET /api/v4/people/<personId>/employee

### Description
Retrieves the employee data associated with a specific person. This resource is required for payroll CFDI generation.

### Method
GET

### Endpoint
/api/v4/people/<personId>/employee

### Parameters
#### Path Parameters
- **personId** (string) - Required - The ID of the person to retrieve employee data for.
```

--------------------------------

### GET /api/v4/stamps/<id>

Source: https://docs.fiscalapi.com/stamps

Retrieves the details of a specific stamp movement using its unique identifier.

```APIDOC
## GET /api/v4/stamps/<id>

### Description
This endpoint allows you to retrieve a stamp movement by its ID.

### Method
GET

### Endpoint
/api/v4/stamps/<id>

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the stamp movement.

### Request Example
curl --location 'https://test.fiscalapi.com/api/v4/stamps/77678d6d-94b1-4635-aa91-15cdd7423aab' \
--header 'X-TENANT-KEY: <tenant>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api_key>'

### Response
#### Success Response (200)
- **data** (object) - The movement details.
- **succeeded** (boolean) - Indicates if the request was successful.
- **httpStatusCode** (integer) - The HTTP status code.
```

--------------------------------

### Descargar SAT request crudo vía cURL

Source: https://docs.fiscalapi.com/download-requests

Utiliza este comando para obtener el archivo XML de una solicitud específica. Requiere las cabeceras de autenticación X-TENANT-KEY y X-API-KEY.

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

--------------------------------

### GET /api/v4/download-requests/<id>/meta-items

Source: https://docs.fiscalapi.com/download-requests

Retrieves the metadata of invoices downloaded from a specific request by its ID.

```APIDOC
## GET /api/v4/download-requests/<id>/meta-items

### Description
This endpoint allows you to obtain the metadata of invoices downloaded from a request by its ID.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>/meta-items

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the download request.

### Response
#### Success Response (200)
- **data** (object) - Contains the list of invoice items and pagination details.
- **succeeded** (boolean) - Indicates if the request was successful.
- **message** (string) - Status message.
- **details** (string) - Additional details.
- **httpStatusCode** (integer) - The HTTP status code.

### Response Example
{
    "data": {
        "items": [
            {
                "invoiceUuid": "c8b8addd-e834-4f94-b410-31723018d7ea",
                "issuerTin": "FUNK671228PH6",
                "issuerName": "KARLA FUENTE NOLASCO",
                "recipientTin": "EKU9003173C9",
                "recipientName": "ESCUELA KEMPER URGATE",
                "pacTin": "PAC010203ABC",
                "invoiceDate": "2025-06-12T05:39:42.000",
                "satCertificationDate": "2025-08-15T12:24:27.000",
                "amount": 174,
                "invoiceType": "E",
                "status": 1,
                "cancellationDate": null,
                "downloadPackageId": null,
                "downloadRequestId": "71bdec41-fd18-4f1b-9e5e-2b9cdad9978f",
                "id": "19deb039-0150-47c9-8f16-975fe897d06c",
                "createdAt": "2025-08-15T12:24:27.562",
                "updatedAt": "2025-08-15T12:24:27.562"
            }
        ],
        "pageNumber": 1,
        "totalPages": 2,
        "totalCount": 3,
        "hasPreviousPage": false,
        "hasNextPage": false
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Realizar solicitud de retiro de timbres con cURL

Source: https://docs.fiscalapi.com/stamps

Ejecuta una solicitud POST al endpoint de timbres incluyendo los IDs de origen y destino, la cantidad y comentarios opcionales.

```bash
curl --location 'https://test.fiscalapi.com/api/v4/stamps' \
--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-raw '{
  "fromPersonId": "1",
  "toPersonId": "1a18f812-c623-448f-a222-9b7e4e3fd4b2",
  "amount": 99,
  "comments": "No se confirmó el pago..."
}'
```

--------------------------------

### GET /api/v4/download-requests/<id>/package

Source: https://docs.fiscalapi.com/download-requests

Downloads a ZIP package of invoices associated with a specific request ID.

```APIDOC
## GET /api/v4/download-requests/<id>/package

### Description
This endpoint allows you to download a package (ZIP file) of invoices associated with a specific request ID.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>/package

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the download request.

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

### Response
#### Success Response (200)
- **data** (array) - A list containing the file information.
- **base64File** (string) - The file content encoded in base64.
```

--------------------------------

### POST /api/v4/download-requests

Source: https://docs.fiscalapi.com/download-requests

Creates a new download request by providing the rule ID, request type, and the date range for the download.

```APIDOC
## POST /api/v4/download-requests

### Description
Este endpoint le permite crear una nueva solicitud de descarga.

### Method
POST

### Endpoint
/api/v4/download-requests

### Parameters
#### Request Body
- **downloadRuleId** (string) - Required - Id de la regla de descarga asociada a la solicitud.
- **downloadRequestTypeId** (string) - Required - Tipo de solicitud de descarga.
- **startDate** (string) - Required - Fecha de inicio del rango de descarga. (formato ISO 8601)
- **endDate** (string) - Required - Fecha de fin del rango de descarga. (formato ISO 8601)

### Request Example
{
  "downloadRuleId": "dc17ba67-05cd-4e8d-93c5-aeae0137b8c1",
  "downloadRequestTypeId": "Manual",
  "startDate": "2025-08-07T01:59:00.000Z",
  "endDate": "2025-08-15T01:59:00.000Z"
}

### Response
#### Success Response (200)
- **data** (object) - The created download request object.
- **succeeded** (boolean) - Indicates if the operation was successful.

#### Response Example
{
  "data": {
    "consecutive": 19,
    "satRequestId": "8846fbec-483a-4b47-b264-046b744690fc",
    "id": "672ddd02-bb4a-48ba-99ef-488c94b8da31",
    "createdAt": "2025-08-14T20:01:24.184"
  },
  "succeeded": true,
  "httpStatusCode": 200
}
```

--------------------------------

### GET /api/v4/download-requests/<id>/raw-request

Source: https://docs.fiscalapi.com/download-requests

Retrieves the raw SAT request file (XML) for a given request ID.

```APIDOC
## GET /api/v4/download-requests/<id>/raw-request

### Description
This endpoint allows you to download the raw SAT request (XML file) of a request by its ID. This file is useful for debugging the request.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>/raw-request

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the request.

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

### Response
#### Success Response (200)
- **data** (object) - Contains the file information.
- **base64File** (string) - The raw file content encoded in base64.
```

--------------------------------

### Get Catalog Items

Source: https://docs.fiscalapi.com/catalogs

Retrieves a list of items from a specific catalog based on a search term. Supports pagination and filtering.

```APIDOC
## GET /v4/catalogs/<catalogName>/<searchTerm>

### Description
Retrieves a list of items from a specific catalog based on a search term. Supports pagination and filtering.

### Method
GET

### Endpoint
/v4/catalogs/<catalogName>/<searchTerm>

### Query Parameters
- **pageNumber** (integer | number) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer | number) - Optional - The number of records to return per page. Value must be between 1 and 100 inclusive. Defaults to 50.

### Request Example
```curl
curl --location 'https://test.fiscalapi.com/api/v4/catalogs/SatPaymentForms/Tarjeta?pageNumber=1&pageSize=100' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
```

### Response
#### Success Response (200)
- **data** (object) - Contains the catalog items and pagination information.
  - **items** (array) - List of catalog items.
    - **id** (string) - The unique identifier of the item.
    - **description** (string) - The description of the item.
    - **createdAt** (string) - The date and time the item was created.
    - **updatedAt** (string | null) - The date and time the item was last updated.
  - **pageNumber** (integer) - The current page number.
  - **totalPages** (integer) - The total number of pages available.
  - **totalCount** (integer) - The total number of items across all pages.
  - **hasPreviousPage** (boolean) - Indicates if there is a previous page.
  - **hasNextPage** (boolean) - Indicates if there is a next page.
- **succeeded** (boolean) - Indicates if the request was successful.
- **message** (string) - Any messages related to the request.
- **details** (string) - Additional details about the request.
- **httpStatusCode** (integer) - The HTTP status code of the response.

#### Response Example
```json
{
    "data": {
        "items": [
            {
                "id": "04",
                "description": "Tarjeta de crédito",
                "createdAt": "0001-01-01T00:00:00.0000000",
                "updatedAt": null
            },
            {
                "id": "28",
                "description": "Tarjeta de débito",
                "createdAt": "0001-01-01T00:00:00.0000000",
                "updatedAt": null
            },
            {
                "id": "29",
                "description": "Tarjeta de servicios",
                "createdAt": "0001-01-01T00:00:00.0000000",
                "updatedAt": null
            }
        ],
        "pageNumber": 1,
        "totalPages": 1,
        "totalCount": 3,
        "hasPreviousPage": false,
        "hasNextPage": false
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```
```

--------------------------------

### Eliminar Certificado Fiscal por ID

Source: https://docs.fiscalapi.com/tax-files

Este endpoint te permite eliminar un certificado fiscal o llave privada utilizando su ID. Para eliminar completamente los archivos de una persona, se requieren dos peticiones de eliminación, una para el .cer y otra para el .key, ambas para el mismo personId.

```curl
curl --location --request DELETE 'https://test.fiscalapi.com/api/v4/tax-files/3e6a8d54-9255-4267-b617-ef848211b1bc' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>'
```

--------------------------------

### Respuesta de meta-items

Source: https://docs.fiscalapi.com/download-requests

Estructura de la respuesta JSON exitosa que contiene la lista de facturas y la información de paginación.

```json
{
    "data": {
        "items": [
            {
                "invoiceUuid": "c8b8addd-e834-4f94-b410-31723018d7ea",
                "issuerTin": "FUNK671228PH6",
                "issuerName": "KARLA FUENTE NOLASCO",
                "recipientTin": "EKU9003173C9",
                "recipientName": "ESCUELA KEMPER URGATE",
                "pacTin": "PAC010203ABC",
                "invoiceDate": "2025-06-12T05:39:42.000",
                "satCertificationDate": "2025-08-15T12:24:27.000",
                "amount": 174,
                "invoiceType": "E",
                "status": 1,
                "cancellationDate": null,
                "downloadPackageId": null,
                "downloadRequestId": "71bdec41-fd18-4f1b-9e5e-2b9cdad9978f",
                "id": "19deb039-0150-47c9-8f16-975fe897d06c",
                "createdAt": "2025-08-15T12:24:27.562",
                "updatedAt": "2025-08-15T12:24:27.562"
            },
            {
                "invoiceUuid": "6e98b006-4783-4712-a0bb-fef8f11c459a",
                "issuerTin": "FUNK671228PH6",
                "issuerName": "KARLA FUENTE NOLASCO",
                "recipientTin": "EKU9003173C9",
                "recipientName": "ESCUELA KEMPER URGATE",
                "pacTin": "PAC010203ABC",
                "invoiceDate": "2025-06-12T05:39:42.000",
                "satCertificationDate": "2025-08-15T12:24:27.000",
                "amount": 290.99,
                "invoiceType": "I",
                "status": 1,
                "cancellationDate": null,
                "downloadPackageId": null,
                "downloadRequestId": "71bdec41-fd18-4f1b-9e5e-2b9cdad9978f",
                "id": "c6a65658-4ce2-4ab3-b462-dba1ecdaa6d2",
                "createdAt": "2025-08-15T12:24:27.562",
                "updatedAt": "2025-08-15T12:24:27.562"
            }
        ],
        "pageNumber": 1,
        "totalPages": 2,
        "totalCount": 3,
        "hasPreviousPage": false,
        "hasNextPage": false
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Respuesta de transferencia de timbres

Source: https://docs.fiscalapi.com/stamps

Estructura JSON devuelta tras una transferencia exitosa.

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

--------------------------------

### Get Catalog Record by ID

Source: https://docs.fiscalapi.com/catalogs

Retrieves a specific record from a catalog using its ID. Requires the catalog name and the record ID as parameters.

```APIDOC
## GET /api/v4/catalogs/<catalogName>/key/<recordId>

### Description
This endpoint allows you to retrieve a specific record from a specific catalog. It takes the catalog name and the record ID as parameters.

### Method
GET

### Endpoint
/api/v4/catalogs/<catalogName>/key/<recordId>

### Parameters
#### Path Parameters
- **catalogName** (string) - Required - The name of the catalog.
- **recordId** (string) - Required - The ID of the record within the catalog.

### Request Example
```curl
curl --location 'https://test.fiscalapi.com/api/v4/catalogs/SatPaymentForms/key/03' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
```

### Response
#### Success Response (200)
- **data** (object) - The requested catalog record.
  - **id** (string) - The unique identifier of the record.
  - **description** (string) - The description of the record.
  - **createdAt** (string) - The timestamp when the record was created.
  - **updatedAt** (string | null) - The timestamp when the record was last updated.
- **succeeded** (boolean) - Indicates if the request was successful.
- **message** (string) - Any message associated with the response.
- **details** (string) - Additional details about the response.
- **httpStatusCode** (integer) - The HTTP status code of the response.

#### Response Example
```json
{
    "data": {
        "id": "03",
        "description": "Transferencia electrónica de fondos",
        "createdAt": "2024-08-10T15:46:30.3730000",
        "updatedAt": null
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```
```

--------------------------------

### POST /api/v4/manifests

Source: https://docs.fiscalapi.com/manifests

Generates and signs the Carta Manifiesto for the RFC contained in the provided certificate. Returns the signed PDF encoded in Base64.

```APIDOC
## POST /api/v4/manifests

### Description
Generates and signs the Carta Manifiesto corresponding to the RFC contained in the certificate sent in the request. Returns the signed PDF in Base64 format.

### Method
POST

### Endpoint
/api/v4/manifests

### Parameters
#### Request Body
- **base64Cer** (string) - Required - The .cer file of the taxpayer's FIEL, encoded in Base64.
- **base64Key** (string) - Required - The .key file of the taxpayer's FIEL, encoded in Base64.
- **password** (string) - Required - The password associated with the FIEL private key.

### Request Example
{
  "base64Cer": "base64CerHere...",
  "base64Key": "base64KeyHere...",
  "password": "passwordPhraseHere..."
}

### Response
#### Success Response (200)
- **data** (object) - Contains the signed file details.
- **fileName** (string) - The name of the generated PDF file.
- **fileExtension** (string) - The file extension (.pdf).
- **base64File** (string) - The signed PDF file encoded in Base64.
- **succeeded** (boolean) - Indicates if the operation was successful.
- **httpStatusCode** (integer) - The HTTP status code.

#### Response Example
{
    "data": {
        "fileName": "EKU9003173C9.pdf",
        "fileExtension": ".pdf",
        "base64File": "JVBERi0xLjQKJaqrrK0KNCAwIG9iago8PA..."
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Activar flujo de prueba vía API

Source: https://docs.fiscalapi.com/download-info

Endpoint para iniciar el flujo de simulación de descarga masiva en el ambiente de pruebas.

```http
POST /api/v4/download-rules/test
```

--------------------------------

### GET /api/v4/download-requests/<id>/raw-response

Source: https://docs.fiscalapi.com/download-requests

Retrieves the raw SAT response file (XML) for a specific download request by its ID. This is useful for debugging request responses.

```APIDOC
## GET /api/v4/download-requests/<id>/raw-response

### Description
This endpoint allows you to download the raw SAT response (XML file) of a request by its ID. This file is useful for debugging the response of a request.

### Method
GET

### Endpoint
/api/v4/download-requests/<id>/raw-response

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the download request.

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

### Response
#### Success Response (200)
- **data** (object) - Contains the file information.
- **succeeded** (boolean) - Indicates if the operation was successful.
- **httpStatusCode** (integer) - The HTTP status code.

#### Response Example
{
    "data": {
        "base64File": "PHM6RW52ZWxvcGU...",
        "fileName": "RawResponse_cd9959d1-3c6d-40d7-bf13-551b2265dded.xml",
        "fileExtension": ".xml"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}
```

--------------------------------

### Eliminar datos de empleado con cURL

Source: https://docs.fiscalapi.com/employee-data

Realiza una solicitud DELETE al endpoint de empleados. Requiere las cabeceras X-TENANT-KEY, X-TIME-ZONE y X-API-KEY.

```bash
curl --location --request DELETE 'https://test.fiscalapi.com/api/v4/people/bef56254-0892-4558-95c3-f9c8729e4b0e/employee' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>' \
--data ''
```
Tokens:
Raw