logo
Documentation Powered by ReDoc

Actions (1.0.0)

Download OpenAPI specification:Download

Developers Looplex: developer@looplex.com.br URL: https://www.looplex.com.br License: Apache 2.0 Terms of Service

Actions is the group of APIs consumed by the templates, related to document flows.

Find out how to create a GitHub repo for your OpenAPI definition.

Authentication

Subscription-Key

Chave fornecida pelo time Looplex.

Security Scheme Type API Key
Header parameter name: Ocp_Apim_Subscription_Key

api_key

Security Scheme Type API Key
Header parameter name: api_key

Ocp-Apim-Subscription-Key

Subscription key provided by Looplex

Security Scheme Type API Key
Header parameter name: Ocp-Apim-Subscription-Key

auth_token

Security Scheme Type API Key
Header parameter name: auth_token

basic_auth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Operations

Actions is the group of APIs consumed by the templates, related to document flows.

Aspose

REST APIs to create, manipulate or convert different file formats. API supports rendering documents to images through any platform and any language. Please check https://apireference.aspose.cloud/

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
baseURL
required
string

The request base URL

method
required
string
Enum: "GET" "POST" "PUT" "DELETE"

method that will be performed in the baseURL

url
required
string

The request URL

params
required
object

params of the request

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Office-render

Generates a docx based on a template

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
datasource
required
object

The datasource

template
required
string

The template

lambdas
object

Lambdas of the datasource

Responses

Request samples

Content type
application/json
{
  • "datasource": {
    },
  • "template": "https://looplex-ged.s3.us-east-1.amazonaws.com/lawsoft.com.br/shared/office-render/mala.docx",
  • "lambdas": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "(base64 file)"
}

Dictionary Lookup

Allows you to quickly look up definitions of words and phrases

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
text
required
string

The text to be looked up

from
string <(ISO639)>

the language of the text of the request

to
string <(ISO639)>

the language the text will be looked up

Responses

Request samples

Content type
application/json
{
  • "text": "sonora",
  • "from": "pt-BR",
  • "to": "en-US"
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Echo

Echo

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
key
string

Any value

Responses

Request samples

Content type
application/json
{
  • "key": "value"
}

Response samples

Content type
application/json
{
  • "cookies": { },
  • "query": { },
  • "body": {
    }
}

Keyvault

Allows you to retrieve secrets that were securely stored in the Microsoft Azure Key Vault

Authorizations:
Subscription-Key
query Parameters
id
required
string
Example: id=echo

Keyvault id

header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Oauth2-pkce-pair

Authorization code grant with Proof Key for Code Exchange (PKCE)

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Responses

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

QrCode

Creates a qrcode file based on a content

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
content
required
string

A qrcode value

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "(base64 file)"
}

Spellcheck

Searches for misspellings and suggests fixes

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
text
required
string

The text to be checked

from
string <(ISO639)>

the language of the text of the request

Responses

Request samples

Content type
application/json
{
  • "text": "Today I saw an acteon move",
  • "from": "en-US"
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Mustache-render

Generates DOCX Renders

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
template
required
string

The template

datasource
required
object

The datasource

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "const urls = []"
}

Text-recognize

Recognizes text from a document

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
string <base64> (Text-recognize)

Text-recognize service

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": [
    ]
}

Puppeteer

Provides a high-level API to control Chromium or Chrome over the DevTools Protocol

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
template
required
string

The template

datasource
required
object

The datasource

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Presigned-url

Get a presigned URL to download the object you passed the path

Authorizations:
Subscription-Key
query Parameters
cmd
required
string
Example: cmd=GET

Command to be executed

path
required
string
Example: path=looplex.com.br/shared/code/examples/summer-style.jpg

Path

header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Responses

Plot

Smart Action (Action) that allows you to quickly create data visualizations in graphs.

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
object (Plot)

Plot service

Responses

Request samples

Content type
application/json
{
  • "decorator": {
    },
  • "component": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "(base64 file)"
}

Match Adobe Annotations With MS Form Recognizer Analysis

Allows you to match Adobe Annotations With MS Form Recognizer Analysis

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
string <json> (Match Adobe Annotations With MS Form Recognizer Analysis)

Match Adobe Annotations With MS Form Recognizer Analysis service

Responses

Request samples

Content type
application/json
{
  • "analysis": [
    ],
  • "annotations": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": [
    ]
}

Vm2

vm2

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
string (vm2)

vm2

Responses

Request samples

Content type
application/json
"message.greet = 'Hello World'"

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Sendmail

Allows you to send emails

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
config
required
object

The configuration

email
required
object

the email config

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "email": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Mjml-render

Mjml-render

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
mjml
required
string

Mjml url

Responses

Request samples

Content type
application/json
{}

Mssql

Mqqsl

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
config
required
string

Config

request
required
object

method and command

Responses

Request samples

Content type
application/json
{
  • "config": "Data Source=datasource; Initial Catalog=catalogo; User Id=****; Password=**********",
  • "request": {
    }
}

Looplex Headless-surf

looplex/headless-surf

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
actions
required
string

An action

Responses

Request samples

Content type
application/json
{}

Looplex Sendmail

Allows you to send emails using MJML and Mustache.js

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
datasource
required
object

The datasource

email
required
object

the email config

Responses

Request samples

Content type
application/json
{
  • "datasource": {
    },
  • "email": {
    }
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Context Aware Spellcheck

Searches for misspellings and suggests fixes based on a context

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
word
required
string

The word to be checked

context
required
string

The context of the word

from
string <(ISO639)>

the language of the text of the request

Responses

Request samples

Content type
application/json
{
  • "word": "acteon",
  • "context": "Today I saw an acteon move",
  • "from": "en-US"
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Looplex Text Variants

Allows you to find text variants

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
inputs
required
array

array of words to check variants

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": {
    }
}

Looplex Thumbnail

Generates a thumbnail

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
file
required
string <(ISO639)>

the file url

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "message": "(base64 file)"
}

Code

Code operations

Code

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
object (Code)

Code service

Responses

Request samples

Content type
application/json
{ }

Code

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
object (Code)

Code service

Responses

Request samples

Content type
application/json
{ }

Code

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Responses

Code

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Responses

TinyURL

TinyURL Operations

TinyURL

URL shortener that shortens your unwieldly links into more manageable and useable URLs

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
url
required
string

url to be short

Responses

Request samples

Content type
application/json
{}

TinyURL

Put your tinyURL based on a ID

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
object (TinyURL)

TinyURL service

Responses

Request samples

Content type
application/json
{
  • "partitionKey": "looplex.com.br",
  • "destination": "https://www.google.com/search?q=Looplex",
  • "permanent": false,
  • "id": "HNpVoVkT0u3UdOXnBWU0E",
  • "createdAt": "2022-11-23T03:01:59.678Z",
  • "visitsCount": 0,
  • "modifiedAt": "2022-11-23T04:20:06.247Z",
  • "active": false,
  • "_rid": "gXt1AKwaC88IAAAAAAAAAA==",
  • "_self": "dbs/gXt1AA==/colls/gXt1AKwaC88=/docs/gXt1AKwaC88IAAAAAAAAAA==/",
  • "_etag": "\"c30ae7a1-0000-0200-0000-637d9f770000\"",
  • "_attachments": "attachments/",
  • "_ts": 1669177207
}

TinyURL

Get your tinyURL based on a ID

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
object (TinyURL)

TinyURL service

Responses

Request samples

Content type
application/json
{ }

TinyURL

Deletes your tinyURL based on a ID

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
partitionKey
required
string

the partition key of the url

Responses

Request samples

Content type
application/json
{
  • "partitionKey": "looplex.com.br"
}

JWT

JWT Operations

Sign

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
payload
required
object

The payload.

privateKey
required
string

The private key.

Responses

Request samples

Content type
application/json
{}

Verify

...

Authorizations:
Subscription-Key
header Parameters
Ocp-Apim-Subscription-Key
required
string

Subscription key provided by Looplex

Request Body schema: application/json
payload
string

The token.

publicKey
required
string

The public key.

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "publicKey": "string"
}

Autenticação

Login

Login do Looplex Cases

Authorizations:
Ocp-Apim-Subscription-Key
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "User": {
    }
}

Response samples

Content type
application/json
{
  • "Profile": "string",
  • "Successful": true
}

Andamento

Lista os templates de andamento

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
tipoCaso
required
integer (RamosJudicial)
Example: tipoCaso=-2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Classificações de andamento

Retorna um array com as classificações de andamento do escritório

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Andamentos simples do caso

Retorna um array de andamentos simples do caso informado.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do processo

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Andamentos simples por caso, numero interno ou numero externo

Retorna um array de andamentos simples por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

Default: 0

NumeroExterno
string

Default: empty string

IdProcesso
integer

Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Incluir andamento

Inclui o andamento

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrTipoClassificacaoAutomatica
integer (eTipoClassificacaoAutomatica)

-2147483648: None

1: Planilha de horas

2: Push de publicação

3: Push de andamento

4: Outlook

5: Automático

6: Manual

NrClassificacaoAutomatica
integer (eClassificacaoAutomaticaDeAndamento)

-2147483648: None

1: Prazo

2: Compromisso

3: Audiência

4: Atividade externa

5: Publicação

6: Decisão

7: Exclusão

8: Arquivo morto

9: Encerramento

10: Planilha de horas

11: Push de publicação

12: Push de andamento

13: Outlook

14: Movimentação processual

15: Publicação processual

16: Publicação geral

17: Nova distribuição

18: Cadastro agendado

19: Status pedido

20: Mudanças processo

21: Falha monitoramento

22: Nova CIPPROC

23: Mudança de conteúdo

24: Nova intimação

25: Retorno solicitação

26: Relatório concluído

ClassificacaoDoAndamento
string
LancamentoPeloTimeSheetDoMobile
boolean
IdAndamento
integer
TextoAndamento
string
TextoAndamentoContinuacao
string
IdProcesso
integer
DataCompetencia
string
DataInclusao
string
IdAutor
integer
NomeAutor
string
InUsoInterno
boolean
DataRevisao
string
IdRevisor
integer
NomeRevisor
string
Situacao
integer (SituacaoDeAndamento)

-2147483648: None

1: A aprovar

2: Aprovado

3: Publicado

InManual
boolean
IdAndamentoTemplate
integer
NovoAndamentoParaRevisao
integer (CaixaDeMensagem)

-2147483648: None

1: Administração

2: Avisos

3: Clientes

4: Prazos

5: Processos

6: MensagemShutdown__

7: Finanças

IdAndamentoClassificacao
integer
IdPublicacaoAndamento
integer
Tipo
integer (TipoDePush)

-2147483648: None

1: Publicação

2: Andamento

dsCodigoOriginal
string
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Andamento por identificador

Obtém o andamento de acordo com o identificador informado.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDAndamento
required
integer

O identificador do andamento

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Atualizar andamento

Atualiza o andamento.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDAndamento
required
integer

O identificador do andamento

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrTipoClassificacaoAutomatica
integer (eTipoClassificacaoAutomatica)

-2147483648: None

1: Planilha de horas

2: Push de publicação

3: Push de andamento

4: Outlook

5: Automático

6: Manual

NrClassificacaoAutomatica
integer (eClassificacaoAutomaticaDeAndamento)

-2147483648: None

1: Prazo

2: Compromisso

3: Audiência

4: Atividade externa

5: Publicação

6: Decisão

7: Exclusão

8: Arquivo morto

9: Encerramento

10: Planilha de horas

11: Push de publicação

12: Push de andamento

13: Outlook

14: Movimentação processual

15: Publicação processual

16: Publicação geral

17: Nova distribuição

18: Cadastro agendado

19: Status pedido

20: Mudanças processo

21: Falha monitoramento

22: Nova CIPPROC

23: Mudança de conteúdo

24: Nova intimação

25: Retorno solicitação

26: Relatório concluído

ClassificacaoDoAndamento
string
LancamentoPeloTimeSheetDoMobile
boolean
IdAndamento
integer
TextoAndamento
string
TextoAndamentoContinuacao
string
IdProcesso
integer
DataCompetencia
string
DataInclusao
string
IdAutor
integer
NomeAutor
string
InUsoInterno
boolean
DataRevisao
string
IdRevisor
integer
NomeRevisor
string
Situacao
integer (SituacaoDeAndamento)

-2147483648: None

1: A aprovar

2: Aprovado

3: Publicado

InManual
boolean
IdAndamentoTemplate
integer
NovoAndamentoParaRevisao
integer (CaixaDeMensagem)

-2147483648: None

1: Administração

2: Avisos

3: Clientes

4: Prazos

5: Processos

6: MensagemShutdown__

7: Finanças

IdAndamentoClassificacao
integer
IdPublicacaoAndamento
integer
Tipo
integer (TipoDePush)

-2147483648: None

1: Publicação

2: Andamento

dsCodigoOriginal
string
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Atualizar andamento Web

Atualiza o andamento

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDAndamento
required
integer

O identificador do andamento

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrTipoClassificacaoAutomatica
integer (eTipoClassificacaoAutomatica)

-2147483648: None

1: Planilha de horas

2: Push de publicação

3: Push de andamento

4: Outlook

5: Automático

6: Manual

NrClassificacaoAutomatica
integer (eClassificacaoAutomaticaDeAndamento)

-2147483648: None

1: Prazo

2: Compromisso

3: Audiência

4: Atividade externa

5: Publicação

6: Decisão

7: Exclusão

8: Arquivo morto

9: Encerramento

10: Planilha de horas

11: Push de publicação

12: Push de andamento

13: Outlook

14: Movimentação processual

15: Publicação processual

16: Publicação geral

17: Nova distribuição

18: Cadastro agendado

19: Status pedido

20: Mudanças processo

21: Falha monitoramento

22: Nova CIPPROC

23: Mudança de conteúdo

24: Nova intimação

25: Retorno solicitação

26: Relatório concluído

ClassificacaoDoAndamento
string
LancamentoPeloTimeSheetDoMobile
boolean
IdAndamento
integer
TextoAndamento
string
TextoAndamentoContinuacao
string
IdProcesso
integer
DataCompetencia
string
DataInclusao
string
IdAutor
integer
NomeAutor
string
InUsoInterno
boolean
DataRevisao
string
IdRevisor
integer
NomeRevisor
string
Situacao
integer (SituacaoDeAndamento)

-2147483648: None

1: A aprovar

2: Aprovado

3: Publicado

InManual
boolean
IdAndamentoTemplate
integer
NovoAndamentoParaRevisao
integer (CaixaDeMensagem)

-2147483648: None

1: Administração

2: Avisos

3: Clientes

4: Prazos

5: Processos

6: MensagemShutdown__

7: Finanças

IdAndamentoClassificacao
integer
IdPublicacaoAndamento
integer
Tipo
integer (TipoDePush)

-2147483648: None

1: Publicação

2: Andamento

dsCodigoOriginal
string
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrTipoClassificacaoAutomatica": 1,
  • "NrClassificacaoAutomatica": 4,
  • "ClassificacaoDoAndamento": "string",
  • "LancamentoPeloTimeSheetDoMobile": true,
  • "IdAndamento": 0,
  • "TextoAndamento": "string",
  • "TextoAndamentoContinuacao": "string",
  • "IdProcesso": 0,
  • "DataCompetencia": "string",
  • "DataInclusao": "string",
  • "IdAutor": 0,
  • "NomeAutor": "string",
  • "InUsoInterno": true,
  • "DataRevisao": "string",
  • "IdRevisor": 0,
  • "NomeRevisor": "string",
  • "Situacao": 2,
  • "InManual": true,
  • "IdAndamentoTemplate": 0,
  • "NovoAndamentoParaRevisao": 1,
  • "IdAndamentoClassificacao": 0,
  • "IdPublicacaoAndamento": 0,
  • "Tipo": 1,
  • "dsCodigoOriginal": "string",
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "Response": { },
  • "Success": true,
  • "ExceptionMessage": "string"
}

Area

Lista as áreas de acordo com o filtro informado

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Listar áreas ativas?
Default: true

inativos
boolean

Listar áreas inativas?
Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém a área de acordo com o identificador informado.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "ID": 0,
  • "Titulo": "string",
  • "Ativa": true
}

Busca

Lista os clientes e casos que correspondem ao termo informado

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
termo
required
string
ativos
boolean

Default: true

inativos
boolean

Default: false

apenasMeusCasos
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IdsClientesComCasos": [
    ],
  • "TermoBuscado": "string"
}

Calculo Monetário

Lista os cálculos monetários

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém cálculo monetário por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
ID
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Id": 0,
  • "IdIndice": 0,
  • "DataInclusao": "2022-06-01T12:00:00",
  • "DataCalculoIndice": "2022-06-01T12:00:00",
  • "Parametros": {
    },
  • "IdProcesso": 0,
  • "Situacao": 1,
  • "IdModeloCalculo": 0,
  • "nrSituacaoText": "string",
  • "inManterAtualizado": true,
  • "vlCorrigidoAtualizado": 0,
  • "inUsaValoresProcesso": true,
  • "inUltimoCalculadoProcesso": true
}

Calcula valores para atualização monetária

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
ID
required
integer
query Parameters
salvar
required
boolean
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
DataIndicePedidos
string
isClonarCalculo
boolean
cdPedidoCalculo
integer
dsTitulo
string
isManterAtualizado
boolean
vlCorrigido
number
NomeTabela
string
DataReembolso
string
DataJurosMoratoriosPedidos
string
DataJurosCompensatoriosPedidos
string
cdModeloCalculo
integer
DataJurosMoratorios
string
DataJurosCompensatorios
string
DataIndice
string
object (DTOMultaEHonorarios)
object (DTOJurosCalculo)
Array of objects (DTOValorCalculo)
Array of objects (DTOValorCalculo)
cdTabela
integer
inUsaValoresExpectativaProcesso
boolean

Responses

Request samples

Content type
application/json
{
  • "DataIndicePedidos": null,
  • "isClonarCalculo": true,
  • "cdPedidoCalculo": 0,
  • "dsTitulo": "string",
  • "isManterAtualizado": true,
  • "vlCorrigido": 0,
  • "NomeTabela": "string",
  • "DataReembolso": "2022-06-01T12:00:00",
  • "DataJurosMoratoriosPedidos": null,
  • "DataJurosCompensatoriosPedidos": null,
  • "cdModeloCalculo": null,
  • "DataJurosMoratorios": "string",
  • "DataJurosCompensatorios": "string",
  • "DataIndice": "string",
  • "MultaEHonorarios": {
    },
  • "Juros": {
    },
  • "ValoresParaCustasIncorridas": [
    ],
  • "ValoresParaCorrecao": [
    ],
  • "cdTabela": null,
  • "inUsaValoresExpectativaProcesso": true
}

Response samples

Content type
application/json
{
  • "ValorTotal": 0,
  • "ValorTotalSemCorrecao": 0,
  • "Items": [
    ],
  • "DataAtualizaValores": "2022-06-01T12:00:00",
  • "TipoCalculoUsado": 1,
  • "CdPedidoCalculo": 0
}

Lista indices monetários

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista modelos de Cálculo

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém modelo de cálculo por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
ID
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IdModeloCalculo": 0,
  • "NomeTabela": "string",
  • "Parametros": {
    }
}

Lista valores para cálculo por identificador do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Casos

Lista casos por filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
idsCliente
Array of integers
Example: idsCliente=[1,15,33,50]
idsAreaCaso
Array of integers
Example: idsAreaCaso=[1,15,33,50]
idsResponsaveis
Array of integers
Example: idsResponsaveis=[1,15,33,50]
dataCriacao
string
dataCitacao
string
dataDistribuicao
string
dataEncerramento
string
dataEntrada
string
dataUltimaAlteracao
string
situacoes
any (SituacaoDoProcesso)
Example: situacoes=[1,2,3]

1: Ativo

2: Arquivo morto

3: Encerrado

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cadastra casos

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
idPreProcesso
integer
idCliente
required
integer
idResponsavel
required
integer
idArea
required
integer
envolvimentoCliente
required
integer (PoloLawOffice)

0: None

1: Ativo

2: Passivo

3: Terceiro

4: Nenhum

5: Outro envolvido

tipo
required
integer (RamosJudicial)

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

dsAssunto
required
string

Título da pasta

nrExito
integer
nrTipoExito
integer
nrMoedaInicialCausa
integer
idProcessoPai
integer
idPasta
integer
idRito
integer
idForo
integer
cdNoForoVara
integer
numeroSequencial
integer
confidencial
boolean
dataCriacao
string
dataUltimaAlteracao
string
classeDoProcesso
integer (ClasseDoCaso)

-2147483648: None

1: Processo

2: Subprocesso

3: Recurso

4: Incidente

situacaoDoProcesso
integer (SituacaoDoCaso)

-2147483648: None

1: Ativo

2: Arquivo morto

3: Encerrado

99: Excluído

tituloProcesso
string

Título do processo

observacao
string
numeroInterno
string
idContrato
integer
idFase
integer
nivel
string
numeroExterno
string
valorCausa
number
valorExpectativaApuracao
number
valorContingencia
number
cnj
string
utilizaPedidosDoProcessoPai
boolean
foroTemporario
string
comentarioExpectativaDaCausa
string
segundoNumero
string
anotacoesSegundoNumero
string
dataEntrada
string
dataDistribuicao
string
dataCitacao
string
UF
string
cidade
string
IBGECode
string
nrUF
integer
Array of objects (HierarquiaParaLO)
coResponsaveis
Array of integers
executionID
string
idFornecedor
integer
idProcessoNoFornecedorPush
integer
nrFornecedorPush
integer
Array of objects (ParteParaLO)
Array of objects (DTOAndamento)
Array of objects (DTOItemAgenda)
Array of objects (DTOValorDadoComplementarCaso)
Array of objects (DTOCasoPedidoSimples)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "HouveException": true,
  • "ProcessosNaoCadastrados": [
    ],
  • "ProcessosCadastrados": [
    ]
}

Edita informações do caso

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
id
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
Nome
required
string

O nome da propriedade a editar

Valor
required
string

O novo valor a gravar

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "CdNoForoVara": 0,
  • "IDRito": 0,
  • "IDFaseProcesso": 0,
  • "IDArea": 0,
  • "IDForo": 0,
  • "IDsCoResponsaveis": [
    ],
  • "IDFuncionarioResponsavel": 0,
  • "Foro": "string",
  • "Rito": "string",
  • "Observacao": "string",
  • "PolosAtivos": "string",
  • "PolosPassivos": "string",
  • "FaseProcesso": "string",
  • "ComentarioExpectativaDaCausa": "string",
  • "UF": "string",
  • "cidade": "string",
  • "IBGECode": "string",
  • "nrUF": 0,
  • "Tipo": -2147483648,
  • "ExpectativaDeExito": 2,
  • "DataDeEntrada": "string",
  • "DataDeDistribuicao": "string",
  • "DataDeCitacao": "string",
  • "DataDeEncerramento": "string",
  • "DataPrevistaDeEncerramento": "string",
  • "DataDeEntradaFormatada": "string",
  • "DataDeDistribuicaoFormatada": "string",
  • "DataDeCitacaoFormatada": "string",
  • "DataDeEncerramentoFormatada": "string",
  • "DataPrevistaDeEncerramentoFormatada": "string",
  • "DsProcessFlowableId": "string",
  • "ExecutionID": "string",
  • "Confidencial": true,
  • "IDCaso": 0,
  • "Titulo": "string",
  • "IDCliente": 0,
  • "NomeCliente": "string",
  • "NomeResponsavelCaso": "string",
  • "IDPasta": 0,
  • "NomePasta": "string",
  • "IDContrato": 0,
  • "NomeContrato": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "NumeroLawoffice": 0,
  • "IDCasoPai": 0,
  • "Classe": 1,
  • "DataDeCriacao": "string",
  • "DataDeCriacaoFormatada": "string",
  • "Situacao": 1,
  • "NomeArea": "string",
  • "TipoProcesso": "string",
  • "DataUltimaAlteracao": "string",
  • "HierarquiaProcesso": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "StatusCaso": "string",
  • "Coresponsavel": [
    ],
  • "FaseDoCaso": "string",
  • "ProcessoPai": {
    },
  • "QuantidadeCasosFilho": 0,
  • "IDFornecedor": 0,
  • "PrimeiroPoloAtivo": "string",
  • "PrimeiroPoloPassivo": "string",
  • "NomeFornecedor": "string"
}

Lista casos do cliente

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCliente
required
integer

O identificador do cliente

query Parameters
ativos
boolean

Listar os casos ativos?
Default: true

inativos
boolean

Listar os casos inativos?
Default: false

apenasMeusCasos
boolean

Default: false

apenasCasosPai
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém caso por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "CdNoForoVara": 0,
  • "IDRito": 0,
  • "IDFaseProcesso": 0,
  • "IDArea": 0,
  • "IDForo": 0,
  • "IDsCoResponsaveis": [
    ],
  • "IDFuncionarioResponsavel": 0,
  • "Foro": "string",
  • "Rito": "string",
  • "Observacao": "string",
  • "PolosAtivos": "string",
  • "PolosPassivos": "string",
  • "FaseProcesso": "string",
  • "ComentarioExpectativaDaCausa": "string",
  • "UF": "string",
  • "cidade": "string",
  • "IBGECode": "string",
  • "nrUF": 0,
  • "Tipo": -2147483648,
  • "ExpectativaDeExito": 2,
  • "DataDeEntrada": "string",
  • "DataDeDistribuicao": "string",
  • "DataDeCitacao": "string",
  • "DataDeEncerramento": "string",
  • "DataPrevistaDeEncerramento": "string",
  • "DataDeEntradaFormatada": "string",
  • "DataDeDistribuicaoFormatada": "string",
  • "DataDeCitacaoFormatada": "string",
  • "DataDeEncerramentoFormatada": "string",
  • "DataPrevistaDeEncerramentoFormatada": "string",
  • "DsProcessFlowableId": "string",
  • "ExecutionID": "string",
  • "Confidencial": true,
  • "IDCaso": 0,
  • "Titulo": "string",
  • "IDCliente": 0,
  • "NomeCliente": "string",
  • "NomeResponsavelCaso": "string",
  • "IDPasta": 0,
  • "NomePasta": "string",
  • "IDContrato": 0,
  • "NomeContrato": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "NumeroLawoffice": 0,
  • "IDCasoPai": 0,
  • "Classe": 1,
  • "DataDeCriacao": "string",
  • "DataDeCriacaoFormatada": "string",
  • "Situacao": 1,
  • "NomeArea": "string",
  • "TipoProcesso": "string",
  • "DataUltimaAlteracao": "string",
  • "HierarquiaProcesso": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "StatusCaso": "string",
  • "Coresponsavel": [
    ],
  • "FaseDoCaso": "string",
  • "ProcessoPai": {
    },
  • "QuantidadeCasosFilho": 0,
  • "IDFornecedor": 0,
  • "PrimeiroPoloAtivo": "string",
  • "PrimeiroPoloPassivo": "string",
  • "NomeFornecedor": "string"
}

Lista casos por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso
Default: 0

NumeroExterno
string

O numero externo do caso
Default: empty string

IdProcesso
integer

O identificador do caso
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista casos por identificadores dos casos

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
ids
required
Array of integers
Example: [1,2]

Os identificadores dos casos

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista casos por identificadores dos casos, numeros externo ou numeros interno

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
IdProcesso
Array of integers
Example: IdProcesso=[1,2]

Os identificadores dos casos

NumeroInterno
Array of integers
Example: NumeroInterno=[1,2]

Os numeros interno dos casos

NumeroExterno
Array of strings
Example: NumeroExterno=["102030-01","102030-02"]

Os numeros externo dos casos

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista casos por situação

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Listar casos ativos?
Default: true

inativos
boolean

Listar casos inativos?
Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista casos por termo e situação

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
termo
required
string

O termo para pesquisa

ativos
boolean

Listar casos ativos?
Default: true

inativos
boolean

Listar casos inativos?
Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista casos por termo e situação

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
termo
required
string

O termo para pesquisa

ativos
boolean

Listar os casos ativos?
Default: true

inativos
boolean

Listar os casos inativos?
Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os ramos judiciais

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém ficha do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "Titulo": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "Situacao": "string",
  • "ExpectativaDeExito": "string",
  • "NomeFilial": "string",
  • "DataDeEntrada": "string",
  • "DataDeEntradaFormatada": "string",
  • "DataDeCitacao": "string",
  • "DataDeCitacaoFormatada": "string",
  • "DataDeDistribuicao": "string",
  • "DataDeDistribuicaoFormatada": "string",
  • "DataPrevistaDeEncerramento": "string",
  • "DataPrevistaDeEncerramentoFormatada": "string",
  • "DataDeEncerramento": "string",
  • "DataDeEncerramentoFormatada": "string",
  • "Foro": "string",
  • "Rito": "string",
  • "ValorCausa": 0,
  • "ValorPrevistoCausa": 0,
  • "ValorContingencia": 0,
  • "IdCaso": 0,
  • "IdFase": 0,
  • "IdPasta": 0,
  • "IdArea": 0,
  • "IdResponsavel": 0,
  • "IDsCoResponsaveis": [
    ],
  • "IDFornecedor": 0
}

Lista casos por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso
Default: 0

NumeroExterno
string

O numero externo do caso
Default: empty string

IdProcesso
integer

O identificador do caso
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os casos em que sou responsável

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
cdResponsavel
required
integer

O identificador do funcionário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os casos por identificador do caso pai

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
cdProcessoPai
required
integer

O identificador do caso pai

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os casos editados recentemente

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fase do caso

Lista as fases ativas

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inclui fase

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDFase
integer
NomeFase
string
TipoProcesso
integer (RamosJudicial)

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

TipoProcessoText
string
Ativo
boolean
IDEscritorio
integer

Responses

Request samples

Content type
application/json
{
  • "IDFase": 0,
  • "NomeFase": "string",
  • "TipoProcesso": -2147483648,
  • "TipoProcessoText": "string",
  • "Ativo": true,
  • "IDEscritorio": 0
}

Response samples

Content type
application/json
{
  • "IDFase": 0,
  • "NomeFase": "string",
  • "TipoProcesso": -2147483648,
  • "TipoProcessoText": "string",
  • "Ativo": true,
  • "IDEscritorio": 0
}

Atualiza fase

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDFase
integer
NomeFase
string
TipoProcesso
integer (RamosJudicial)

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

TipoProcessoText
string
Ativo
boolean
IDEscritorio
integer

Responses

Request samples

Content type
application/json
{
  • "IDFase": 0,
  • "NomeFase": "string",
  • "TipoProcesso": -2147483648,
  • "TipoProcessoText": "string",
  • "Ativo": true,
  • "IDEscritorio": 0
}

Response samples

Content type
application/json
{
  • "cdFaseProcesso": 0,
  • "cdEscritorio": 0,
  • "dsFaseProcesso": "string",
  • "nrGrupo": -2147483648,
  • "isAtivo": true,
  • "nrGrupoText": "string"
}

Lista as fases por ramo judicial

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
nrGrupo
required
integer (RamosJudicial)
Example: -2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista a fase por numero do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
nrSequencia
required
integer

O numero do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "TituloCaso": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "NomeFaseCaso": "string",
  • "IDFaseProcesso": 0,
  • "IdCaso": 0
}

Lista fase do caso por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso
Default: 0

NumeroExterno
string

O numero externo do caso
Default: empty string

IdProcesso
integer

O identificador do caso
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Categoria

Categorias de preço do escritório

Retorna um array com as categorias de preço do escritório de acordo com o filtro informado.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IdEscritorio
required
integer
intfiltroCategoria
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Categorias de preço do escritório

Retorna um array com as categorias de preço do escritório

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IdEscritorio
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Categorias de funcionário

Obtém as categorias de funcionário de acordo com o filtro informado

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IdsMin
required
integer
IdsMax
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cliente

Lista todos os clientes

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém cliente por identificador

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
idCliente
required
integer

O identificador do cliente

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDCliente": 0,
  • "NumeroDoCliente": 0,
  • "Nome": "string",
  • "Apelido": "string",
  • "Tipo": 1,
  • "Email": "string",
  • "Situacao": 1,
  • "MotivoInativacao": "string",
  • "WebSite": "string",
  • "Observacoes": "string",
  • "CPFCNPJ": "string",
  • "TratoConfidencial": true,
  • "InscricaoMunicipal": "string",
  • "DataCriacao": "string",
  • "Estrangeiro": true,
  • "InscricaoEstadual": "string",
  • "Idioma": "string",
  • "TipoEndereco": 1,
  • "Logradouro": "string",
  • "Numero": "string",
  • "Complemento": "string",
  • "Bairro": "string",
  • "Cidade": "string",
  • "Estado": "string",
  • "CEP": "string",
  • "Pais": "string",
  • "EnderecoPrincipal": 0
}

Obtém cliente por identificador

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
idCliente
required
integer

O identificador do cliente

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDCliente": 0,
  • "NumeroDoCliente": 0,
  • "Nome": "string",
  • "Apelido": "string",
  • "Tipo": 1,
  • "Email": "string",
  • "Situacao": 1,
  • "MotivoInativacao": "string",
  • "WebSite": "string",
  • "Observacoes": "string",
  • "CPFCNPJ": "string",
  • "TratoConfidencial": true,
  • "InscricaoMunicipal": "string",
  • "DataCriacao": "string",
  • "Estrangeiro": true,
  • "InscricaoEstadual": "string",
  • "Idioma": "string",
  • "TipoEndereco": 1,
  • "Logradouro": "string",
  • "Numero": "string",
  • "Complemento": "string",
  • "Bairro": "string",
  • "Cidade": "string",
  • "Estado": "string",
  • "CEP": "string",
  • "Pais": "string",
  • "EnderecoPrincipal": 0,
  • "inTemLEDES": true,
  • "inNecessitaDeSolicitanteParaLancamentoDeHoras": true,
  • "Status": 0
}

Lista clientes por filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Listar clientes ativos?
Default: true

inativos
boolean

Listar clientes inativos?
Default: false

apenasMeusCasos
boolean

Default: false

clientesSemCasos
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista endereços de cliente

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista clientes por filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Listar clientes ativos?
Default: true

inativos
boolean

Listar clientes inativos?
Default: false

apenasMeusCasos
boolean

Default: false

clientesSemCasos
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém cliente por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador do cliente

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDCliente": 0,
  • "NumeroDoCliente": 0,
  • "Nome": "string",
  • "Apelido": "string",
  • "Tipo": 1,
  • "Email": "string",
  • "Situacao": 1,
  • "MotivoInativacao": "string",
  • "WebSite": "string",
  • "Observacoes": "string",
  • "CPFCNPJ": "string",
  • "TratoConfidencial": true,
  • "InscricaoMunicipal": "string",
  • "DataCriacao": "string",
  • "Estrangeiro": true,
  • "InscricaoEstadual": "string",
  • "Idioma": "string",
  • "TipoEndereco": 1,
  • "Logradouro": "string",
  • "Numero": "string",
  • "Complemento": "string",
  • "Bairro": "string",
  • "Cidade": "string",
  • "Estado": "string",
  • "CEP": "string",
  • "Pais": "string",
  • "EnderecoPrincipal": 0
}

Lista clientes por identificadores

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idsClientes
required
Array of integers
Example: 1,2

Os identificadores dos clientes

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contato

Obtém informações do contato

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDContato
required
integer

O identificador do contato

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDContato": 0,
  • "IDCliente": 0,
  • "Nome": "string",
  • "Email": "string",
  • "Cargo": "string",
  • "CodigoPais": 0,
  • "DDD": 0,
  • "Telefone": 0,
  • "Ramal": 0
}

Lista contatos

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os contatos do cliente

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCliente
required
integer

O identificador do cliente

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os solicitantes do cliente

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
codCliente
required
integer

O identificador do cliente

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contrato

Obtém o contrato por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDContrato
required
integer

O identificador do contrato

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDContrato": 1,
  • "IDCliente": 1,
  • "Titulo": "Título do contrato",
  • "NomeCliente": "Nome do cliente",
  • "Observacao": "Observação do contrato",
  • "DataInicio": "string",
  • "DataPrevisaoEncerramento": "string",
  • "DataEncerramento": "string",
  • "Situacao": 1
}

Lista os contratos do cliente

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCliente
required
integer

O identificador do cliente

query Parameters
ativos
boolean

Default: true
Lista contratos ativos?

inativos
boolean

Default: false
Lista contratos inativos?

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os contratos do cliente

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCliente
required
integer

O identificador do cliente

query Parameters
ativos
boolean

Default: true
Lista contratos ativos?

inativos
boolean

Default: false
Lista contratos inativos?

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém o contrato por identificador do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDCliente": 0,
  • "Titulo": "string",
  • "Descricao": "string"
}

Lista os contratos por situação (ativos / inativos)

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Default: true
Lista os contratos ativos?

inativos
boolean

Default: false
Lista os contratos inativos?

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Decisões

Lista decisões do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista decisões do caso por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso
Default: 0

NumeroExterno
string

O numero externo do caso
Default: empty string

IdProcesso
integer

O identificador do caso
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista tipos de decisão

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inclui decisão

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array of objects (DTOProcessoDecisaoValor)
inDeEncerramento
boolean
cdParteJuiz
integer
cdParteAdvAcusacao
integer
cdParteAdvDefesa
integer
Observacao
string
vlDeferido
number
DataOcorrencia
string
IdCaso
integer
Decisao
integer
nrExitoPerda
integer
IdCasoDecisao
integer

Responses

Request samples

Content type
application/json
{
  • "Valores": [
    ],
  • "inDeEncerramento": true,
  • "cdParteJuiz": 0,
  • "cdParteAdvAcusacao": 0,
  • "cdParteAdvDefesa": 0,
  • "Observacao": "string",
  • "vlDeferido": 0,
  • "DataOcorrencia": "string",
  • "IdCaso": 0,
  • "Decisao": 0,
  • "nrExitoPerda": 0,
  • "IdCasoDecisao": 0
}

Response samples

Content type
application/json
{
  • "Valores": [
    ],
  • "inDeEncerramento": true,
  • "cdParteJuiz": 0,
  • "cdParteAdvAcusacao": 0,
  • "cdParteAdvDefesa": 0,
  • "Observacao": "string",
  • "vlDeferido": 0,
  • "DataOcorrencia": "string",
  • "IdCaso": 0,
  • "Decisao": 0,
  • "nrExitoPerda": 0,
  • "IdCasoDecisao": 0
}

Atualiza decisão

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da decisão

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array of objects (DTOProcessoDecisaoValor)
inDeEncerramento
boolean
cdParteJuiz
integer
cdParteAdvAcusacao
integer
cdParteAdvDefesa
integer
Observacao
string
vlDeferido
number
DataOcorrencia
string
IdCaso
integer
Decisao
integer
nrExitoPerda
integer
IdCasoDecisao
integer

Responses

Request samples

Content type
application/json
{
  • "Valores": [
    ],
  • "inDeEncerramento": true,
  • "cdParteJuiz": 0,
  • "cdParteAdvAcusacao": 0,
  • "cdParteAdvDefesa": 0,
  • "Observacao": "string",
  • "vlDeferido": 0,
  • "DataOcorrencia": "string",
  • "IdCaso": 0,
  • "Decisao": 0,
  • "nrExitoPerda": 0,
  • "IdCasoDecisao": 0
}

Response samples

Content type
application/json
{
  • "Valores": [
    ],
  • "inDeEncerramento": true,
  • "cdParteJuiz": 0,
  • "cdParteAdvAcusacao": 0,
  • "cdParteAdvDefesa": 0,
  • "Observacao": "string",
  • "vlDeferido": 0,
  • "DataOcorrencia": "string",
  • "IdCaso": 0,
  • "Decisao": 0,
  • "nrExitoPerda": 0,
  • "IdCasoDecisao": 0
}

Obtém decisão com valores

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da decisão

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Valores": [
    ],
  • "inDeEncerramento": true,
  • "cdParteJuiz": 0,
  • "cdParteAdvAcusacao": 0,
  • "cdParteAdvDefesa": 0,
  • "Observacao": "string",
  • "vlDeferido": 0,
  • "DataOcorrencia": "string",
  • "IdCaso": 0,
  • "Decisao": 0,
  • "nrExitoPerda": 0,
  • "IdCasoDecisao": 0
}

Exclui decisão

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da decisão

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Message": "string",
  • "ExceptionMessage": "string"
}

Lista decisões do caso com valores

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Despesas

Total de despesas no mês por profissional (separadas por tipo)

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Gastos": [
    ]
}

Lista próximos lançamentos de despesa de acordo com a data informada

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
dataDespesaString
required
string

A data para pesquisa

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista adiantamentos em aberto

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista categorias de adiantamento

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista fornecedores de adiantamento

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista categorias de reembolso

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista fornecedores de reembolso

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista vouchers por funcionário

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista categorias do voucher

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idVoucher
required
integer

O identificador do voucher

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista fornecedores do voucher

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idVoucher
required
integer

O identificador do voucher

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista despesas

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ano
required
integer

O ano para pesquisa

mes
required
integer

O mês para pesquisa

tipoDePagamento
required
integer (TipoFormaLancamento)
Example: tipoDePagamento=2

-2147483648: None

1: Fundo fixo (Adiantamento)

2: Voucher

3: Reembolso

4: Contas a pagar

5: Estorno

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém despesa por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da despesa

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDDespesa": 0,
  • "IDFuncionarioTransacao": 0,
  • "IDFuncionarioFavorecido": 0,
  • "IDCategoriaLancamento": 0,
  • "IDVoucher": 0,
  • "IDLiberacao": 0,
  • "IDFornecedor": 0,
  • "IDFuncionarioAprovador": 0,
  • "IDFuncionarioIndicado": 0,
  • "IDTarifacao": 0,
  • "IDSolicitacaoMaterialItem": 0,
  • "IDGeracaoDespesa": 0,
  • "IDEscritorio": 0,
  • "ObservacaoAnexo": "string",
  • "Anexos": [
    ],
  • "CategoriaLancamento": "string",
  • "DataDaDespesa": "string",
  • "DataDaDespesaFormatada": "string",
  • "ValorDaDespesa": 0,
  • "DataTransacao": "string",
  • "Moeda": 1,
  • "Documento": "string",
  • "TipoDePagamento": 2,
  • "QtdKMRodado": 0,
  • "TextoDaDespesa": "string",
  • "TemTextoModificado": true,
  • "ValorKMRodado": 0,
  • "Situacao": 2,
  • "DataAprovacao": "string",
  • "ObservacaoAprovador": "string",
  • "Alocacoes": [
    ],
  • "IsEditable": true,
  • "DataTransacaoFormatada": "string",
  • "DataAprovacaoFormatada": "string"
}

Inclui despesa

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
selecionaAprovador
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDDespesa
required
integer

O identificador da despesa.
Se for cadastro, evviar o valor: -2147483648.
Se for atualização, enviar o identificador da despesa.

IDFuncionarioTransacao
integer
IDFuncionarioFavorecido
integer
IDCategoriaLancamento
integer
IDVoucher
integer

O identificador do voucher.

IDLiberacao
integer
IDFornecedor
integer

O identificador do fornecedor.

IDFuncionarioAprovador
integer
IDFuncionarioIndicado
integer
IDTarifacao
integer
IDSolicitacaoMaterialItem
integer
IDGeracaoDespesa
integer
IDEscritorio
integer
ObservacaoAnexo
string
Array of objects (DTOAnexo)

Os anexos da despesa.

CategoriaLancamento
string
DataDaDespesa
string

A data da despesa.

DataDaDespesaFormatada
string

ReadOnly

ValorDaDespesa
number

O valor da despesa.

DataTransacao
string
Moeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

Documento
string
TipoDePagamento
integer (TipoFormaLancamento)

-2147483648: None

1: Fundo fixo (Adiantamento)

2: Voucher

3: Reembolso

4: Contas a pagar

5: Estorno

QtdKMRodado
integer
TextoDaDespesa
string
TemTextoModificado
boolean
ValorKMRodado
number
Situacao
integer (SituacaoLancamentoDespesa)

-2147483648: None

1: Aprovado

2: Aguardando aprovação

3: Pré aprovado

4: Não aprovado

5: Aprovado e pré aprovado

DataAprovacao
string
ObservacaoAprovador
string
Array of objects (DTOAlocacaoDeDespesa)
IsEditable
boolean
DataTransacaoFormatada
string

ReadOnly

DataAprovacaoFormatada
string

ReadOnly

Responses

Request samples

Content type
application/json
{
  • "IDDespesa": 0,
  • "IDFuncionarioTransacao": 0,
  • "IDFuncionarioFavorecido": 0,
  • "IDCategoriaLancamento": 0,
  • "IDVoucher": 0,
  • "IDLiberacao": 0,
  • "IDFornecedor": 0,
  • "IDFuncionarioAprovador": 0,
  • "IDFuncionarioIndicado": 0,
  • "IDTarifacao": 0,
  • "IDSolicitacaoMaterialItem": 0,
  • "IDGeracaoDespesa": 0,
  • "IDEscritorio": 0,
  • "ObservacaoAnexo": "string",
  • "Anexos": [
    ],
  • "CategoriaLancamento": "string",
  • "DataDaDespesa": "string",
  • "DataDaDespesaFormatada": "string",
  • "ValorDaDespesa": 0,
  • "DataTransacao": "string",
  • "Moeda": 1,
  • "Documento": "string",
  • "TipoDePagamento": 2,
  • "QtdKMRodado": 0,
  • "TextoDaDespesa": "string",
  • "TemTextoModificado": true,
  • "ValorKMRodado": 0,
  • "Situacao": 2,
  • "DataAprovacao": "string",
  • "ObservacaoAprovador": "string",
  • "Alocacoes": [
    ],
  • "IsEditable": true,
  • "DataTransacaoFormatada": "string",
  • "DataAprovacaoFormatada": "string"
}

Response samples

Content type
application/json
{
  • "IDDespesa": 0,
  • "IDFuncionarioTransacao": 0,
  • "IDFuncionarioFavorecido": 0,
  • "IDCategoriaLancamento": 0,
  • "IDVoucher": 0,
  • "IDLiberacao": 0,
  • "IDFornecedor": 0,
  • "IDFuncionarioAprovador": 0,
  • "IDFuncionarioIndicado": 0,
  • "IDTarifacao": 0,
  • "IDSolicitacaoMaterialItem": 0,
  • "IDGeracaoDespesa": 0,
  • "IDEscritorio": 0,
  • "ObservacaoAnexo": "string",
  • "Anexos": [
    ],
  • "CategoriaLancamento": "string",
  • "DataDaDespesa": "string",
  • "DataDaDespesaFormatada": "string",
  • "ValorDaDespesa": 0,
  • "DataTransacao": "string",
  • "Moeda": 1,
  • "Documento": "string",
  • "TipoDePagamento": 2,
  • "QtdKMRodado": 0,
  • "TextoDaDespesa": "string",
  • "TemTextoModificado": true,
  • "ValorKMRodado": 0,
  • "Situacao": 2,
  • "DataAprovacao": "string",
  • "ObservacaoAprovador": "string",
  • "Alocacoes": [
    ],
  • "IsEditable": true,
  • "DataTransacaoFormatada": "string",
  • "DataAprovacaoFormatada": "string"
}

Atualiza despesa

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
selecionaAprovador
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDDespesa
required
integer

O identificador da despesa.
Se for cadastro, evviar o valor: -2147483648.
Se for atualização, enviar o identificador da despesa.

IDFuncionarioTransacao
integer
IDFuncionarioFavorecido
integer
IDCategoriaLancamento
integer
IDVoucher
integer

O identificador do voucher.

IDLiberacao
integer
IDFornecedor
integer

O identificador do fornecedor.

IDFuncionarioAprovador
integer
IDFuncionarioIndicado
integer
IDTarifacao
integer
IDSolicitacaoMaterialItem
integer
IDGeracaoDespesa
integer
IDEscritorio
integer
ObservacaoAnexo
string
Array of objects (DTOAnexo)

Os anexos da despesa.

CategoriaLancamento
string
DataDaDespesa
string

A data da despesa.

DataDaDespesaFormatada
string

ReadOnly

ValorDaDespesa
number

O valor da despesa.

DataTransacao
string
Moeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

Documento
string
TipoDePagamento
integer (TipoFormaLancamento)

-2147483648: None

1: Fundo fixo (Adiantamento)

2: Voucher

3: Reembolso

4: Contas a pagar

5: Estorno

QtdKMRodado
integer
TextoDaDespesa
string
TemTextoModificado
boolean
ValorKMRodado
number
Situacao
integer (SituacaoLancamentoDespesa)

-2147483648: None

1: Aprovado

2: Aguardando aprovação

3: Pré aprovado

4: Não aprovado

5: Aprovado e pré aprovado

DataAprovacao
string
ObservacaoAprovador
string
Array of objects (DTOAlocacaoDeDespesa)
IsEditable
boolean
DataTransacaoFormatada
string

ReadOnly

DataAprovacaoFormatada
string

ReadOnly

Responses

Request samples

Content type
application/json
{
  • "IDDespesa": 0,
  • "IDFuncionarioTransacao": 0,
  • "IDFuncionarioFavorecido": 0,
  • "IDCategoriaLancamento": 0,
  • "IDVoucher": 0,
  • "IDLiberacao": 0,
  • "IDFornecedor": 0,
  • "IDFuncionarioAprovador": 0,
  • "IDFuncionarioIndicado": 0,
  • "IDTarifacao": 0,
  • "IDSolicitacaoMaterialItem": 0,
  • "IDGeracaoDespesa": 0,
  • "IDEscritorio": 0,
  • "ObservacaoAnexo": "string",
  • "Anexos": [
    ],
  • "CategoriaLancamento": "string",
  • "DataDaDespesa": "string",
  • "DataDaDespesaFormatada": "string",
  • "ValorDaDespesa": 0,
  • "DataTransacao": "string",
  • "Moeda": 1,
  • "Documento": "string",
  • "TipoDePagamento": 2,
  • "QtdKMRodado": 0,
  • "TextoDaDespesa": "string",
  • "TemTextoModificado": true,
  • "ValorKMRodado": 0,
  • "Situacao": 2,
  • "DataAprovacao": "string",
  • "ObservacaoAprovador": "string",
  • "Alocacoes": [
    ],
  • "IsEditable": true,
  • "DataTransacaoFormatada": "string",
  • "DataAprovacaoFormatada": "string"
}

Response samples

Content type
application/json
{
  • "IDDespesa": 0,
  • "IDFuncionarioTransacao": 0,
  • "IDFuncionarioFavorecido": 0,
  • "IDCategoriaLancamento": 0,
  • "IDVoucher": 0,
  • "IDLiberacao": 0,
  • "IDFornecedor": 0,
  • "IDFuncionarioAprovador": 0,
  • "IDFuncionarioIndicado": 0,
  • "IDTarifacao": 0,
  • "IDSolicitacaoMaterialItem": 0,
  • "IDGeracaoDespesa": 0,
  • "IDEscritorio": 0,
  • "ObservacaoAnexo": "string",
  • "Anexos": [
    ],
  • "CategoriaLancamento": "string",
  • "DataDaDespesa": "string",
  • "DataDaDespesaFormatada": "string",
  • "ValorDaDespesa": 0,
  • "DataTransacao": "string",
  • "Moeda": 1,
  • "Documento": "string",
  • "TipoDePagamento": 2,
  • "QtdKMRodado": 0,
  • "TextoDaDespesa": "string",
  • "TemTextoModificado": true,
  • "ValorKMRodado": 0,
  • "Situacao": 2,
  • "DataAprovacao": "string",
  • "ObservacaoAprovador": "string",
  • "Alocacoes": [
    ],
  • "IsEditable": true,
  • "DataTransacaoFormatada": "string",
  • "DataAprovacaoFormatada": "string"
}

Obtém valor km rodado

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
0.5

Expectativa reivindicação

Obtém valores do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Risco": 0,
  • "TipoRisco": 0,
  • "ValorDaCausa": 0,
  • "MoedaValorDaCausa": 0,
  • "ValorDaCausaAtualizado": 0,
  • "MoedaValorDaCausaAtualizado": 0,
  • "ValorPrevisto": 0,
  • "MoedaValorPrevisto": 0,
  • "ValorContingencia": 0,
  • "ValorContingenciaAtualizado": 0,
  • "EditarCamposValoresEObrigacoes": true,
  • "MoedaValorContingencia": 0,
  • "Pedidos": [
    ]
}

Lista pedidos com histórico

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Pedidos": [
    ],
  • "vlValorPrevistoAtualizado": 0,
  • "vlValorContigenciaAtualizado": 0
}

Atualiza valores por caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
Nome
required
string

O nome da propriedade
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

Valor
required
string

O valor a ser incluído na propriedade
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "Titulo": "string",
  • "IDCliente": 0,
  • "NomeCliente": "string",
  • "NomeResponsavelCaso": "string",
  • "IDPasta": 0,
  • "NomePasta": "string",
  • "IDContrato": 0,
  • "NomeContrato": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "NumeroLawoffice": 0,
  • "IDCasoPai": 0,
  • "Classe": 1,
  • "DataDeCriacao": "string",
  • "DataDeCriacaoFormatada": "string",
  • "Situacao": 1,
  • "NomeArea": "string",
  • "TipoProcesso": "string",
  • "DataUltimaAlteracao": "string",
  • "HierarquiaProcesso": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "StatusCaso": "string",
  • "Coresponsavel": [
    ],
  • "FaseDoCaso": "string",
  • "ProcessoPai": { },
  • "QuantidadeCasosFilho": 0,
  • "IDFornecedor": 0,
  • "PrimeiroPoloAtivo": "string",
  • "PrimeiroPoloPassivo": "string",
  • "NomeFornecedor": "string"
}

Obtém valores do caso inicial

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Risco": "string",
  • "ValorDaCausa": "string",
  • "ValorDaCausaAtualizado": "string",
  • "ValorPrevisto": "string",
  • "ValorContingencia": "string",
  • "TotalDosPedidos": "string"
}

Funcionário

Lista os fornecedores ativos do escritório

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista funcionários por identificadores

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
ids
required
Array of integers

Os identificadores dos funcionários

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém funcionário por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDFuncionario
required
integer

O identificador do funcionário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDFuncionario": 0,
  • "Nome": "string",
  • "Apelido": "string",
  • "Logradouro": "string",
  • "NumeroLogradouro": "string",
  • "Bairro": "string",
  • "Cidade": "string",
  • "Estado": "string",
  • "Complemento": "string",
  • "CEP": "string",
  • "Email": "string",
  • "CPF": "string",
  • "RG": "string",
  • "EstadoCivil": 1,
  • "DataDeNascimento": "string",
  • "DataDeNascimentoFormatada": "string",
  • "Cargo": "string",
  • "DataDeAdmissao": "string",
  • "DataDeAdmissaoFormatada": "string",
  • "DataDeDemissao": "string",
  • "DataDeDemissaoFormatada": "string",
  • "Oab": "string",
  • "NumeroDeDependentes": 0,
  • "Admin": "true or false",
  • "Observacoes": "string",
  • "VinculoEmpregaticio": 2
}

Lista funcionários por situação (ativo / inativo)

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ativos
boolean

Default: true
Listar funcionários ativos?

inativos
boolean

Default: false
Listar funcionários inativos?

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista funcionários por identificador da área e situação do funcionário (ativo / inativo)

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDArea
required
integer

O identificador da área

query Parameters
ativos
boolean

Default: true
Lista funcionários ativos?

inativos
boolean

Default: false
Lista funcionários inativos?

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista áreas do funcionário

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDFuncionario
required
integer

O identificador do funcionário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista funcionários do escritório

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDEscritorio
required
integer

O identificador do escritório

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os funcionários ativos do escritório

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Garantia

Obtém garantia por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCasoGarantia
required
integer

O identificador da garantia

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "TituloCaso": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "IdCasoGarantia": 0,
  • "Movimentacoes": [
    ],
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "IdGarantia": 0,
  • "Garantia": "string",
  • "idCaso": 0,
  • "DataDeposito": "string",
  • "DataDepositoFormatada": "string",
  • "ValorGarantia": 0,
  • "ValorGarantiaAtualizado": 0,
  • "Observacao": "string",
  • "Identificacao": "string",
  • "ValorSaldoRemanescente": 0,
  • "AlteraPedidos": true,
  • "IdsPedidos": [
    ],
  • "NrForma": 0
}

Lista garantias do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista garantias

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista garantias por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

Default: 0
O numero interno do caso

NumeroExterno
string

Default: empty string
O numero externo do caso

IdProcesso
integer

Default: 0
O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inclui garantia no caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NomeCliente
string
TituloCaso
string
NumeroInterno
string
NumeroExterno
string
IdCasoGarantia
integer
Array of objects (DTOMovimentacao)
Moeda
string
NrMoeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

IdGarantia
integer
Garantia
string
idCaso
integer
DataDeposito
string
DataDepositoFormatada
string
ValorGarantia
number
ValorGarantiaAtualizado
number
Observacao
string
Identificacao
string
ValorSaldoRemanescente
number
AlteraPedidos
boolean
IdsPedidos
Array of integers
NrForma
integer

Responses

Request samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "TituloCaso": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "IdCasoGarantia": 0,
  • "Movimentacoes": [
    ],
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "IdGarantia": 0,
  • "Garantia": "string",
  • "idCaso": 0,
  • "DataDeposito": "string",
  • "DataDepositoFormatada": "string",
  • "ValorGarantia": 0,
  • "ValorGarantiaAtualizado": 0,
  • "Observacao": "string",
  • "Identificacao": "string",
  • "ValorSaldoRemanescente": 0,
  • "AlteraPedidos": true,
  • "IdsPedidos": [
    ],
  • "NrForma": 0
}

Response samples

Content type
application/json
1

Atualiza garantia do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NomeCliente
string
TituloCaso
string
NumeroInterno
string
NumeroExterno
string
IdCasoGarantia
integer
Array of objects (DTOMovimentacao)
Moeda
string
NrMoeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

IdGarantia
integer
Garantia
string
idCaso
integer
DataDeposito
string
DataDepositoFormatada
string
ValorGarantia
number
ValorGarantiaAtualizado
number
Observacao
string
Identificacao
string
ValorSaldoRemanescente
number
AlteraPedidos
boolean
IdsPedidos
Array of integers
NrForma
integer

Responses

Request samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "TituloCaso": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "IdCasoGarantia": 0,
  • "Movimentacoes": [
    ],
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "IdGarantia": 0,
  • "Garantia": "string",
  • "idCaso": 0,
  • "DataDeposito": "string",
  • "DataDepositoFormatada": "string",
  • "ValorGarantia": 0,
  • "ValorGarantiaAtualizado": 0,
  • "Observacao": "string",
  • "Identificacao": "string",
  • "ValorSaldoRemanescente": 0,
  • "AlteraPedidos": true,
  • "IdsPedidos": [
    ],
  • "NrForma": 0
}

Response samples

Content type
application/json
{
  • "NomeCliente": "string",
  • "TituloCaso": "string",
  • "NumeroInterno": "string",
  • "NumeroExterno": "string",
  • "IdCasoGarantia": 0,
  • "Movimentacoes": [
    ],
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "IdGarantia": 0,
  • "Garantia": "string",
  • "idCaso": 0,
  • "DataDeposito": "string",
  • "DataDepositoFormatada": "string",
  • "ValorGarantia": 0,
  • "ValorGarantiaAtualizado": 0,
  • "Observacao": "string",
  • "Identificacao": "string",
  • "ValorSaldoRemanescente": 0,
  • "AlteraPedidos": true,
  • "IdsPedidos": [
    ],
  • "NrForma": 0
}

Inclui movimentação na garantia

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IdMovimentacao
integer
IdCasoGarantia
integer
vlGarantiaAtualizado
number
Moeda
string
NrMoeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

TipoDeMovimentacao
string
NrTipoDeMovimentacao
integer (TipoDeMovimentacao)

-2147483648: None

1: Transferência

2: Recuperação

Transferido
string
Justificativa
string
ValorMovimentacao
number
ValorSaldoRemanescente
number
StatusAlvara
string
EnumStatusAlvara
integer (StatusAlvara)

-2147483648: None

1: Aguardando expedição alvará

2: Alvará retirado

3: Alvará recuperado

DataMovimentacao
string

Responses

Request samples

Content type
application/json
{
  • "IdMovimentacao": 0,
  • "IdCasoGarantia": 0,
  • "vlGarantiaAtualizado": 0,
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "TipoDeMovimentacao": "string",
  • "NrTipoDeMovimentacao": 1,
  • "Transferido": "string",
  • "Justificativa": "string",
  • "ValorMovimentacao": 0,
  • "ValorSaldoRemanescente": 0,
  • "StatusAlvara": "string",
  • "EnumStatusAlvara": 1,
  • "DataMovimentacao": "string"
}

Response samples

Content type
application/json
1

Obtém movimentação da garantia por identificador da garantia e identificador da movimentação

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDGarantia
required
integer

O identificador da garantia

IDGarantiaMovimentacao
required
integer

O identificador da movimentação da garantia

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IdMovimentacao": 0,
  • "IdCasoGarantia": 0,
  • "vlGarantiaAtualizado": 0,
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "TipoDeMovimentacao": "string",
  • "NrTipoDeMovimentacao": 1,
  • "Transferido": "string",
  • "Justificativa": "string",
  • "ValorMovimentacao": 0,
  • "ValorSaldoRemanescente": 0,
  • "StatusAlvara": "string",
  • "EnumStatusAlvara": 1,
  • "DataMovimentacao": "string"
}

Atualiza movimentação da garantia

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IdMovimentacao
integer
IdCasoGarantia
integer
vlGarantiaAtualizado
number
Moeda
string
NrMoeda
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

TipoDeMovimentacao
string
NrTipoDeMovimentacao
integer (TipoDeMovimentacao)

-2147483648: None

1: Transferência

2: Recuperação

Transferido
string
Justificativa
string
ValorMovimentacao
number
ValorSaldoRemanescente
number
StatusAlvara
string
EnumStatusAlvara
integer (StatusAlvara)

-2147483648: None

1: Aguardando expedição alvará

2: Alvará retirado

3: Alvará recuperado

DataMovimentacao
string

Responses

Request samples

Content type
application/json
{
  • "IdMovimentacao": 0,
  • "IdCasoGarantia": 0,
  • "vlGarantiaAtualizado": 0,
  • "Moeda": "string",
  • "NrMoeda": 1,
  • "TipoDeMovimentacao": "string",
  • "NrTipoDeMovimentacao": 1,
  • "Transferido": "string",
  • "Justificativa": "string",
  • "ValorMovimentacao": 0,
  • "ValorSaldoRemanescente": 0,
  • "StatusAlvara": "string",
  • "EnumStatusAlvara": 1,
  • "DataMovimentacao": "string"
}

Response samples

Content type
application/json
true

Lista os identificadores dos pedidos da garantia

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDProcessoGarantia
required
integer

O identificador da garantia

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • 0
]

Hierarquia

Lista os ritos de acordo com os filtros informados

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrClasse
integer

Default: null

cdRitoDoProcessoPai
integer

Default: null

nrRamoJudicial
integer

Default: null

cdForo
integer

Default: null

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os tipos de processos administrativos

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista as regiões de acordo com o filtro informado

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrRamoJudicial
integer

Default: null

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os grupos foro por ramo de justiça, estado, grupo de família e tipo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrRamoJudicial
integer

Default: null

dsUF
string

Default: null

nrGrupoFamilia
integer

Default: null

cdRegiao
integer

Default: null

nrTipo
integer

Default: null

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os grupos de foro por ramo de justiça, estado e grupo de família

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrRamoJudicial
integer

Default: null

dsUF
string

Default: null

nrGrupoFamilia
integer

Default: null

cdRegiao
integer

Default: null

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os grupos de foro superiores por ramo judicial

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrRamoJudicial
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém as informações do grupo foro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
cdGrupoForo
required
integer
cdUF
required
string
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "inAdmiteMunicipio": true,
  • "cdRegiao": 0,
  • "cdUF": "string",
  • "cdLocalGrupoForo": 0,
  • "dsNome": "string",
  • "nrInstancia": 0,
  • "cdGrupoFamilia": 0,
  • "nrRamoJudicial": -2147483648,
  • "cdGrupoForo": 0,
  • "cdGrupoPai": 0,
  • "Foros": [
    ],
  • "GrupoPai": { },
  • "Grupos": [
    ]
}

Lista as UFs de acordo com a região e ramo judicial

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
regiao
required
integer
nrRamoJudicial
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • "SP",
  • "RJ"
]

Lista as fases de processo por ramo judicial

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nrRamoJudicial
integer

Default: null

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Informações adicionais

Obtém Informação adicional por identificador

Obtém os dados de uma Informação adicional de acordo com o identificador informado.

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDParametroDadoComplementar
required
integer

O identificador da Informação adicional

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDParametroDadoComplementar": -2147483648,
  • "IDCliente": -2147483648,
  • "TipoCampoDadoComplementar": 1,
  • "TituloDadoComplementar": "Nova Informação adicional",
  • "TamanhoCampo": 200,
  • "Obrigatorio": false,
  • "Ativo": true,
  • "Ordem": 1,
  • "TipoDeVinculo": "Global",
  • "Opcoes": [
    ],
  • "VinculadoNosTiposDeProcesso": [
    ],
  • "VinculadoNasAreas": [
    ]
}

Lista todas as Informações adicionais

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista Informações adicionais por filtro

Lista as Informações adicionais de acordo com o filtro informado.

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
clienteId
integer

O identificador do cliente

areaId
integer

O identificador da área

tipoCaso
integer (RamosJudicial)
Example: tipoCaso=-2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

mostraInativo
boolean

Listar as Informações adicionais inativas? (Default: false)

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista Informações adicionais por tipo de caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
tipoCaso
required
integer (RamosJudicial)
Example: -2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

query Parameters
mostraInativos
boolean

Listar as Informações adicionais inativas? (Default: false)

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista Informações adicionais por caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do processo

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista Informações adicionais por caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do processo. (Default: 0)

NumeroExterno
string

O numero externo do processo. (Default: empty string)

IdProcesso
integer

O identificador do processo. (Default: 0)

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cadastra Informações adicionais (completa)

Cadastrar novas Informações adicionais.

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
IDParametroDadoComplementar
required
integer

O identificador da Informação adicional.
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

IDCliente
integer

O identificador do cliente. Se o valor for maior que 0, a Informação adicional será vinculada ao cliente.

TipoCampoDadoComplementar
required
object (TipoDadoComplementar)

O tipo do dado complementar

-2147483648: None

1: CaixaTexto

2: NumericoDecimal

3: NumericoInteiro

4: DataHora

5: CaixaTextoMultiLinha

6: CaixaCombo

7: CaixaDeMarcacao

8: PagadorCombo

9: EmpresaCombo

10: ClienteCombo

11: GrupoClienteCombo

12: ContratoSelecao

13: ClienteSelecao

14: CasoSelecao

15: AreaCombo

16: ProfissionalCombo

TituloDadoComplementar
required
string

O titulo da Informação adicional

TamanhoCampo
required
integer

O tamanho do campo.
Required apenas quando TipoCampoDadoComplementar for de tipo 1: CaixaTexto

Obrigatorio
required
boolean

Indica se o preenchimento dessa Informação adicional é obrigatória

Ativo
required
boolean

Indica se essa Informação adicional está ativa ou inativa

Ordem
integer

A ordem de exibição dessa Informação adicional

TipoDeVinculo
string

Indica quais os tipos de vínculo dessa Informação adicional.
ReadOnly: O campo deve ser enviado no objeto mas não deve ser preenchido.

required
Array of objects (DTOItemDadoComplementar)

As opções da Informação adicional.
Required apenas quando TipoCampoDadoComplementar for dos tipos 6: CaixaCombo ou 7: CaixaDeMarcacao.

Array of objects (DTOTipoProcesso)

Vincular dado complementar nos tipos de processos informados.
No GET indica os tipos de processo em que a informação adicional está vinculada, em POST e PUT indica em quais tipos de processo a Informação adicional deve ser vinculada.

Array of objects (DTOAreaInformacaoAdicional)

Vincular dado complementar nas áreas informadas.
No GET indica as áreas em que a informação adicional está vinculada, em POST e PUT indica em quais áreas a Informação adicional deve ser vinculada.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Atualiza Informações adicionais (completa)

Atualiza as Informações adicionais informadas.

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
IDParametroDadoComplementar
required
integer

O identificador da Informação adicional.
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

IDCliente
integer

O identificador do cliente. Se o valor for maior que 0, a Informação adicional será vinculada ao cliente.

TipoCampoDadoComplementar
required
object (TipoDadoComplementar)

O tipo do dado complementar

-2147483648: None

1: CaixaTexto

2: NumericoDecimal

3: NumericoInteiro

4: DataHora

5: CaixaTextoMultiLinha

6: CaixaCombo

7: CaixaDeMarcacao

8: PagadorCombo

9: EmpresaCombo

10: ClienteCombo

11: GrupoClienteCombo

12: ContratoSelecao

13: ClienteSelecao

14: CasoSelecao

15: AreaCombo

16: ProfissionalCombo

TituloDadoComplementar
required
string

O titulo da Informação adicional

TamanhoCampo
required
integer

O tamanho do campo.
Required apenas quando TipoCampoDadoComplementar for de tipo 1: CaixaTexto

Obrigatorio
required
boolean

Indica se o preenchimento dessa Informação adicional é obrigatória

Ativo
required
boolean

Indica se essa Informação adicional está ativa ou inativa

Ordem
integer

A ordem de exibição dessa Informação adicional

TipoDeVinculo
string

Indica quais os tipos de vínculo dessa Informação adicional.
ReadOnly: O campo deve ser enviado no objeto mas não deve ser preenchido.

required
Array of objects (DTOItemDadoComplementar)

As opções da Informação adicional.
Required apenas quando TipoCampoDadoComplementar for dos tipos 6: CaixaCombo ou 7: CaixaDeMarcacao.

Array of objects (DTOTipoProcesso)

Vincular dado complementar nos tipos de processos informados.
No GET indica os tipos de processo em que a informação adicional está vinculada, em POST e PUT indica em quais tipos de processo a Informação adicional deve ser vinculada.

Array of objects (DTOAreaInformacaoAdicional)

Vincular dado complementar nas áreas informadas.
No GET indica as áreas em que a informação adicional está vinculada, em POST e PUT indica em quais áreas a Informação adicional deve ser vinculada.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
"As Informações adicionais foram atualizadas corretamente."

Edita propriedades específicas da Informação adicional

Propriedades disponíveis para edição
TituloDadoComplementar, TamanhoCampo, Obrigatorio, Ativo.

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
IDParametroDadoComplementar
required
integer

O identificador da Informação adicional

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
Nome
required
string

O nome da propriedade a editar

Valor
required
string

O novo valor a gravar

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "IDParametroDadoComplementar": -2147483648,
  • "IDCliente": -2147483648,
  • "TipoCampoDadoComplementar": 1,
  • "TituloDadoComplementar": "Nova Informação adicional",
  • "TamanhoCampo": 200,
  • "Obrigatorio": false,
  • "Ativo": true,
  • "Ordem": 1,
  • "TipoDeVinculo": "Global",
  • "Opcoes": [
    ],
  • "VinculadoNosTiposDeProcesso": [
    ],
  • "VinculadoNasAreas": [
    ]
}

Informações adicionais (valor)

Incluir valor em processo utilizando informação adicional

Inclui valores em processos utilizando Informação adicional.

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
IDProcessoValorDadoComplementar
integer

O identificador do valor gravado no processo utilizando a Informação adicional.
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

IDCaso
required
integer

O identificador do caso.

IDParametroDadoComplementar
required
integer

O identificador da Informação adicional.

Valor
required
string

O valor a ser gravado / atualizado na Informação adicional

DataDeAtualizacao
required
string

A data de atualização do valor

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
"Os valores foram incluídos corretamente."

Natureza

Lista naturezas do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista naturezas do caso por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

Default: 0
O numero interno do caso

NumeroExterno
string

Default: empty string
O numero externo do caso

IdProcesso
integer

Default: 0
O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

País

Países

Obtém a lista de países

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Estados

Obtém a lista de estados do Brasil

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cidades

Lista as cidades de acordo com o estado informado

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
uf
required
string
Example: uf=SP

UF para obter as cidades

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Partes

Lista envolvimentos de parte

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
tipoProcesso
required
integer (RamosJudicial)
Example: tipoProcesso=-2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

aplicabilidade
required
integer (PartePapelAplicabilidade)
Example: aplicabilidade=1

-2147483648: None

1: Processo

2: Contrato

tipoPolo
required
integer (Polo)
Example: tipoPolo=1

-2147483648: None

1: Ativo

2: Passivo

3: Terceiro

4: Nenhum

5: Outro envolvido

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista partes do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pesquisa de partes

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
nome
required
string

O texto para pesquisa
Mínimo de 4 caracteres

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista partes por do caso por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso
Default: 0

NumeroExterno
string

O numero externo do caso
Default: empty string

IdProcesso
integer

O identificador do caso
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inserir / atualizar partes

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
IdParte
integer

Se for menor ou igual a zero insere uma nova parte, senão, atualiza a parte de acordo com o identificador informado.

IdCliente
integer
NrCliente
integer
inContato
boolean
inMigradoParaNovosContatos
boolean
IdFuncionario
integer
Polo
integer (PoloLawOffice)

0: None

1: Ativo

2: Passivo

3: Terceiro

4: Nenhum

5: Outro envolvido

TipoPessoa
integer (TipoPessoa)

0: None

1: Pessoa física

2: Pessoa jurídica

CPF
string
CNPJ
string
RG
string
nomeParte
string
Nome
string
RazaoSocial
string
NomeFantasia
string
NomeContato
string
Email
string
TipoEnvolvimento
integer
TipoEnvolvimentoPapel
string
PoloPrincipal
boolean
Observacoes
string
object (DTOEnderecoParte)
Array of objects (DTOTelefoneParte)
object (DTODadosAdvogado)
Array of objects (DTOEnvolvimento)
NomeCliente
string

Preenchido apenas na pesquisa de partes do caso

TituloCaso
string

Preenchido apenas na pesquisa de partes do caso

NumeroInterno
string

Preenchido apenas na pesquisa de partes do caso

NumeroExterno
string

Preenchido apenas na pesquisa de partes do caso

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Desvincular parte do caso

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
processo
required
integer

O identificador do caso

parte
required
integer

O identificador da parte

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "Message": "string",
  • "ExceptionMessage": "string"
}

Pedidos

Lista pedidos do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer
Example: 1

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Atualiza / inclui pedidos do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
Risco
integer
ValorPrevisto
number
ValorContingencia
number
Nome
string
Situacao
integer
IdProcessoExpectativaReivindicacao
integer
IdPedidoCausa
integer
Justificativa
string
MoedaValorPrevisto
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

MoedaValorContingenciado
integer (Moeda)

-2147483648: None

1: Real

2: Dólar americano

3: Euro

DataConstituicao
string
DataVencimento
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "Message": "string",
  • "ExceptionMessage": "string"
}

Lista pedidos por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

Default: 0
O numero interno do caso

NumeroExterno
string

Default: empty string
O numero externo do caso

IdProcesso
integer

Default: 0
O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista possíveis status do pedido

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista possíveis êxitos do pedido

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista pedidos por ramo judicial

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
tipoJustica
required
integer (RamosJudicial)
Example: tipoJustica=-2147483648

O tipo do processo

1: Administrativo

2: Interno (Consultivo)

3: Judicial Estadual

4: Judicial Federal

5: Judicial Trabalhista

6: Interno do escritório

7: Militar Estadual

8: Eleitoral

9: Militar da União

10: Consultivo contrato

11: Análise Documental

12: Gestão de Ativos

13: Societário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista pedido causas

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista identificadores de garantias dos pedidos

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCasoPedido
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • 0
]

Produtos

Lista produtos do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
IDCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista produtos do caso por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

Default: 0
O numero interno do caso

NumeroExterno
string

Default: empty string
O numero externo do caso

IdProcesso
integer

Default: 0
O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Push

Lista publicações por filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ano
required
integer
mes
required
integer
novos
boolean

Default: true

visualizados
boolean

Default: true

finalizados
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém publicação por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDItemPublicacao": 0,
  • "DataDePublicacao": "string",
  • "Status": 1,
  • "Text": "string",
  • "IDProcesso": 0,
  • "DataDeDisponibilizacao": "string",
  • "IDAutor": 0,
  • "Situacao": 2,
  • "TextContinuacao": "string",
  • "IDAndamento": 0,
  • "TipoDePush": 1
}

Lista ações de publicação

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Incluir item de agenda na publicação

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDCaso
integer
IDItemAgenda
integer
IDItemAgendaPai
integer

Se for uma subtarefa, esse valor é o identificador da tarefa pai, senão o valor será nulo

IDFuncionarioCriador
integer
Tipo
integer (TipoItemAgenda)

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

Titulo
string
IDTitulocobranca
integer
Data
string
Lembrete
string
DataLimite
string
FuncionarioExecutor
integer
FuncionarioResponsavel
integer
FuncionariosParticipantes
Array of integers
Observacao
string
DataRealizacao
string
IDStatusEncerramentoItemAgenda
integer
ObservacaoRegistroRealizacao
string
Situacao
integer (SituacaoDoItemAgenda)

-2147483648: None

1: Em aberto,

2: Agendada,

3: Realizada,

4: Ocupado,

5: A confirmar

6: Desmarcável

DataFormatada
string
DataLimiteFormatada
string
IDForo
integer
Local
string
NomeFuncionarioExecutor
string
DataCriacao
string
DataCriacaoFormatada
string
DataRealizacaoFormatada
string
DataRegistroRealizacao
string
DataRegistroRealizacaoFormatada
string
SituacaoLembrete
integer (SituacaoLembrete)

-2147483648: None

1: A notificar

2: Descartado por ambos

3: Notificado

4: Descartado pelo executor

5: Descartado pelo responsável

IsEditable
boolean
Concluido
boolean

Indica se o item está concluído

StatusEncerramentoItemAgenda
string
NomeClienteFormatado
string
AreaFormatada
string
TituloCasoFormatado
string
NumeroDoCaso
integer
TituloCaso
string
NumeroExternoCaso
string
Cliente
string
Executor
string
NumeroPasta
integer
Assunto
string
NumeroInterno
string
Rito
string
Vencido
string
SituacaoString
string
PoloAtivo
string
PoloPassivo
string
Classificacao
string
ExecutionID
string

Responses

Request samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Altera status da publicação

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDItemPublicacao
integer
DataDePublicacao
string
Status
integer (StatusItemPublicacao)

1: Nova

2: Visualizada

4: Finalizada

Text
string
IDProcesso
integer
DataDeDisponibilizacao
string
IDAutor
integer
Situacao
integer (SituacaoDeAndamentoPublicacao)

-2147483648: None

1: A aprovar

2: Aprovado

3: Publicado

TextContinuacao
string
IDAndamento
integer
TipoDePush
integer (TipoDePush)

-2147483648: None

1: Publicação

2: Andamento

Responses

Request samples

Content type
application/json
{
  • "IDItemPublicacao": 0,
  • "DataDePublicacao": "string",
  • "Status": 1,
  • "Text": "string",
  • "IDProcesso": 0,
  • "DataDeDisponibilizacao": "string",
  • "IDAutor": 0,
  • "Situacao": 2,
  • "TextContinuacao": "string",
  • "IDAndamento": 0,
  • "TipoDePush": 1
}

Response samples

Content type
application/json
{
  • "IDItemPublicacao": 0,
  • "DataDePublicacao": "string",
  • "Status": 1,
  • "Text": "string",
  • "IDProcesso": 0,
  • "DataDeDisponibilizacao": "string",
  • "IDAutor": 0,
  • "Situacao": 2,
  • "TextContinuacao": "string",
  • "IDAndamento": 0,
  • "TipoDePush": 1
}

Vincular publicações com caso

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDsPublicacao
required
Array of integers
IDProcesso
required
integer

O identificador do processo
Required
- POST: A propriedade deve ser enviada com o valor -2147483648
- PUT e DELETE: Preencher com o valor da propriedade já existente.

Responses

Request samples

Content type
application/json
{
  • "IDsPublicacao": [
    ],
  • "IDProcesso": 0
}

Response samples

Content type
application/json
true

Finalizar publicações

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
true

Adicionar prazo com publicação

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
cdPublicacao
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDItemAgenda
integer
IDFuncionarioInclusao
integer
IDTituloCobranca
integer
IDFuncionario
integer
IDFuncionarioExecutor
integer
SituacaoLembrete
integer (SituacaoLembrete)

-2147483648: None

1: A notificar

2: Descartado por ambos

3: Notificado

4: Descartado pelo executor

5: Descartado pelo responsável

Observacoes
string
Assunto
string
DataRegistro
string
DataPublicacao
string
ClassificacaoDePrazo
integer
DataRealizacao
string
Tipo
any (TipoDeCompromisso)

-2147483648: None

1: DeTrabalho

2: Particular

3: Prazo

4: Publicacao

IDFuncionarioResponsavelCumprimento
integer

Responses

Request samples

Content type
application/json
{
  • "IDItemAgenda": 0,
  • "IDFuncionarioInclusao": 0,
  • "IDTituloCobranca": 0,
  • "IDFuncionario": 0,
  • "IDFuncionarioExecutor": 0,
  • "SituacaoLembrete": 1,
  • "Observacoes": "string",
  • "Assunto": "string",
  • "DataRegistro": "string",
  • "DataPublicacao": "string",
  • "ClassificacaoDePrazo": 0,
  • "DataRealizacao": "string",
  • "Tipo": 1,
  • "IDFuncionarioResponsavelCumprimento": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Inclui timesheet com publicação

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
cdPublicacao
required
integer

O identificador da publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrLEDESTaskCode
string
NrLEDESActivityCode
string
DsSolicitante
string
CdSolicitante
integer
IDCliente
integer
IDProcesso
integer
IDFuncionario
integer
NomeFuncionario
string
Descricao
string
DataExecucao
string
TipoDeTarefa
integer (TipoDeTarefa)

-2147483648: None

1: Aprimoramento profissional

2: Horas debitáveis

3: Horas de relacionamento

4: Horas não debitáveis

QtdMinutos
integer
IDFuncionarioResponsavel
integer
IDFuncionarioBeneficiario
integer
IDFechamentoPlanilhaHoras
integer
IDRegistroFechamentoContaCliente
integer
SituacaoDaPlanilha
integer (SituacaoDaPlanilhaDeHoras)

-2147483648: None

1: Aberta

2: A aprovar

3: Aprovada

4: Não aprovada

MotivoDaRecusa
string
IDClassificacaoHorasDebitaveis
integer
IDClassificacao
integer
DsClassificacao
string
Titulo
string
IDAndamento
integer
IDArea
integer
IDContrato
integer
DataLancamento
string
InFaturadoPreVersao35
boolean
IDLancamentoDeHoras
integer
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Response samples

Content type
application/json
true

Tabela de preço

Lista as tabelas de preço

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idEscritorio
required
integer

O identificador do escritório

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tabela preço categoria

Lista categorias de tabela de preço

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idEscritorio
required
integer
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tarefa

Lista compromissos por filtro

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
cdProcesso
required
integer

O identificador do processo

ignoraIdFuncionario
required
boolean
filtro
required
integer (FiltroSituacaoItemAgenda)
Example: 1

1: Todos

2: Finalizados

3: Em aberto

query Parameters
numeroDeRecorrencias
integer

Default: 10

subcasos
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém item de agenda por identificador e tipo

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador do item de agenda

tipo
required
integer (TipoItemAgenda)
Example: 1

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Lista itens de agenda por funcionários e filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
idsFuncionarios
required
string
Example: idsFuncionarios="1,15,20"

Os identificadores dos funcionários separados por virgula

dataInicio
required
string

A data inicial para pesquisa

dataFim
string

A data final para pesquisa

listaPorExecutor
boolean

Listar por executor?
Default: false

listaPorParticipante
boolean

Listar por participante?
Default: false

listaPorDelegante
boolean

Listar por delegante?
Default: false

typeMode
integer (TipoDeConsultaCalendario)
Example: typeMode=1

1: dayGridMonth

2: timeGridWeek

3: timeGridDay

4: listWeek

5: interval

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Editar propriedades específicas

Propriedades que podem ser alteradas
- Atividade externa: ExecutionID
- Audiência: ExecutionID
- Compromisso: ExecutionID

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
IDItemAgenda
required
integer

O identificador do item de agenda

Tipo
required
integer (TipoItemAgenda)
Example: Tipo=1

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
Array ()
Nome
required
string

O nome da propriedade a editar

Valor
required
string

O novo valor a gravar

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Lista quantidade de itens de agenda para os próximos 7 dias

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
10

Lista próximos compromissos por profissional

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
data
required
string

A data para pesquisa

quantidadeEventosARetornar
integer

A quantidade de itens de agenda para listar
Default: 4

idCaso
integer

O identificador do caso para filtrar os resultados

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista itens de agenda por período

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ano
required
integer

O ano para pesquisa

mes
required
integer

O mês para pesquisa

dia
integer

O dia para pesquisa

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cadastrar item de agenda

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDCaso
integer
IDItemAgenda
integer
IDItemAgendaPai
integer

Se for uma subtarefa, esse valor é o identificador da tarefa pai, senão o valor será nulo

IDFuncionarioCriador
integer
Tipo
integer (TipoItemAgenda)

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

Titulo
string
IDTitulocobranca
integer
Data
string
Lembrete
string
DataLimite
string
FuncionarioExecutor
integer
FuncionarioResponsavel
integer
FuncionariosParticipantes
Array of integers
Observacao
string
DataRealizacao
string
IDStatusEncerramentoItemAgenda
integer
ObservacaoRegistroRealizacao
string
Situacao
integer (SituacaoDoItemAgenda)

-2147483648: None

1: Em aberto,

2: Agendada,

3: Realizada,

4: Ocupado,

5: A confirmar

6: Desmarcável

DataFormatada
string
DataLimiteFormatada
string
IDForo
integer
Local
string
NomeFuncionarioExecutor
string
DataCriacao
string
DataCriacaoFormatada
string
DataRealizacaoFormatada
string
DataRegistroRealizacao
string
DataRegistroRealizacaoFormatada
string
SituacaoLembrete
integer (SituacaoLembrete)

-2147483648: None

1: A notificar

2: Descartado por ambos

3: Notificado

4: Descartado pelo executor

5: Descartado pelo responsável

IsEditable
boolean
Concluido
boolean

Indica se o item está concluído

StatusEncerramentoItemAgenda
string
NomeClienteFormatado
string
AreaFormatada
string
TituloCasoFormatado
string
NumeroDoCaso
integer
TituloCaso
string
NumeroExternoCaso
string
Cliente
string
Executor
string
NumeroPasta
integer
Assunto
string
NumeroInterno
string
Rito
string
Vencido
string
SituacaoString
string
PoloAtivo
string
PoloPassivo
string
Classificacao
string
ExecutionID
string

Responses

Request samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Atualizar item de agenda

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
IDCaso
integer
IDItemAgenda
integer
IDItemAgendaPai
integer

Se for uma subtarefa, esse valor é o identificador da tarefa pai, senão o valor será nulo

IDFuncionarioCriador
integer
Tipo
integer (TipoItemAgenda)

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

Titulo
string
IDTitulocobranca
integer
Data
string
Lembrete
string
DataLimite
string
FuncionarioExecutor
integer
FuncionarioResponsavel
integer
FuncionariosParticipantes
Array of integers
Observacao
string
DataRealizacao
string
IDStatusEncerramentoItemAgenda
integer
ObservacaoRegistroRealizacao
string
Situacao
integer (SituacaoDoItemAgenda)

-2147483648: None

1: Em aberto,

2: Agendada,

3: Realizada,

4: Ocupado,

5: A confirmar

6: Desmarcável

DataFormatada
string
DataLimiteFormatada
string
IDForo
integer
Local
string
NomeFuncionarioExecutor
string
DataCriacao
string
DataCriacaoFormatada
string
DataRealizacaoFormatada
string
DataRegistroRealizacao
string
DataRegistroRealizacaoFormatada
string
SituacaoLembrete
integer (SituacaoLembrete)

-2147483648: None

1: A notificar

2: Descartado por ambos

3: Notificado

4: Descartado pelo executor

5: Descartado pelo responsável

IsEditable
boolean
Concluido
boolean

Indica se o item está concluído

StatusEncerramentoItemAgenda
string
NomeClienteFormatado
string
AreaFormatada
string
TituloCasoFormatado
string
NumeroDoCaso
integer
TituloCaso
string
NumeroExternoCaso
string
Cliente
string
Executor
string
NumeroPasta
integer
Assunto
string
NumeroInterno
string
Rito
string
Vencido
string
SituacaoString
string
PoloAtivo
string
PoloPassivo
string
Classificacao
string
ExecutionID
string

Responses

Request samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Response samples

Content type
application/json
{
  • "IDCaso": 0,
  • "IDItemAgenda": 0,
  • "IDItemAgendaPai": 0,
  • "IDFuncionarioCriador": 0,
  • "Tipo": 1,
  • "Titulo": "string",
  • "IDTitulocobranca": 0,
  • "Data": "string",
  • "Lembrete": "string",
  • "DataLimite": "string",
  • "FuncionarioExecutor": 0,
  • "FuncionarioResponsavel": 0,
  • "FuncionariosParticipantes": [
    ],
  • "Observacao": "string",
  • "DataRealizacao": "string",
  • "IDStatusEncerramentoItemAgenda": 0,
  • "ObservacaoRegistroRealizacao": "string",
  • "Situacao": 1,
  • "DataFormatada": "01/01/2022",
  • "DataLimiteFormatada": "01/01/2022",
  • "IDForo": 0,
  • "Local": "string",
  • "NomeFuncionarioExecutor": "string",
  • "DataCriacao": "2022-01-01T12:00:00",
  • "DataCriacaoFormatada": "01/01/2022",
  • "DataRealizacaoFormatada": "string",
  • "DataRegistroRealizacao": "string",
  • "DataRegistroRealizacaoFormatada": "string",
  • "SituacaoLembrete": 1,
  • "IsEditable": true,
  • "Concluido": true,
  • "StatusEncerramentoItemAgenda": "string",
  • "NomeClienteFormatado": "string",
  • "AreaFormatada": "string",
  • "TituloCasoFormatado": "string",
  • "NumeroDoCaso": 0,
  • "TituloCaso": "string",
  • "NumeroExternoCaso": "string",
  • "Cliente": "string",
  • "Executor": "string",
  • "NumeroPasta": 0,
  • "Assunto": "string",
  • "NumeroInterno": "string",
  • "Rito": "string",
  • "Vencido": "string",
  • "SituacaoString": "string",
  • "PoloAtivo": "string",
  • "PoloPassivo": "string",
  • "Classificacao": "string",
  • "ExecutionID": "string"
}

Lista agenda do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

query Parameters
ano
required
integer

O ano para pesquisa

mes
required
integer

O mês para pesquisa

dia
integer

O dia para pesquisa

subcasos
boolean

Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista executores

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista participantes

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Titulos

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
tipo
required
integer (TipoItemAgenda)
Example: tipo=1

-2147483648: None

1: Atividade externa

2: Prazo

4: Audiência

8: Compromisso de trabalho

9: Compromisso particular

10: Compromisso (Compromisso de trabalho e Compromisso particular)

11: Publicação

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista audiências por identificador do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista audiências por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso.
Default: 0

NumeroExterno
string

O numero externo do caso.
Default: empty string

IdProcesso
integer

O identificador do caso.
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista compromissos, prazos e publicações por identificadores dos casos

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
Array of integers

Os identificadores dos casos

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista compromissos, prazos e publicações por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso.
Default: 0

NumeroExterno
string

O numero externo do caso.
Default: empty string

IdProcesso
integer

O identificador do caso.
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista status de encerramento de tarefas por tipo da tarefa

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
inCompromisso
boolean

Listar as classificações de compromisso?
Default: false

inPrazo
boolean

Listar as classificações de prazo?
Default: false

inAtividadeExterna
boolean

Listar as classificações de atividade externa?
Default: false

inPublicacao
boolean

Listar as classificações de publicação?
Default: false

inAudiencia
boolean

Listar as classificações de audiência?
Default: false

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Timeline

Lista timeline por filtros

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
paginaAtual
required
integer
Example: paginaAtual=1

Número da página

cdProcesso
required
integer
Example: cdProcesso=100

O identificador do processo

dataInicial
required
string
Example: dataInicial=2022-06-01T12:00:00

A data inicial da pesquisa

dataFinal
required
string
Example: dataFinal=2022-06-05T16:00:00

A data final da pesquisa

andamentoManual
boolean

Indica se deve retornar andamentos manuais. Default: false

andamentoAutomatico
boolean

Indica se deve retornar andamentos automáticos. Default: false

timesheet
boolean

Indica se deve retornar timesheet. Default: false

agenda
boolean

Indica se deve retornar itens de agenda. Default: false

tarefa
boolean

Indica se deve retornar tarefas. Default: false

decisao
boolean

Indica se deve retornar decisões. Default: false

despesa
boolean

Indica se deve retornar despesas. Default: false

garantia
boolean

Indica se deve retornar garantias. Default: false

pushAndamentos
boolean

Indica se deve retornar push de andamento. Default: false

pushPublicacao
boolean

Indica se deve retornar push de publicação. Default: false

subCasos
boolean

Subcasos? (Default: false)

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Timesheet

Lista timesheet por filtro

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
idsFuncionarios
required
string
Example: idsFuncionarios=10,25,30

Os identificadores por funcionarios separados por virgula

dataInicial
required
string

A data inicial para pesquisa

dataFinal
string

A data final para pesquisa

typeMode
integer (TipoDeConsultaCalendario)
Example: typeMode=1

1: dayGridMonth

2: timeGridWeek

3: timeGridDay

4: listWeek

5: interval

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Total de horas lançadas no mês por profissional

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
4

Lista ultimos lançamentos por profissional

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os Activity Codes

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista os Task Codes

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista lançamentos de timesheet do funcionário

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
ano
required
integer

O ano para pesquisa

mes
required
integer

O mês para pesquisa

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista áreas para lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idFuncionario
required
integer

O identificador do funcionário

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista títulos para lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idArea
required
integer

O identificador da área

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista funcionários para lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista classificações para lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista horas lançadas do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

query Parameters
ano
required
integer

O ano para pesquisa

mes
required
integer

O mês para pesquisa

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista horas lançadas do caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Obtém lançamento de hora por identificador

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
id
required
integer

O identificador do lançamento de hora

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Inclui lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrLEDESTaskCode
string
NrLEDESActivityCode
string
DsSolicitante
string
CdSolicitante
integer
IDCliente
integer
IDProcesso
integer
IDFuncionario
integer
NomeFuncionario
string
Descricao
string
DataExecucao
string
TipoDeTarefa
integer (TipoDeTarefa)

-2147483648: None

1: Aprimoramento profissional

2: Horas debitáveis

3: Horas de relacionamento

4: Horas não debitáveis

QtdMinutos
integer
IDFuncionarioResponsavel
integer
IDFuncionarioBeneficiario
integer
IDFechamentoPlanilhaHoras
integer
IDRegistroFechamentoContaCliente
integer
SituacaoDaPlanilha
integer (SituacaoDaPlanilhaDeHoras)

-2147483648: None

1: Aberta

2: A aprovar

3: Aprovada

4: Não aprovada

MotivoDaRecusa
string
IDClassificacaoHorasDebitaveis
integer
IDClassificacao
integer
DsClassificacao
string
Titulo
string
IDAndamento
integer
IDArea
integer
IDContrato
integer
DataLancamento
string
InFaturadoPreVersao35
boolean
IDLancamentoDeHoras
integer
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Inclui lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrLEDESTaskCode
string
NrLEDESActivityCode
string
DsSolicitante
string
CdSolicitante
integer
IDCliente
integer
IDProcesso
integer
IDFuncionario
integer
NomeFuncionario
string
Descricao
string
DataExecucao
string
TipoDeTarefa
integer (TipoDeTarefa)

-2147483648: None

1: Aprimoramento profissional

2: Horas debitáveis

3: Horas de relacionamento

4: Horas não debitáveis

QtdMinutos
integer
IDFuncionarioResponsavel
integer
IDFuncionarioBeneficiario
integer
IDFechamentoPlanilhaHoras
integer
IDRegistroFechamentoContaCliente
integer
SituacaoDaPlanilha
integer (SituacaoDaPlanilhaDeHoras)

-2147483648: None

1: Aberta

2: A aprovar

3: Aprovada

4: Não aprovada

MotivoDaRecusa
string
IDClassificacaoHorasDebitaveis
integer
IDClassificacao
integer
DsClassificacao
string
Titulo
string
IDAndamento
integer
IDArea
integer
IDContrato
integer
DataLancamento
string
InFaturadoPreVersao35
boolean
IDLancamentoDeHoras
integer
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Atualiza lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrLEDESTaskCode
string
NrLEDESActivityCode
string
DsSolicitante
string
CdSolicitante
integer
IDCliente
integer
IDProcesso
integer
IDFuncionario
integer
NomeFuncionario
string
Descricao
string
DataExecucao
string
TipoDeTarefa
integer (TipoDeTarefa)

-2147483648: None

1: Aprimoramento profissional

2: Horas debitáveis

3: Horas de relacionamento

4: Horas não debitáveis

QtdMinutos
integer
IDFuncionarioResponsavel
integer
IDFuncionarioBeneficiario
integer
IDFechamentoPlanilhaHoras
integer
IDRegistroFechamentoContaCliente
integer
SituacaoDaPlanilha
integer (SituacaoDaPlanilhaDeHoras)

-2147483648: None

1: Aberta

2: A aprovar

3: Aprovada

4: Não aprovada

MotivoDaRecusa
string
IDClassificacaoHorasDebitaveis
integer
IDClassificacao
integer
DsClassificacao
string
Titulo
string
IDAndamento
integer
IDArea
integer
IDContrato
integer
DataLancamento
string
InFaturadoPreVersao35
boolean
IDLancamentoDeHoras
integer
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Atualiza lançamento de hora

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Request Body schema: application/json
NrLEDESTaskCode
string
NrLEDESActivityCode
string
DsSolicitante
string
CdSolicitante
integer
IDCliente
integer
IDProcesso
integer
IDFuncionario
integer
NomeFuncionario
string
Descricao
string
DataExecucao
string
TipoDeTarefa
integer (TipoDeTarefa)

-2147483648: None

1: Aprimoramento profissional

2: Horas debitáveis

3: Horas de relacionamento

4: Horas não debitáveis

QtdMinutos
integer
IDFuncionarioResponsavel
integer
IDFuncionarioBeneficiario
integer
IDFechamentoPlanilhaHoras
integer
IDRegistroFechamentoContaCliente
integer
SituacaoDaPlanilha
integer (SituacaoDaPlanilhaDeHoras)

-2147483648: None

1: Aberta

2: A aprovar

3: Aprovada

4: Não aprovada

MotivoDaRecusa
string
IDClassificacaoHorasDebitaveis
integer
IDClassificacao
integer
DsClassificacao
string
Titulo
string
IDAndamento
integer
IDArea
integer
IDContrato
integer
DataLancamento
string
InFaturadoPreVersao35
boolean
IDLancamentoDeHoras
integer
IsEditable
boolean

Responses

Request samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Response samples

Content type
application/json
{
  • "NrLEDESTaskCode": "string",
  • "NrLEDESActivityCode": "string",
  • "DsSolicitante": "string",
  • "CdSolicitante": 0,
  • "IDCliente": 0,
  • "IDProcesso": 0,
  • "IDFuncionario": 0,
  • "NomeFuncionario": "string",
  • "Descricao": "string",
  • "DataExecucao": "string",
  • "TipoDeTarefa": 2,
  • "QtdMinutos": 0,
  • "IDFuncionarioResponsavel": 0,
  • "IDFuncionarioBeneficiario": 0,
  • "IDFechamentoPlanilhaHoras": 0,
  • "IDRegistroFechamentoContaCliente": 0,
  • "SituacaoDaPlanilha": 1,
  • "MotivoDaRecusa": "string",
  • "IDClassificacaoHorasDebitaveis": 0,
  • "IDClassificacao": 0,
  • "DsClassificacao": "string",
  • "Titulo": "string",
  • "IDAndamento": 0,
  • "IDArea": 0,
  • "IDContrato": 0,
  • "DataLancamento": "string",
  • "InFaturadoPreVersao35": true,
  • "IDLancamentoDeHoras": 0,
  • "IsEditable": true
}

Obtém limite mínimo de minutos

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
10

Obtém arredondamento de minutos

Authorizations:
Ocp-Apim-Subscription-Key
header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
10

Valores apurados

Lista valores apurados por caso

Authorizations:
Ocp-Apim-Subscription-Key
path Parameters
idCaso
required
integer

O identificador do caso

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Lista valores apurados por identificador do caso, numero interno ou numero externo

Authorizations:
Ocp-Apim-Subscription-Key
query Parameters
NumeroInterno
integer

O numero interno do caso.
Default: 0

NumeroExterno
string

O numero externo do caso.
Default: empty string

IdProcesso
integer

O identificador do caso.
Default: 0

header Parameters
Profile
required
string

Profile obtained when logged in

Responses

Response samples

Content type
application/json
[
  • {
    }
]