Versões comparadas

Chave

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

...

Clique aqui para obter mais informações sobre integração via API

Definição da Mensagem

...

no modelo JsonSchema

Abaixo encontram-se as regras para definir uma mensagem padronizada.

  • Seguir a especificação do formato: https://json-schema.org/specification.html
    • Exemplos <Ancora>
  • Seguir a definição de campos especificada aqui  <link para definição de campos reformulada>
  • Especificar propriedade X-Totvs
  • Types comuns
  • , de acordo com regras especificadas aqui <Ancora>  incluindo quais ERPs implementam aquela mensagem e os campos relacionados. 
  • Sempre que possível, utilizar padrões internacionais. Para saber se já existe uma mensagem de conta contábil, por exemplo, pesquise no Google usando "account xsd oasis repository".
  • Mensagens criadas para atender uma exigência legal devem se ater estritamente ao que é definido pela legislação. Nestes casos, o nome da mensagem e dos campos podem ser em português, se a legislação exigir.

X-TOTVS


Bloco de código
languagejs
titleExemplo X-Totvs Propriedade
Code": {
                    "type": "string",
                    "description": "Código do País",
                    "x-totvs": [
                        {
                            "product": "Logix",
                            "Field": "paises.cod_pais",
                            "Required": true,
                            "Type": "Char",
                            "length": "3",
							"note": "some info about this",
                            "available": true,
                            "canUpdate": false
                        },
                        {
                            "product": "RMS",
                            "Field": "AA1CPAIS.PAIS_COD",
                            "Required": true,
                            "Type": "integer",
                            "length": "6",
							"note": "some info about this",
                            "available": true,
                            "canUpdate": false
                        }
                    ]
                },

Exemplos JsonSchema:

Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json

...

Exemplos Oficiais site json-schema: https://json-schema.org/learn/miscellaneous-examples.html

Padrões internacionais de mensagens para integração

http://docs.oasis-open.org/ubl/prd1-UBL-2.1/UBL-2.1.html

...