Listar exportações FOCUS
Lista as exportações FOCUS dos últimos 7 dias e se a exportação está ativada.
GET/v1/workspaces/{regionId}/focus-exports
Retorna
200 OK com o objeto mostrado na resposta.
Mais detalhes
Retorna se a exportação FOCUS está ativada para o espaço de trabalho e suas exportações dos últimos 7 dias, das mais recentes para as mais antigas, no máximo 20. A lista não traz links de download; obtenha-os com GetFocusExport.
Precisa de acesso 'view' às faturas. Uma chave de API pode chamá-lo.
Campos da resposta
enabledbooleanSe a exportação FOCUS está ativada para o espaço de trabalho.
from, tostringO primeiro e o último período de faturamento da exportação, como YYYY-MM.
rowCount, documentCountnumberAs linhas do conjunto de dados e as faturas, notas de débito e notas de crédito de que elas vêm.
expiresAtstringQuando a Pleaxy exclui os arquivos da exportação, 7 dias depois de criada.
Erros
- 401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
- 403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-exports" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"enabled": boolean,
"exports": [
{
"id": "string",
"status": "ready",
"createdAt": "string",
"version": "1.2" | "1.4",
"include": "all" | "non_cloud",
"from": "string",
"to": "string",
"format": "csv" | "parquet",
"rowCount": number,
"documentCount": number,
"commitmentCount": number,
"expiresAt": "string"
}
]
}