Consultar historial de estados de un documento
curl --request GET \
--url https://api.tupana.ai/v1/documents/{document_id}/states \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/documents/{document_id}/states"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/documents/{document_id}/states', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/documents/{document_id}/states",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/documents/{document_id}/states"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tupana.ai/v1/documents/{document_id}/states")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/documents/{document_id}/states")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"document_id": 12345,
"folio": "123",
"states": [
{
"event_code": "ERM",
"event_description": "Acuse de Recibo",
"event_date": "2024-01-16T10:30:00Z",
"responsable_rut": 12345678,
"responsable_dv": "9",
"rejected_by_user": "usuario@ejemplo.com",
"accepted_by_user": "usuario@ejemplo.com"
}
],
"document": {
"id": 123,
"folio": "<string>",
"date_issued": "2023-12-25",
"amount_with_iva": 123,
"dte_type_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"has_trace": true,
"latest_trace_info": {
"has_acknowledgments": true,
"has_claims": true,
"is_more_than_eight_days": true,
"is_rejected": true,
"date_reception": "2023-11-07T05:31:56Z",
"events_count": 123
}
}
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "No tienes acceso a este documento"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Estados de Documentos
Consultar estados de documento
Consultar el historial de estados asociados a un documento tributario específico.
GET
/
documents
/
{document_id}
/
states
Consultar historial de estados de un documento
curl --request GET \
--url https://api.tupana.ai/v1/documents/{document_id}/states \
--header 'Authorization: <api-key>'import requests
url = "https://api.tupana.ai/v1/documents/{document_id}/states"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.tupana.ai/v1/documents/{document_id}/states', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tupana.ai/v1/documents/{document_id}/states",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tupana.ai/v1/documents/{document_id}/states"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tupana.ai/v1/documents/{document_id}/states")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tupana.ai/v1/documents/{document_id}/states")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"document_id": 12345,
"folio": "123",
"states": [
{
"event_code": "ERM",
"event_description": "Acuse de Recibo",
"event_date": "2024-01-16T10:30:00Z",
"responsable_rut": 12345678,
"responsable_dv": "9",
"rejected_by_user": "usuario@ejemplo.com",
"accepted_by_user": "usuario@ejemplo.com"
}
],
"document": {
"id": 123,
"folio": "<string>",
"date_issued": "2023-12-25",
"amount_with_iva": 123,
"dte_type_code": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"has_trace": true,
"latest_trace_info": {
"has_acknowledgments": true,
"has_claims": true,
"is_more_than_eight_days": true,
"is_rejected": true,
"date_reception": "2023-11-07T05:31:56Z",
"events_count": 123
}
}
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "No tienes acceso a este documento"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}{
"error": "VALIDATION_ERROR",
"message": "<string>"
}Qué hace
- Devuelve todos los estados registrados para el documento
- Permite entender qué eventos han ocurrido sobre ese documento
- Muestra la secuencia cronológica de los estados
- No modifica ninguna información
Ejemplos de uso
- Revisar si un documento fue pagado
- Ver si tuvo rechazos o acuses
- Auditar cambios o eventos automáticos del SII
- Mostrar el historial completo en el backoffice
Authorizations
API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)
Path Parameters
ID único del documento (integer)
Response
Historial de estados obtenido exitosamente
Indica si la operación fue exitosa
Example:
true
ID del documento
Example:
12345
Folio del documento
Example:
"123"
Lista de estados registrados para el documento, ordenados cronológicamente (más reciente primero)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
