Integração

Este serviço permite que o contrato em formalização seja consultado, baseado no ID Transaction fornecido pelo BPM, através do serviço de WEBHOOK.

Metadado

ocorrência

#

schema

Nome

Ele

key

Tipo

Tam.

Dec.

regex

Ocor.

min

max

Descrição / schema

Observação / Regras

1

bpm_contratoFormaliza

G

schema

true

1

1

bpm_contratoFormaliza

bpm_contratoFormaliza

1

bpm_contratoFormaliza

idTransasaction

E

X

string

256

-

true

1

1

Id da transação

Identificador da transação que se refere ao contrato a ser consultado

Metadado

ocorrência

#

schema

Nome

Ele

key

Tipo

Tam.

Dec.

regex

Ocor.

min

max

Descrição / schema

Observação / Regras

1

contrato

G

schema

true

1

1

res_bpm_contratoFormaliza

res_bpm_contratoFormaliza

1

res_bpm_contratoFormaliza

organizacao

A

X

string

15

-

true

1

1

Organização

Organização de Contrato

2

res_bpm_contratoFormaliza

codigo

A

X

string

20

-

true

1

1

Código

Código do Contrato

3

res_bpm_contratoFormaliza

estabelecimento_cnpj

E

X

number

14

-

^[0-9]{14}$

true

1

1

Estabelecimento

Inserir o CNPJ do Estabelecimento do Faturamento (sem formatação)

4

res_bpm_contratoFormaliza

tag

G

schema

false

0

1

res_bpm_contratoFormaliza_tag

5

res_bpm_contratoFormaliza

minuta

G

schema

false

0

1

res_bpm_contratoFormaliza_minuta

6

res_bpm_contratoFormaliza

retornoSituacao

G

schema

true

1

1

res_t_retornoSituacao

res_bpm_contratoFormaliza_tag

1

res_bpm_contratoFormaliza_tag

dados

G

schema

true

1

N

res_bpm_contratoFormaliza_tag_dado

res_bpm_contratoFormaliza_tag_dado

1

res_bpm_contratoFormaliza_tag_dado

nome

E

X

string

200

-

true

1

1

Nome

Nome da característica

2

res_bpm_contratoFormaliza_tag_dado

conteúdo

E

X

string

200

-

true

1

1

conteúdo

Conteúdo da característica

res_bpm_contratoFormaliza_minuta

1

res_bpm_contratoFormaliza_minuta

dados

G

schema

true

1

N

res_bpm_contratoFormaliza_minuta_dado

res_bpm_contratoFormaliza_minuta_dado

1

res_bpm_contratoFormaliza_minuta_dado

nome

E

X

string

100

true

1

1

nome do arquivo modelo da minuta

nome do arquivo do modelo da minuta

2

res_bpm_contratoFormaliza_minuta_dado

base64

E

B64

-

-

true

1

1

arquivo base64

arquivo convertido em base64

res_t_retornoSituacao

1

res_t_retornoSituacao

dados

G

schema

true

1

1

res_t_retornoSituacao_dado

2

res_t_retornoSituacao

aviso

G

schema

false

0

1

res_t_retornoSituacao_aviso

3

res_t_retornoSituacao

erro

G

schema

RC

0

1

res_t_retornoSituacao_erro

RC- Se a situação = "1" ocur = "1-N" senão ocur = "0-0"

res_t_retornoSituacao_dado

1

res_t_retornoSituacao_dado

ID

E

number

9

true

1

1

Identificador Serviço

Identificador interno do serviço

2

res_t_retornoSituacao_dado

situacao

E

integer

3

-

^((0|1))$

true

1

1

Código

Status da execução do registro

0: ERRO

1: OK

res_t_retornoSituacao_aviso

1

res_t_retornoSituacao_aviso

dados

G

schema

true

1

N

res_t_retornoSituacao_aviso_dado

res_t_retornoSituacao_aviso_dado

1

res_t_retornoSituacao_aviso_dado

codigo

E

string

3

-

true

1

1

Código

Código da advertência

2

res_t_retornoSituacao_aviso_dado

motivo

E

string

300

true

1

1

Motivo 

Motivo pelo qual a advertência é apresentada

res_t_retornoSituacao_erro

1

res_t_retornoSituacao_erro

dados

G

schema

true

1

N

res_t_retornoSituacao_erro_dado

res_t_retornoSituacao_erro_dado

1

res_t_retornoSituacao_erro_dado

codigo

E

string

3

-

true

1

1

Código

Código do erro

2

res_t_retornoSituacao_erro_dado

motivo

E

string

300

true

1

1

Motivo 

Motivo pelo qual o erro é apresentado