Observação: Mapeamento de ocorrências e regras de preenchimento.

Mensagem REQUEST

Este serviço permite a atualização do mestre de contraparte

Metadado

ocorrência

 

 

#

schema

Nome

Ele

Key

Tipo

Tam.

Dec.

regex

required

min

max

Descrição / schema

Observação / Regras

1

req_t_contraparte

contraparte

G

 

schema

 

 

 

true

1

1

t_contraparte

 

t_contraparte

1

t_contraparte

organizacao

A

 

string

20

-

 

true

1

1

organização do contrato

organização do contrato

2

t_contraparte

tipo

A

 

string

2

-

^((PF|PJ|61))$

true

1

1

Tipo

Indicar o tipo da pessoa

PF - Pessoa física

PJ - Pessoa Jurídica

61 - Exterior

3

t_contraparte

cnpj

A

 

number

14

-

^[0-9]{14}$

RC

0

1

CNPJ

CNPJ do participante.

RC: Se tipo = "PJ" então ocor="1-1" senão ocor= "0-0"

4

t_contraparte

cpf

A

 

number

11

-

^[0-9]{11}$

RC

0

1

CPF

CPF do participante

RC: Se tipo = "PF" então ocor="1-1" senão ocor= "0-0"

5

t_contraparte

update

A

 

string

1

-

^(S|N)$

false

0

1

update

Indicador se permite a atualização dos dados do cliente, caso já inserido.

S- Sim

N-Não (também considerado como default caso não seja informado)

Importante ter o entendimento, de considerar este campo com "S", caso o responsável pelo masterdata é o emitente da mensagem

6

t_contraparte

dados

G

 

schema

 

 

 

false

0

1

t_contraparte_dados

 

7

t_contraparte

dadosBancario

G

 

schema

 

 

 

false

0

1

t_contraparte_dadosBancario

 

8

t_contraparte

contato

G

 

schema

 

 

 

false

0

1

t_contraparte_contato

 

9

t_contraparte

rating

G

 

schema

 

 

 

false

0

1

t_contraparte_rating

 

10

t_contraparte

caract

G

 

schema

 

 

 

false

0

1

t_contraparte_caract

 

11

t_contraparte

dadosERP

G

 

schema

 

 

 

false

0

1

t_contraparte_erp

 

t_contraparte_dados

1

t_contraparte_dados

Razão social

E

 

string

100

-

 

true

1

1

Razão social

razão social

2

t_contraparte_dados

nome

E

 

string

100

-

 

true

1

1

Nome

Nome da contraparte

3

t_contraparte_dados

ie

E

 

string

20

-

 

false

0

1

IE

Inscrição estadual do participante

4

t_contraparte_dados

logradouro

E

 

string

300

-

 

true

1

1

Logradouro

endereço - logradouro

5

t_contraparte_dados

numero

E

 

number

20

-

 

false

0

1

Número

endereço - número

6

t_contraparte_dados

complemento

E

 

string

100

-

 

false

0

1

Complemento

endereço - complemento

7

t_contraparte_dados

bairro

E

 

string

100

-

 

true

1

1

Bairro

endereço - bairro

8

t_contraparte_dados

cep

E

 

number

8

-

 

true

1

1

CEP

endereço - cep

9

t_contraparte_dados

cidade

E

 

string

50

-

 

true

1

1

Cidade

endereço - cidade

10

t_contraparte_dados

uf

E

 

string

2

-

 

true

1

1

UF

endereço - unidade da federação

11

t_contraparte_dados

pais

E

 

string

10

-

 

false

0

1

País

endereço - país

12

t_contraparte_dados

classe

E

 

string

1

-

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

false

0

1

classe do participante

Classe da Contraparte

1: Comercial

2: Serviço Público

3: Industrial

4: Gerador

5: Comercializador/Gerador

13

t_contraparte_dados

finalidade

E

 

string

1

-

^(1|2)$

false

0

1

finalidade da operação

 Finalidade

1: Consumo

2: Revenda

14

t_contraparte_dados

cidadeIBGE

E

 

string

7

-

 

false

0

1

código da cidade IBGE

 

t_contraparte_dadosBancario

1

t_contraparte_dadosBancario

dados

G

 

schema

 

 

 

true

1

N

t_contraparte_dadosBancario_dados

 

t_contraparte_dadosBancario_dados

1

t_contraparte_dadosBancario_dados

banco

E

 

string

3

-

 

true

1

1

banco

Banco p/ depósito

2

t_contraparte_dadosBancario_dados

agencia

E

 

string

10

-

 

true

1

1

agência

 Agência para depósito

3

t_contraparte_dadosBancario_dados

contaCorrente

E

 

string

10

-

 

true

1

1

conta corrente

Conta Corrente para depósito

4

t_contraparte_dadosBancario_dados

codigo

E

X

string

20

-

 

false

0

1

código

código para referencia a conta bancária

t_contraparte_contato

1

t_contraparte_contato

dados

G

 

schema

 

 

 

true

1

N

t_contraparte_contato_dados

 

t_contraparte_contato_dados

1

t_contraparte_contato_dados

nome

E

X

string

200

-

 

true

1

1

Nome

 

2

t_contraparte_contato_dados

telefone

E

 

string

100

-

 

false

0

1

telefone

Telefone(s) do Contato. Quando houver mais de um e-mail, os destinatários deverão ser separados pelo caracter ";"

3

t_contraparte_contato_dados

email

E

 

string

500

-

 

false

0

1

email

Deve ser preenchido com o e-mail(s) do(s) contato(s). Quando houver mais de um e-mail, os destinatários deverão ser separados pelo caracter ";"

4

t_contraparte_contato_dados

observacao

E

 

string

1000

-

 

false

0

1

Obervação

Observação relevante ao contato

5

t_contraparte_contato_dados

tipo

E

X

string

20

-

 

false

0

1

tipo

tipo do contato. Ex.: FATURAMENTO / FORMALIZACAO / GARANTIA

Este dado é baseado na tabela mestre de tipo de contato.

t_contraparte_rating

1

t_contraparte_rating

dados

G

 

schema

 

 

 

true

1

N

t_contraparte_rating_dados

 

t_contraparte_rating_dados

1

t_contraparte_rating_dados

nome

E

X

string

200

-

 

true

1

1

Nome

Nome do rating

2

t_contraparte_rating_dados

data

E

 

string

100

-

 

true

1

1

data

data da avaliação do rating

3

t_contraparte_rating_dados

nota

E

 

string

100

-

 

true

1

1

nota

nota do rating na data consultada

4

t_contraparte_rating_dados

data_expiracao

E

 

string

100

-

 

true

1

1

data - expiração

data da expiração do rating

t_contraparte_caract

1

t_contraparte_caract

dados

G

 

schema

 

 

 

true

1

N

t_contraparte_caract_dados

 

t_contraparte_caract_dados

1

t_contraparte_caract_dados

nome

E

X

string

200

-

 

true

1

1

Nome

Nome da característica

2

t_contraparte_caract_dados

conteúdo

E

 

string

100

-

 

true

1

1

conteúdo

Conteúdo da característica

t_contraparte_erp

1

t_contraparte_erp

dados

G

 

schema

 

 

 

true

1

N

t_contraparte_erp_dados

 

t_contraparte_erp_dados

1

t_contraparte_erp_dados

tipo

E

X

integer

1

-

^(0|1)$

true

1

1

Tipo do Código: Fornecedor / Cliente

0: Cliente

1: Fornecedor

2

t_contraparte_erp_dados

estabelecimento_cnpj

E

X

number

14

-

 

false

0

1

Cnpj do estabelecimento da organização

 

3

t_contraparte_erp_dados

codigo_erp

E

X

string

100

-

 

true

1

1

código da contraparte no ERP

 

Mensagem RESPONSE (200)

#

 

Nome

Ele

Pai

Tipo

Tam.

Dec.

 

Ocor.

 

 

Descrição

Observação / Regras

1

 

contraparte

G

 

 

 

 

 

1-1

 

 

res_t_contraparte

 

res_t_contraparte

1

res_t_contraparte

organizacao

A

 

string

15

-

 

1-1

 

 

Organização

Organização de Contrato

2

res_t_contraparte

tipo

A

 

string

2

-

^((PF|PJ|61))$

1-1

 

 

Tipo

Indicar o tipo da pessoa

PF - Pessoa física

PJ - Pessoa Jurídica

61 - Exterior

3

res_t_contraparte

cnpj

A

 

number

14

-

^[0-9]{14}$

RC

 

 

CNPJ

CNPJ do participante.

RC: Se tipo = "PJ" então ocor="1-1" senão ocor= "0-0"

4

res_t_contraparte

cpf

A

 

number

11

-

^[0-9]{11}$

RC

 

 

CPF

CPF do participante

RC: Se tipo = "PF" então ocor="1-1" senão ocor= "0-0"

5

res_t_contraparte

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