ObservaçãoMapeamento de ocorrências e regras de preenchimento.

Mensagem REQUEST

#

Nome

Ele

Pai

Tipo

Ocor.

Tam.

Dec.

Descrição

Observação / Regras

DF01

DF

G

 

 

 

 

 

tab: DocumentoFinanceiro

Key: DF02, DF03, DF04, DF05

DF02

organizacao

A

DF01

C

1-1

15

-

Organização

Organização de Contrato

DF03

tipo

A

DF01

N

1-1

2

-

Tipo do documento financeiro

Tipo da parcela

1: Ordem Faturamento

2: Ordem Pagamento

DF04

codigo

A

DF01

RC

0-1

100

-

Código

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

DF05

docERP

A

DF01

RC

0-1

100

 

 

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

DF06

sequencia

A

DF01

N

1-1

3

-

Sequência

Sequência da parcela

DF07

liquidacao

G

DF01

 

0-1

 

 

tab: eventos de Liquidação

 

DF08

dados

G

DF07

 

1-N

 

 

linha: dados da liquidação

key: DF08

DF09

ordem

E

DF08

 

1-1

 

 

Ordem de liquidação

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

DF10

tipo

E

DF08

 

1-1

 

 

tipo de liquidação

0: Liquidação

1: Abatimento

3: Estorno - Liquidação

4: Estorno - Abatimento

DF11

data

E

DF08

D

1-1

10

 

data de liquidação

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

DF12

valor

E

DF08

N

1-1

15

6

valor de liquidação

Valor liquidado na ordem de liquidação.

DF13

docERP

E

DF08

C

1-1

100

documento ERP da liquidação

documento ERP que se refere a liquidação

Mensagem RESPONSE (200)

#

Nome

Ele

Pai

Tipo

Ocor.

Tam.

Dec.

Descrição

Observação / Regras

RT01

retDF

G

RT01

 

1-1

 

 

tab: retDF

 

RT02

organizacao

A

RT01

C

1-1

15

-

Organização

Organização de Contrato

RT03

tipo

A

RT01

N

1-1

2

-

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

RT04

codigo

A

RT01

C

1-1

100

-

Código

Código do documento financeiro

RT05

sequencia

A

RT01

N

1-1

3

-

Sequência

Sequência da parcela

Retorno situação

AR01

retornoSituacao

G

RT01

 

1-1

 

 

tab: retornoSituacao

 

AR02

dados

G

AR01

 

1-1

 

 

linha: dados retornoSituacao

 

AR03

ID

E

AR02

N

1-1

9

 

Identificador Serviço

Identificador interno do serviço

AR04

situacao

E

AR02

N

1-1

3

-

Código

Status da execução do registro

0: ERRO

1: OK

AR05

aviso

G

AR01

 

0-1

 

 

tab: aviso

 

AR06

dados

G

AR05

 

1-N

 

 

linha: dados do aviso do retorno

 

AR07

codigo

E

AR06

C

1-1

3

-

Código

Código da advertência

AR08

motivo

E

AR06

C

1-1

300

 

Motivo 

Motivo pelo qual a advertência é apresentada

AR09

erro

G

AR01

 

RC

 

 

tab:erro

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

AR10

dados

G

AR09

 

1-N

 

 

linha: dados do erro de retorno

 

AR11

codigo

E

AR10

C

1-1

3

-

Código

Código do erro

AR12

motivo

E

AR10

C

1-1

300

 

Motivo 

Motivo pelo qual o erro é apresentado