Histórico da Página

...

Exemplo de um XML de resposta de processamento com erros:

mayco

Exemplo de um XML de ReceiptMessage:

Image Added

Observação: Uma ReceiptMessage representa a confirmação de recebimento de uma BusinessMessage pelo aplicativo destino. Diferente da ResponseMessage, uma ReceiptMessage não irá conter qualquer informação relevante sobre o processamento da mensagem. O envio da ReceiptMessage deverá ocorrer somente no envio de mensagem no modo assíncrona.

Informações Comuns

As mensagens TOTVS possuem um segmento chamado MessageInformation que possui as principais informações utilizadas para identificação e roteamento da mensagem. Segue abaixo um exemplo:

Image Added

A seguir é apresentado uma descrição detalhada de cada item ilustrado acima:

MessageInformation version: Identifica qual a versão da mensagem de negócio. Uma mensagem de Item, por exemplo, pode sofrer alterações no decorrer do tempo, sendo que cada uma destas alterações irá afetar esta informação;

UUID: Identificador único da mensagem e que não pode ser igual ao UUID de qualquer outra mensagem em qualquer um dos aplicativos participantes da integração;

Type: Identifica o tipo da mensagem (BusinessMessage ou ResponseMessage);

Transaction: Identificador do tipo de transação da mensagem. Esta informação será utilizada pelos aplicativos para definir como os dados serão processados no recebimento;

StandardVersion: Identifica a versão do padrão TOTVS, ou seja, do formato utilizado nas áreas genéricas da mensagem TOTVS. Caso o padrão TOTVS seja alterado, este valor será alterado;

SourceApplication: Identifica a instância dos aplicativos que gerou a mensagem. Uma instância representa uma instalação/configuração daquele aplicativo/produto. Caso duas instâncias do mesmo aplicativo participem da mesma integração, cada uma deverá ser identificada de forma única;

CompanyId/BranchId/UserId: Identificador da empresa/filial e usuário que gerou a mensagem (obrigatória);

Product: Identifica o produto e versão do aplicativo que originou a mensagem. Neste caso, o valor pode ser igual, mesmo em instâncias diferentes do mesmo aplicativo;

GeneratedOn: Identifica o timestamp de geração desta mensagem;

DeliveryType: Forma de envio da mensagem, podendo ser "sync" ou "async", ou seja, síncrono ou assíncrono respectivamente.