TOTVS - RESTFul API

DELETE

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

Description

Exclui um contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

DELETE

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

Description

Exclui um documento anexado ao contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required
doc	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

Description

Retorna os valores previstos e realizados da planilha.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required
spreadsheetnumber	string	required

GET

/api/protheus/wscnta300/v1/contracts

Description

Retorna a lista de contratos disponíveis para consulta.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	integer	optional
pagesize	integer	optional
searchkey	string	optional
_type	string	optional
customer	string	optional
supplier	string	optional
unit	string	optional
expiring	boolean	optional
status	integer	optional
order	string	optional

GET

/api/protheus/wscnta300/v1/customers

Description

Retorna a lista de clientes disponíveis para filtrar os contratos exibidos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
unit	string	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

Description

Retorna os detalhes de um contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
schedule	boolean	optional
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/forecast

Description

Projecao financeira para os proximos 6 meses.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

GET

/api/protheus/wscnta300/v1/suppliers

Description

Retorna a lista de fornecedores disponíveis para filtrar os contratos exibidos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
unit	string	optional

GET

/api/protheus/wscnta300/v1/contracts/total

Description

Retorna a quantidade total de contratos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
status	integer	optional

GET

/api/protheus/wscnta300/v1/financialAccounts

Description

Retorna a lista de contas contábeis

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/accountingEntities/{plan}

Description

Retorna as entidades contabeis de acordo com o plano de contas informado.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional
_pathparam	Undefined	Undefined
plan	string	required

GET

/api/protheus/wscnta300/v1/accountingItems

Description

Retorna a lista de items contábeis

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/accountingPlans

Description

Retorna os codigos dos planos de contas adicionais.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional

GET

/api/protheus/wscnta300/v1/approvalGroups

Description

Retorna grupos de aprovação

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

Description

Retorna os valores previstos e realizados da planilha.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required
spreadsheetnumber	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/type/revisions

Description

Retorna o número da revisão e seu tipo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
_pathparam	Undefined	Undefined
contractid	string	required

GET

/api/protheus/wscnta300/v1/classes

Description

Retorna lista de naturezas.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional

GET

/api/protheus/wscnta300/v1/coins

Description

Retorna lista de moedas

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/contracts

Description

Retorna a lista de contratos disponíveis para consulta.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
page	integer	optional
pagesize	integer	optional
searchkey	string	optional
_type	string	optional
customer	string	optional
supplier	string	optional
unit	string	optional
expiring	boolean	optional
status	integer	optional
order	string	optional

GET

/api/protheus/wscnta300/v1/costCenters

Description

Retorna a lista de centro de custos

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/customers

Description

Retorna a lista de clientes disponíveis para filtrar os contratos exibidos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
unit	string	optional

GET

/api/protheus/wscnta300/v1/departments

Description

Retorna as áreas dos contratos

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/contracts/{contractID}/{rev}

Description

Retorna os detalhes de um contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
schedule	boolean	optional
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

Description

Retorna o documento solicitado no formato base64.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required
doc	string	required

GET

/contracts/{contractID}/{rev}/forecast

Description

Projecao financeira para os proximos 6 meses.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents

Description

Retorna o documento solicitado no formato base64.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

GET

/api/protheus/wscnta300/v1/getParcel/{qtParcel}

Description

Retorna os números das parcelas para atribuição no cronograma financeiro.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
start	string	required
_pathparam	Undefined	Undefined
qtparcel	integer	required

GET

/api/protheus/wscnta300/v1/indexes

Description

Retorna lista de índices de reajuste

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/paymentConditions

Description

Retorna condições de pagamento

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/products

Description

Retorna lista de produtos

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/historic/revisions

Description

Retorna o histórico de revisões do contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
revisionfilter	string	optional
_pathparam	Undefined	Undefined
contractid	string	required

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadsheetNumber}/schedule

Description

Retorna as parcelas do cronograma financeiro

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required
spreadsheetnumber	string	required

GET

/api/protheus/wscnta300/v1/stoppages

Description

Retorna lista dos motivos de paralização.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

GET

/suppliers

Description

Retorna a lista de fornecedores disponíveis para filtrar os contratos exibidos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
unit	string	optional

GET

/contracts/total

Description

Retorna a quantidade total de contratos.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
status	integer	optional

GET

/api/protheus/wscnta300/v1/typesOfContract

Description

Retorna os tipos de contrato

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
_type	string	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/typesOfSpreadsheet

Description

Retorna os tipos de planilha

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
alltypes	boolean	optional
byid	boolean	optional

GET

/api/protheus/wscnta300/v1/valueClasses

Description

Retorna a lista de classes de valor

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
searchkey	string	optional
page	integer	optional
pagesize	integer	optional
byid	boolean	optional

POST

/api/protheus/wscnta300/v1/coins/{coin}/rates

Description

Retorna as taxas da moeda de acordo com as datas especificadas.

Response Content Type

Parameters

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

POST

/api/protheus/wscnta300/v1/contracts

Description

Inclui um contrato

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/revision

Description

Cria uma revisão para o contrato

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/documents

Description

Anexa um documento ao contrato.

Response Content Type

Parameters

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

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/readjustment

Description

Reajusta os valores do contrato com base em um índice econômico

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

POST

/api/protheus/wscnta300/v1/contracts/{contractID/{rev}/restart

Description

Reinicia um contrato paralisado.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

Description

Altera um contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/approveRevision

Description

Aprova a revisão de um contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/status

Description

Altera a situação do contrato.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
contractid	string	required
rev	string	required

TOTVS - RESTFul API

Service: /wscnta300/

Métodos

DELETE /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

Description

DELETE /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

Description

GET /api/protheus/wscnta300/v1/contracts

Description

GET /api/protheus/wscnta300/v1/customers

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/forecast

Description

GET /api/protheus/wscnta300/v1/suppliers

Description

GET /api/protheus/wscnta300/v1/contracts/total

Description

GET /api/protheus/wscnta300/v1/financialAccounts

Description

GET /api/protheus/wscnta300/v1/accountingEntities/{plan}

Description

GET /api/protheus/wscnta300/v1/accountingItems

Description

GET /api/protheus/wscnta300/v1/accountingPlans

Description

GET /api/protheus/wscnta300/v1/approvalGroups

Description

GET /contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/type/revisions

Description

GET /api/protheus/wscnta300/v1/classes

Description

GET /api/protheus/wscnta300/v1/coins

Description

GET /contracts

Description

GET /api/protheus/wscnta300/v1/costCenters

Description

GET /customers

Description

GET /api/protheus/wscnta300/v1/departments

Description

GET /contracts/{contractID}/{rev}

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

Description

GET /contracts/{contractID}/{rev}/forecast

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents

Description

GET /api/protheus/wscnta300/v1/getParcel/{qtParcel}

Description

GET /api/protheus/wscnta300/v1/indexes

Description

GET /api/protheus/wscnta300/v1/paymentConditions

Description

GET /api/protheus/wscnta300/v1/products

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/historic/revisions

Description

GET /api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadsheetNumber}/schedule

Description

GET /api/protheus/wscnta300/v1/stoppages

Description

GET /suppliers

Description

GET /contracts/total

Description

GET /api/protheus/wscnta300/v1/typesOfContract

Description

GET /api/protheus/wscnta300/v1/typesOfSpreadsheet

Description

GET /api/protheus/wscnta300/v1/valueClasses

Description

POST /api/protheus/wscnta300/v1/coins/{coin}/rates

DELETE

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

DELETE

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

GET

/api/protheus/wscnta300/v1/contracts

GET

/api/protheus/wscnta300/v1/customers

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/forecast

GET

/api/protheus/wscnta300/v1/suppliers

GET

/api/protheus/wscnta300/v1/contracts/total

GET

/api/protheus/wscnta300/v1/financialAccounts

GET

/api/protheus/wscnta300/v1/accountingEntities/{plan}

GET

/api/protheus/wscnta300/v1/accountingItems

GET

/api/protheus/wscnta300/v1/accountingPlans

GET

/api/protheus/wscnta300/v1/approvalGroups

GET

/contracts/{contractID}/{rev}/spreadsheets/{spreadSheetNumber}/balances

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/type/revisions

GET

/api/protheus/wscnta300/v1/classes

GET

/api/protheus/wscnta300/v1/coins

GET

/contracts

GET

/api/protheus/wscnta300/v1/costCenters

GET

/customers

GET

/api/protheus/wscnta300/v1/departments

GET

/contracts/{contractID}/{rev}

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents/{doc}

GET

/contracts/{contractID}/{rev}/forecast

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/documents

GET

/api/protheus/wscnta300/v1/getParcel/{qtParcel}

GET

/api/protheus/wscnta300/v1/indexes

GET

/api/protheus/wscnta300/v1/paymentConditions

GET

/api/protheus/wscnta300/v1/products

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/historic/revisions

GET

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/spreadsheets/{spreadsheetNumber}/schedule

GET

/api/protheus/wscnta300/v1/stoppages

GET

/suppliers

GET

/contracts/total

GET

/api/protheus/wscnta300/v1/typesOfContract

GET

/api/protheus/wscnta300/v1/typesOfSpreadsheet

GET

/api/protheus/wscnta300/v1/valueClasses

POST

/api/protheus/wscnta300/v1/coins/{coin}/rates

POST

/api/protheus/wscnta300/v1/contracts

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/revision

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/documents

POST

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/readjustment

POST

/api/protheus/wscnta300/v1/contracts/{contractID/{rev}/restart

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/approveRevision

PUT

/api/protheus/wscnta300/v1/contracts/{contractID}/{rev}/status