1. Base de Conhecimento
Qgestora
  • Qgestora API
    • Guia de Integração
      • Primeiros Passos & Autenticação
    • Operações
      • Validar Operação
      • Importar Operação
      • Importar Documentação de Lastro
      • Cancelar Operação
    • Retorno de Status de Operação
      • Callback: Retorno de Status da Operação
    • Pessoas/Limites de Crédito
      • Importar Cedente/Limite de Crédito
      • Importar Pessoa/Limite de Crédito
    • Odata
      • Visão Geral
      • Guia de Conexão
        • Conexão via Power BI e Excel
        • Conexão via Postman
        • Conexão via Python
      • Dicionário de Dados
        • Definições
        • Entidades
      • Base de Conhecimento
        • Orientações para Uso via OData
    • Esquemas
      • ValidateImportCnabRequest
      • CnabInformation
      • ImportCnabRequest
      • ImportReceivableDocumentationRequest
      • ReceivableDocumentationFile
      • ReturnCnabSituationRequest
      • ExceptionResponse
      • ExceptionResponseError
      • TransferorData
      • TransferorCreditLimit
      • ImportTransferorLimitRequest
      • ImportTransferorLimitResponse
      • PersonData
      • PersonCreditLimit
      • ImportPersonLimitRequest
      • ImportPersonLimitResponse
      • ImportMessage
      • OperationCancellationRequest
      • CancellationExceptionResponse
      • CancellationExceptionResponseError
  1. Base de Conhecimento

Orientações para Uso via OData

1. Restrição por Empresa e Filial#

A grande maioria das entidades está segmentada por Empresa e Filial. O Odata automaticamente restringe o acesso aos dados da Empresa/Filial em que o token foi gerado; Consultas a outras Empresas/Filiais não são possíveis e retornarão falha;

2. Use o campo Situação para obter apenas dados vigentes#

Registros inativos permanecem na base para fins de auditoria. Para consultas operacionais, filtre por Situação igual a "A" (Ativo). Omitir este filtro retorna o histórico completo.

3. Aplique filtros de data em entidades de alto volume#

Entidades como Estoque, Histórico do Estoque, Movimentos e NF-e podem conter grandes volumes. Utilize sempre filtros de data combinados com paginação para evitar consultas lentas.

4. Evite consultar campos binários em massa#

Campos que armazenam arquivos (documentos de lastro, XMLs de NF-e, dados binários de arquivos) não devem ser incluídos em consultas gerais. Acesse-os individualmente por chave.

5. Entenda a centralidade do cadastro de Entidades#

Fundos, Cedentes, Sacados, Administradoras e Custodiantes são todos registros do mesmo cadastro de Entidades, diferenciados pelo tipo e pelo vínculo à entidade. Relacionamentos sempre apontam para este cadastro.

6. Valide vigência antes de usar limites e condições#

Limites de crédito e condições de cessão têm datas de início e fim de vigência. Filtre pela data atual para garantir que somente os registros em vigor sejam considerados.

7. Atenção ao fuso horário dos campos de data e hora#

Campos do tipo timestamp incluem data e hora com precisão. Certifique-se de que a ferramenta de integração trata corretamente o fuso horário em comparações e exibições.
Modificado em 2026-09-22 14:51:15
Página anterior
Entidades
Próxima página
ValidateImportCnabRequest
Built with