TOTVS - RESTFul API

DELETE

Description

Exclusão do anexo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
coddoc	string	required

GET

Description

Consulta de Clientes com complemento de clientes (NUH)

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
valordig	string	required
codcliente	string	required
codcliloja	string	required
filtfilial	string	required
camposadc	boolean	required
tipo	string	required

GET

dataByCODLD/{tabela}/{campo}/{codLD}

Description

Busca registro a partir do campo _CODLD

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
fields	string	required
_pathparam	Undefined	Undefined
tabela	string	required
campo	string	required
codld	string	required

GET

Description

Download anexo via LegalDesk

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
key	string	required

GET

Description

Verifica se existe a tabela no ambiente

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
key	string	required

GET

extraFields

Description

Lista dos campos obigatórios e customizados de uma tabela

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	required
isvalid	string	required
iscustom	string	required
istudo	string	required

GET

getanexos/{chaveEnt}

Description

Retorna arquivos anexados no cliente

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
entidade	string	required
filiallog	string	required
filialanexo	string	required
_pathparam	Undefined	Undefined
chaveent	string	required

GET

getBancos

Description

Busca a lista de bancos

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	required
bcoescr	string	required
bcopix	boolean	required

GET

getDataTable/{tabela}/{chave}

Description

Busca campos de um alias específico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
campos	string	required
_pathparam	Undefined	Undefined
tabela	string	required
chave	string	required

GET

Description

Busca o registro específico de um campo tipo F3

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
xbalias	string	required
searchkey	string	required
filtf3	string	required

GET

Description

Busca a lista de opções de um campo tipo F3

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
filter	string	required
_pathparam	Undefined	Undefined
xbalias	string	required
filtf3	string	required
rotina	string	required
extra	string	required

GET

getMoedas

Description

STR0063

Response Content Type

Parameters

Parameter	Data Type	Value
	Undefined	Undefined

GET

getTpRelFaturame

Description

Busca a lista do tipo de relatórios de faturamento

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	required
codcliente	string	required
codcliloja	string	required

GET

Description

Retorna o nome do usuário logado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

GET

Description

Busca os dados do modelo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
mvcmodel	string	required

GET

Description

Busca dados do campo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
campochave	string	required
mvcmodel	string	required

GET

listCondPagamentos

Description

Busca a lista de condições de pagamentos

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	required

GET

Description

Busca a lista de municípios de um estado específico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
uf	string	required
searchkey	string	required

GET

Description

Busca a lista de originações (NRI) podendo filtrar somente as originações que são do tipo sócio.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
tipo	string	required
participante	string	required
ativo	boolean	required
tipoorig	string	required

GET

Description

Busca a lista de participantes filtrando pelo tipo (1 - Funcionários Ativos, 2 - Sócios, 3 - Sócios ou Revisores, 4 - Assinam Fatura)

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
tipo	string	required
tipoorig	string	required
searchkey	string	required

GET

Description

Busca a lista de tipos de atividades não cobráveis e tipos de despesas não cobráveis

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
cobravel	string	required
tipo	string	required
valordig	string	required

GET

Description

Busca a Estrutura do MVC

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
mvcmodel	string	required

POST

Description

Cria anexo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

Description

Cria anexo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

Description

Cria anexo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

vincCasContr

Description

Retorna se é possivel vincular o caso ao contrato

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

PUT

Description

Conversão de PDF para Texto

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

PUT

Description

Valida se os campos existem no SX3

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

TOTVS - RESTFul API

Service: /wspfsapi/

Métodos

DELETE

Description

GET

Description

GET dataByCODLD/{tabela}/{campo}/{codLD}

Description

GET

Description

GET

Description

GET extraFields

Description

GET getanexos/{chaveEnt}

Description

GET getBancos

Description

GET getDataTable/{tabela}/{chave}

Description

GET

Description

GET

Description

GET getMoedas

Description

GET getTpRelFaturame

Description

GET

Description

GET

Description

GET

Description

GET listCondPagamentos

Description

GET

Description

GET

Description

GET

Description

GET

Description

GET

Description

POST

Description

POST

Description

POST

Description

POST vincCasContr

Description

PUT

Description

PUT

Description

GET

dataByCODLD/{tabela}/{campo}/{codLD}

GET

extraFields

GET

getanexos/{chaveEnt}

GET

getBancos

GET

getDataTable/{tabela}/{chave}

GET

getMoedas

GET

getTpRelFaturame

GET

listCondPagamentos

POST

vincCasContr