TOTVS - RESTFul API


Service: /backofficeapprovals/

Aprovação de documentos

Métodos

GET
/api/com/approvals/v1/approvalsList

Description

Retorna a lista de documentos aprovados, reprovados ou pendentes de aprovação, apenas do aprovador logado

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
documenttype string optional
documentbranch string optional
documentstatus string optional
initdate string optional
enddate string optional
searchkey string optional
page integer optional
pagesize integer optional
orderby integer optional

GET
/api/com/approvals/v1/{typeApprovals}/{documentId}/items

Description

Obtêm a lista de itens do documento

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
itemgroup string optional
_pathparam UndefinedUndefined
typeapprovals string required
documentid string required

GET
api/com/approvals/v1/historybyitem

Description

Retorna a lista com os últimos lançamentos de compras para o produto

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
page integer optional
pagesize integer optional
productcode string optional

GET
api/com/approvals/v1/itemAdditionalInformation

Description

Retorna as informações adicionais para um item do pedido ou solicitação de compra

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
recordnumber string optional
itemnumber string optional

GET
api/com/approvals/v1/{typeApproval}/{documentStatus}/totalApprovals

Description

Retorna a quantidade de documentos aprovados, reprovados e penedentes de aprovação do usuário

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
typeapproval string optional
documentstatus string optional

PUT
/api/com/approvals/v1/batchApprovals/{typeApprovals}

Description

Aprovação de documentos por Lote

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
_pathparam UndefinedUndefined
typeapprovals string required