Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto a que se refere essa informação.

Exemplo

product: “protheus”

ou

product: “rm”

Campo Obrigatório

Field

A qual tabela.campo o campo da mensagem se refere.

Caso no produto este campo possa estar em mais tabela, explicar o funcionamento.

Exemplo

Field: “clientes.cod_cliente”

ou

Field: “cliente.cod_cliente para Type=Customer ou fornecedor.cod_fornecedor para Type=Vendor”

Campo Obrigatório

Required

Obrigatoriedade do campo, caso haja alguma condição deve ser descrito na seção note.

Exemplo

Required: True

Required: False

Campo Obrigatório

Type

Tipo do campo no produto. Importante declarar aqui o tipo do campo como é conhecido no produto.

Exemplo

type: ‘char’

type: ‘varchar’

type: ‘number’

type: ‘decimal’

type: ‘integer’

type: ‘boolean’

Campo Obrigatório

Length

Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.

Exemplo

length: ‘20’

length: ‘8,2’

length: ’sempre implantado como 20, mas o cliente pode usar até 50’

Campo Obrigatório

Note

Complemento de informações sobre o campo se for o caso, como por exemplo formato da informação, vínculo entre mensagens, escopo de dados (deve ser informado para campos que precisam respeitar uma relação específica de valores no produto, podendo ser informado aqui: 'lista fixa'   ou 'valores da tabela [tabela.campo]')

Exemplo

"note": "1=CEI;2=CNPJ;3=CPF;4=INCRA"

"note": "Campo obrigatório para o processo fiscal/TAF."

"note":"Segmento Principal"

Caso na mensagem tenha sido definida lista fixa, informar aqui a relação dos valores da mensagem com os valores do produto.

...

Indica se o campo esta implementado para o produto, para a determinada mensagem. Recebe um valor Booleano:

Exemplo

available: true

available: false

Campo Obrigatório

canUpdate

indica se o valor do campo pode ser atualizado na tabela. Recebe um valor Booleano:

Exemplo

canUpdate: true

canUpdate: false

Campo Obrigatório

Âncora
jschema-examples
jschema-examples
Exemplos JsonSchema:

...