Documento

Busca de Documentos

Lê uma lista de Documentos com base no filtro informado na URL da requisição.

get/api/empresarial/v1/documento

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/empresarial/v1/documento
  • Auth: HTTP bearer

Query parameters

ModulosRadarAPIModelEmpresarialDtosV1DocumentoModuloDocumentoDto[]
IdFilialstring

Id da filial do documento. Informe o valor vazio (null) para não serem filtrados, 0 para trazer os válidos em todas as filiais ou um Id para o filtro.

Codigostring
Descricaostring
Especiestring
Seriestring
Situacao'Todos' | 'Ativos'
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

Response

OK

idstring nullable
codigoIntegradorstring nullable
modulosRadarAPIModelEmpresarialDtosV1DocumentoModuloDocumentoDto[] nullable
idFilialstring nullable
codigostring nullable
descricaostring nullable
especiestring nullable
seriestring nullable
inativoboolean

Changes

No recorded changes to this operation across all 1 revision of this API.