Integração

Este serviço permite a atualização da transação

Metadado

ocorrência

#

schema

Nome

Ele

Key

Tipo

Tam.

Dec.

regex

required

min

max

Descrição / schema

Observação / Regras

1

DF

G

schema

true

1

1

t_documentoFinanceiro

t_documentoFinanceiro

1

t_documentoFinanceiro

organizacao

A

string

15

-

true

1

1

Organização

Organização de Contrato

2

t_documentoFinanceiro

tipo

A

integer

2

-

^(1|2|3|4|5|6|7|8)$

true

1

1

Tipo do documento financeiro

Tipo da parcela

1: Ordem Faturamento

2: Ordem Pagamento

3: Ordem Faturamento - Estornada

4: Encontro de Contas

5: OF - Multas e Juros

6: OP - Multas e Juros

7: RETUSD - ND

8: RETUSD - NC

3

t_documentoFinanceiro

codigo

A

RC

100

-

false

0

1

Código

Código do documento financeiro(Se docERP estiver preenchido este deve estar vazio)

4

t_documentoFinanceiro

docERP

A

RC

100

-

false

0

1

documento ERP

Código referencia do ERP(Se código estiver preenchido este deve estar vazio)

5

t_documentoFinanceiro

sequencia

A

integer

3

-

true

1

1

Sequência

Sequência da parcela

6

t_documentoFinanceiro

liquidacao

G

schema

false

0

1

t_documentoFinanceiro_liquidacao

t_documentoFinanceiro_liquidacao

1

t_documentoFinanceiro_liquidacao

dados

G

schema

true

1

N

t_documentoFinanceiro_liquidacao_dado

t_documentoFinanceiro_liquidacao_dado

1

t_documentoFinanceiro_liquidacao_dado

ordem

E

X

integer

3

-

true

1

1

Ordem de liquidação

Ordem dos eventos de liquidação. 1..n

2

t_documentoFinanceiro_liquidacao_dado

tipo

E

integer

1

-

^(0|1|2|3|4)$

true

1

1

tipo de liquidação

0: Liquidação

1: Abatimento

3: Estorno - Liquidação

4: Estorno - Abatimento

3

t_documentoFinanceiro_liquidacao_dado

data

E

date

10

-

true

1

1

data de liquidação

Data de Liquidação (AAAA-MM-DD)

4

t_documentoFinanceiro_liquidacao_dado

valor

E

number

15

6

true

1

1

valor de liquidação

Valor liquidado na ordem de liquidação

5

t_documentoFinanceiro_liquidacao_dado

docERP

E

string

100

-

true

1

1

documento ERP da liquidação

documento ERP que se refere a liquidação

Metadado

ocorrência

#

schema

Nome

Ele

Key

Tipo

Tam.

Dec.

regex

required

min

max

Descrição / schema

Observação / Regras

1

retDF

G

schema

required

1

1

res_t_documentoFinanceiro

res_t_documentoFinanceiro

1

res_t_documentoFinanceiro

organizacao

A

string

15

-

required

1

1

Organização

Organização de Contrato

2

res_t_documentoFinanceiro

tipo

A

integer

2

-

^(1|2|3|4|5|6|7|8)$

required

1

1

Tipo do documento financeiro

Tipo da parcela

1: Ordem Faturamento

2: Ordem Pagamento

3: Ordem Faturamento - Estornada

4: Encontro de Contas

5: OF - Multas e Juros

6: OP - Multas e Juros

7: RETUSD - ND

8: RETUSD - NC

3

res_t_documentoFinanceiro

codigo

A

string

100

-

required

1

1

Código

Código do documento financeiro

4

res_t_documentoFinanceiro

sequencia

A

integer

3

-

required

1

1

Sequência

Sequência da parcela

5

res_t_documentoFinanceiro

retornoSituacao

G

schema

required

1

1

res_t_retornoSituacao

res_t_retornoSituacao

1

res_t_retornoSituacao

dados

G

schema

required

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

required

1

1

Identificador Serviço

Identificador interno do serviço

2

res_t_retornoSituacao_dado

situacao

E

integer

3

-

^((0|1))$

required

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

required

1

N

res_t_retornoSituacao_aviso_dado

res_t_retornoSituacao_aviso_dado

1

res_t_retornoSituacao_aviso_dado

codigo

E

string

3

-

required

1

1

Código

Código da advertência

2

res_t_retornoSituacao_aviso_dado

motivo

E

string

300

required

1

1

Motivo 

Motivo pelo qual a advertência é apresentada

res_t_retornoSituacao_erro

1

res_t_retornoSituacao_erro

dados

G

schema

required

1

N

res_t_retornoSituacao_erro_dado

res_t_retornoSituacao_erro_dado

1

res_t_retornoSituacao_erro_dado

codigo

E

string

3

-

required

1

1

Código

Código do erro

2

res_t_retornoSituacao_erro_dado

motivo

E

string

300

required

1

1

Motivo 

Motivo pelo qual o erro é apresentado