CarteiraCobranca

Busca de Carteiras de Cobrança

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

get/api/financeiro/v1/carteira-cobranca

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/financeiro/v1/carteira-cobranca
  • Auth: HTTP bearer

Query parameters

Situacao'Todos' | 'Inativo' | 'Ativo'
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
codigostring nullable
siglastring nullable
idContaBancostring nullable
idTipoCobrancastring nullable
idPortadorstring nullable
leiauteBoletostring nullable
leiauteRemessastring nullable
descricaostring nullable
valorDespesaCobrancanumber double
float'D0' | 'D1' | 'D2' | 'D3' | 'D4'
statusAceiteboolean
emissaoQRCodePixboolean
inativaboolean

Changes

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