Consultar un dte
Este endpoint está diseñado para facilitar consulta de cualquier documento tributario electrónico (DTE). Para utilizarlo, necesitas realizar una solicitud http de tipo GET a `/dte/:id``, reemplazando el query param id con el identificador del DTE que deseas obtener.
Detalles Técnicos
- HTTP Method: GET
- URL:
https://api.facturallama.com/dte/:id
- Headers:
- X-API-Key: Tu API key.
- X-API-Version: La versión de la API que estás utilizando.
- Content-Type: application/json
Query Params
A continuación se presenta una descripción detallada de las propiedades que debes incluir en la solicitud, así como las validaciones y formatos que debes tener en cuenta.
Propiedad | Tipo | Validación | Descripción |
---|---|---|---|
id | UUID | Obligatorio. | Identificador único del DTE. |
Response Body
Una vez procesada tu solicitud, el servidor responderá con el conjunto de datos que corresponden al DTE consultado o, en caso de error, proporcionarán detalles sobre lo que salió mal.
Propiedad | Tipo | Descripción |
---|---|---|
id | UUID | Identificador único del DTE. |
companyId | UUID | Identificador único de la empresa. |
controlNumber | String | Este número es utilizado para identificar el DTE ante el Ministerio de Hacienda (MH). |
environment | Enum | Ambiente. Valores: TEST , LIVE . |
type | Enum | Tipo de documento fiscal. Valores: FC , CCF , NC , ND , CR , FSE , FEX . |
version | Integer | Versión del DTE. |
status | Enum | Estado del DTE. Valores: CREATED , PROCESSING , APPROVED , REJECTED , INVALIDATED . |
mhResponse | Object | Respuesta del API del Ministerio de Hacienda. |
generatedAt | Timestamp | Fecha y hora de creación del DTE asignado manualmente. |
createdAt | Timestamp | Fecha y hora de creación del DTE. |
Ejemplo
Copia y pega el código en una terminal o en tu editor de código favorito. Reemplaza <Tu API Key>
con la API key que generaste en el paso anterior.
- cURL
- wget
- NodeJs - Axios
- PHP - Guzzle
curl --location 'https://api.facturallama.com/dte/<DTE ID>' \
--header 'X-API-Version: 1' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <API Key>'
wget --no-check-certificate --quiet \
--method=GET \
--header='X-API-Key: <API Key>' \
--header='X-API-Version: 1' \
--header='Content-Type: application/json' \
--output-document=- \
https://api.facturallama.com/dte/<DTE ID>
const axios = require("axios");
let config = {
method: "get",
maxBodyLength: Infinity,
url: "https://api.facturallama.com/dte/<DTE ID>",
headers: {
"X-API-Version": "1",
"Content-Type": "application/json",
"X-API-Key": "<API Key>",
},
};
axios
.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
<?php
$client = new Client();
$headers = [
'X-API-Version' => '1',
'Content-Type' => 'application/json',
'X-API-Key' => '<API Key>'
];
$request = new Request('GET', 'https://api.facturallama.com/dte/<DTE ID>', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();