Permite obter uma lista paginada de até 100 relatórios vinculados a um escritório contábil, com suporte a OData.
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
destinationType
Essa propriedade representa o tipo de documento do cliente:
1
- Arquivos Online2
- Controle Interno3
- Cliente4
- Contador5
- Baixa Justificada
statusType
statusType
Essa propriedade representa o regime tributário da empresa:
1
- Excluído2
- Cancelado3
- Não Recebido4
- Recebido5
- Não Ativado6
- Ativado7
- Baixa Justificada8
- Pago
obligationType
obligationType
Essa propriedade representa o tipo de documento do cliente:
1
- Pagamento2
- Cadastral3
- Declaração4
- Diversos