Permite obter uma lista paginada de até 100 relatórios vinculados ao escritório, com suporte a OData.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Para consultas nessa rota é levado em consideração as permissões do usuário responsável pelo token ou do usário passado como parâmetro do header.
Essa rota da API permite que os campos de clientes, obrigações e departamentos sejam utilizados diretamente nos filtros da URL. Isso significa que você pode realizar buscas específicas com base nessas informações, utilizando a sintaxe Entidade/NomeDoCampo.
Por exemplo, para buscar registros de arquivos vinculados a clientes com IDs específicos, a consulta OData pode ser feita da seguinte forma:
https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Customer/Id in (1a85c9e2-f631-4c56-9a24-c8c5e7e7e4cb, 8e7b55ad-b39c-45d2-84d6-d34af6e3376b, 9fa10502-e981-4f9a-9b2e-3f998314c20f)
Outro exemplo seria filtrar arquivos com base nos departamentos associados:
https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Department/Id in (a435f40f-5480-4ae3-a1db-f3628371ac9d, 6bd41df8-09c1-4dc3-9d62-1047505d378b)
Ou ainda, consultar por arquivos vinculados a obrigações específicas:
https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/fileds?$filter=Obligation/Id in ('234687', '525873')
Para aplicar filtros em outras propriedades dessas entidades, basta substituir Id por qualquer outro campo exposto no objeto, como Name e Type.
Dicionário para propriedades retornadas
destinationType
destinationTypeEssa propriedade representa o destino do protocolo:
1- Arquivos Online2- Controle Interno3- Cliente4- Contador5- Baixa Justificada
null quando a obrigação ainda não tem protocolo.
status
statusEssa propriedade representa o status do protocolo:
1- Excluído2- Cancelado3- Não Recebido4- Recebido5- Não ativo6- Ativo7- Baixa Justificada8- Pago
null quando a obrigação ainda não tem protocolo.
obligation.type
obligation.typeEssa propriedade representa o tipo da obrigação:
1- Pagamento2- Cadastral3- Declaração4- Diversos
Nas obrigações Diversos, o valor vem null, não 4.
obligation.frequency
obligation.frequencyEssa propriedade representa a frequência de vencimento da obrigação:
0- Diário1- Decendial2- Quinzenal3- Mensal4- Bimestral5- Trimestral6- Quadrimestral7- Semestral8- Anual
null quando a obrigação não tem frequência de vencimento definida.
documentUpdateType
documentUpdateTypeEssa propriedade representa o tipo de atualização, quando o protocolo é uma nova versão de outro:
1- Correção2- Complemento
null no protocolo original e quando a obrigação ainda não tem protocolo.
Response body
Response body- accrual - competência
- dueDate - data de vencimento
- filedDate - data do protocolo
- internalDeadline - meta interna
- department - departamento da obrigação
- value - campo preenchido somente se o protocolo for realizado com valor
- recalculationEnabled - indica se o protocolo foi realizado com o recálculo habilitado ou desabilitado
