Manual para integração entre sistemas via XML

Integração de dados entre sistemas

XML – SQL

Criado em: 21/04/2009

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Índice
1. Histórico de revisões ..............................................................................................................................................9
2. Introdução .......................................................................................................................................................... 14
3. Objetivo ............................................................................................................................................................. 14
4. Pré-Requisitos ..................................................................................................................................................... 15
5. Responsabilidades................................................................................................................................................ 15
5.1. Cliente ............................................................................................................................................................ 15
5.2. Efi .................................................................................................................................................................. 15
6. Tecnologias envolvidas ......................................................................................................................................... 16
7. Operações .......................................................................................................................................................... 16
7.1. Importação ...................................................................................................................................................... 16
7.2. Exportação....................................................................................................................................................... 16
8. Layout das tabelas de integração ........................................................................................................................... 17
8.1. Tabela de Importação ........................................................................................................................................ 17
8.2. Tabela de Exportação ........................................................................................................................................ 17
9. Diagrama macro de funcionamento da integração através de banco de dados ............................................................... 19
9.1. Importação ...................................................................................................................................................... 19
9.2. Exportação....................................................................................................................................................... 21
10. Diagrama macro de funcionamento da integração através do WebServices ................................................................ 23
11. Funcionalidades e Interfaces do WebServices ........................................................................................................ 24
11.1. Interface IMetricsSDIWebService ....................................................................................................................... 24
11.1.1 GetPendingTransaction .................................................................................................................................. 24
11.1.2 SetTransactionResult ..................................................................................................................................... 24
11.1.3 ProcessTransaction ....................................................................................................................................... 25
11.2. Definição dos tipos de dados ............................................................................................................................. 25
11.3. Interface IMetricsSDIBasicCall ........................................................................................................................... 27
11.3.1 Parâmetros comuns ...................................................................................................................................... 27
11.3.1.1 GetPendingtrasctionBasic/GetPendingtrasctionBasic2 ....................................................................................... 27
11.3.1.2 SetTransactionResultBasic/SetTransactionResultBasic2 .................................................................................... 28
11.3.1.3 ProcessTransactionBasic/ProcessTransactionBasic2 ......................................................................................... 29

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.3.1.4 MetricsSDIClientDLL.dll ............................................................................................................................... 29

11.4. Metrics - Módulo SDI ....................................................................................................................................... 31
11.4.1. Funcionalidades ............................................................................................................................................ 32
11.4.1.1. Exibir Exportações / Exibir Importações ...................................................................................................... 32
11.4.1.2. Pesquisar ............................................................................................................................................... 32
11.4.1.3. Atualizar................................................................................................................................................. 34
11.4.1.4. Grade Transações .................................................................................................................................... 34
11.4.1.4.1. Detalhes da Transação ........................................................................................................................... 35
11.5. Especificação dos arquivos XML ......................................................................................................................... 35
11.5.1. XMLOperation – Arquivo de operação............................................................................................................... 35
11.5.1.1. Explicação dos elementos e atributos .......................................................................................................... 36
11.5.1.2. Diagrama de dependência entre os elementos do arquivo XMLOperation .......................................................... 39
11.5.2. XML Return – Arquivo de Status de Processamento ............................................................................................ 39
11.5.2.1. Explicação dos elementos e atributos .......................................................................................................... 39
11.5.2.2. Diagrama de Dependência entre os elementos do arquivo XMLReturn .............................................................. 42
11.6. CRM (Relacionamentos) ................................................................................................................................... 42
11.6.1. XMLData – Arquivo de Operação ..................................................................................................................... 42
11.6.1.1. Explicação dos elementos e atributos .......................................................................................................... 42
11.6.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (CRM) ....................................................... 52
11.6.1.3. Importação e Exportação .......................................................................................................................... 53
11.7. SOR (Pedidos de Venda) .................................................................................................................................. 54
11.7.1. XMLData – Arquivo de Operação ..................................................................................................................... 54
11.7.1.1. Explicação dos elementos e atributos .......................................................................................................... 54
11.7.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (SOR) ....................................................... 61
11.7.1.3. Importação e Exportação .......................................................................................................................... 62
11.8. BIL (Faturas/Remessas) ................................................................................................................................... 63
11.8.1. XMLData – Arquivo de Operação ..................................................................................................................... 63
11.8.1.1. Explicação dos elementos e atributos .......................................................................................................... 63
11.8.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (BIL)......................................................... 71
11.8.1.3. Importação e Exportação .......................................................................................................................... 72
11.9. STKItem (Itens de Estoque).............................................................................................................................. 73
11.9.1. XMLData – Arquivo de Operação ..................................................................................................................... 74
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.9.1.1. Explicação dos elementos e atributos .......................................................................................................... 74

11.9.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STKItem) ................................................. 80
11.9.1.3. Importação e Exportação .......................................................................................................................... 80
11.10. STK (Movimentações de Estoque) ................................................................................................................... 80
11.10.1. XMLData – Arquivo de Operação ................................................................................................................... 81
11.10.1.1. Explicação dos elementos e atributos .......................................................................................................... 81
11.10.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK) ........................................................ 85
11.10.1.3. Importação e Exportação .......................................................................................................................... 86
11.11. REQ (Requisições de Materiais) ....................................................................................................................... 86
11.11.1. XMLData – Arquivo de Operação ................................................................................................................... 87
11.11.1.1. Explicação dos elementos e atributos .......................................................................................................... 87
11.11.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (REQ) ....................................................... 89
11.11.1.3. Importação e Exportação .......................................................................................................................... 89
11.12. WO (Ordens de Produção) .............................................................................................................................. 89
11.12.1. XMLData – Arquivo de Operação ................................................................................................................... 90
11.12.1.1. Explicação dos elementos e atributos .......................................................................................................... 90
11.12.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (WO) ........................................................ 95
11.12.1.3. Importação ............................................................................................................................................. 96
11.12.1.4. Exportação ............................................................................................................................................. 97
11.13. INT-OP (Integração de Ordens de Produção) ..................................................................................................... 97
11.13.1. XMLData – Arquivo de Operação ................................................................................................................... 97
11.13.1.1. Explicação dos elementos e atributos .......................................................................................................... 97
11.13.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (INT-OP) ................................................. 108
11.13.1.3. Importação ........................................................................................................................................... 109
11.13.1.4. Exportação ........................................................................................................................................... 109
11.14. WIP (Work-in-Progress) ............................................................................................................................... 109
11.14.1. XMLData – Arquivo de Operação ................................................................................................................. 109
11.14.1.1. Explicação dos elementos e atributos ........................................................................................................ 109
11.14.1.2. Importação ........................................................................................................................................... 111
11.14.1.3. Exportação ........................................................................................................................................... 111
11.15. WIP_TR (Transação de Etiqueta WIP) ............................................................................................................ 111
11.15.1. XMLData – Arquivo de Operação ................................................................................................................. 111
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.15.1.1. Explicação dos elementos e atributos ........................................................................................................ 111

11.15.1.2. Importação ........................................................................................................................................... 113
11.15.1.3. Exportação ........................................................................................................................................... 113
11.16. STK_VL (Itens de Estoque controlados por Volumes) ....................................................................................... 114
11.16.1. XMLData – Arquivo de Operação ................................................................................................................. 115
11.16.1.1. Explicação dos elementos e atributos ........................................................................................................ 115
11.16.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK_VL) ................................................ 118
11.16.1.3. Importação ........................................................................................................................................... 119
11.16.1.4. Exportação ........................................................................................................................................... 120
11.17. STK_VT (Transações de Volumes) ................................................................................................................. 120
11.17.1. XMLData – Arquivo de Operação ................................................................................................................. 121
11.17.1.1. Explicação dos elementos e atributos ........................................................................................................ 121
11.17.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK_VT) ................................................ 123
11.17.1.3. Importação e Exportação ........................................................................................................................ 124
11.18. STK_VR (Requisições de Volumes) ................................................................................................................ 124
11.18.1. XMLData – Arquivo de Operação ................................................................................................................. 125
11.18.1.1. Explicação dos elementos e atributos ........................................................................................................ 125
11.18.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK_VR) ................................................ 126
11.18.1.3. Importação ........................................................................................................................................... 127
11.18.1.4. Exportação ........................................................................................................................................... 127
11.19. ACR (Pós-Cálculo) ....................................................................................................................................... 128
11.19.1. XMLData – Arquivo de Operação ................................................................................................................. 128
11.19.1.1. Explicação dos elementos e atributos ........................................................................................................ 128
11.19.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (ACR) ..................................................... 130
11.19.1.3. Importação ........................................................................................................................................... 131
11.19.1.4. Exportação ........................................................................................................................................... 132
11.20. JBT (JobTrack) ........................................................................................................................................... 132
11.20.1. XMLData – Arquivo de Operação ................................................................................................................. 132
11.20.1.1. Explicação dos elementos e atributos ........................................................................................................ 132
11.20.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (JBT) ...................................................... 133
11.20.1.3. Importação ........................................................................................................................................... 133
11.20.1.4. Exportação ........................................................................................................................................... 133
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.21. CR (Títulos Financeiros) ............................................................................................................................... 134

11.21.1. XMLData – Arquivo de Operação ................................................................................................................. 134
11.21.1.1. Explicação dos elementos e atributos ........................................................................................................ 134
11.21.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (CR) ....................................................... 137
11.21.1.3. Importação e Exportação ........................................................................................................................ 138
11.22. CTB_CTA (Plano de Contas Contábil) ............................................................................................................. 138
11.22.1. XMLData – Arquivo de Operação ................................................................................................................. 139
11.22.1.1. Explicação dos elementos e atributos ........................................................................................................ 139
11.22.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (CTB_CTA) .............................................. 140
11.22.1.3. Importação ........................................................................................................................................... 140
11.22.1.4. Exportação ........................................................................................................................................... 140
11.23. STK_NCM (Classificações Fiscais de Itens de Estoque) ...................................................................................... 141
11.23.1. XMLData – Arquivo de Operação ................................................................................................................. 141
11.23.1.1. Explicação dos elementos e atributos ........................................................................................................ 141
11.23.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK_NCM) .............................................. 142
11.23.1.3. Importação ........................................................................................................................................... 142
11.23.1.4. Exportação ........................................................................................................................................... 142
11.24. CTB_LCTO (Lançamentos Contábeis) ............................................................................................................. 142
11.24.1. XMLData – Arquivo de Operação ................................................................................................................. 143
11.24.1.1. Explicação dos elementos e atributos ........................................................................................................ 143
11.24.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (CTB_LCTO) ............................................. 144
11.24.1.3. Importação ........................................................................................................................................... 144
11.24.1.4. Exportação ........................................................................................................................................... 144
11.25. STK_BLC (Saldos de Estoque) ...................................................................................................................... 144
11.25.1. XMLData – Arquivo de Operação ................................................................................................................. 145
11.25.1.1. Explicação dos elementos e atributos ........................................................................................................ 145
11.25.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (STK_BLC) ............................................... 148
11.25.1.3. Importação ........................................................................................................................................... 149
11.25.1.4. Exportação ........................................................................................................................................... 149
11.26. BIL_NFE_REC (Notas Fiscais de Compra) ........................................................................................................ 149
11.27. REC (Notas Fiscais de Compra Processadas) ................................................................................................... 149
11.27.1. XMLData – Arquivo de Operação ................................................................................................................. 149
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.27.1.1. Explicação dos elementos e atributos ........................................................................................................ 149

11.27.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (REC)...................................................... 152
11.27.1.3. Importação ........................................................................................................................................... 152
11.27.1.4. Exportação ........................................................................................................................................... 152
11.28. BIL_NFE_ENV (Notas Fiscais de Faturamento) ................................................................................................. 153
11.29. CTB_CTC (Centros de Custo) ........................................................................................................................ 153
11.29.1. XMLData – Arquivo de Operação ................................................................................................................. 153
11.29.1.1. Explicação dos elementos e atributos ........................................................................................................ 153
11.29.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (CTB_CTC) .............................................. 155
11.29.1.3. Importação ........................................................................................................................................... 155
11.29.1.4. Exportação ........................................................................................................................................... 156
11.30. POR (Pedidos de Compra) ............................................................................................................................ 156
11.30.1. XMLData – Arquivo de Operação ................................................................................................................. 156
11.30.1.1. Explicação dos elementos e atributos ........................................................................................................ 156
11.30.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (POR) ..................................................... 160
11.30.1.3. Importação e Exportação ........................................................................................................................ 161
11.31. JBT_APT (Apontamentos do Jobtrack) ............................................................................................................ 161
11.31.1. XMLData – Arquivo de Operação ................................................................................................................. 161
11.31.1.1. Explicação dos elementos e atributos ........................................................................................................ 161
11.31.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (JBT_APT) ............................................... 163
11.31.1.3. Importação ........................................................................................................................................... 163
11.31.1.4. Exportação ........................................................................................................................................... 163
11.32. PCK (Solicitação de Picking) ......................................................................................................................... 163
11.32.1. XMLData – Arquivo de Operação ................................................................................................................. 164
11.32.1.1. Explicação dos elementos e atributos ........................................................................................................ 164
11.32.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (PCK) ...................................................... 167
11.32.1.3. Importação ........................................................................................................................................... 167
11.32.1.4. Exportação ........................................................................................................................................... 168
11.33. PRQ (Solicitações de Compra) ...................................................................................................................... 168
11.33.1. XMLData – Arquivo de Operação ................................................................................................................. 169
11.33.1.1. Explicação dos elementos e atributos ........................................................................................................ 169
11.33.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (PRQ) ..................................................... 171
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.33.1.3. Importação ........................................................................................................................................... 171

11.33.1.4. Exportação ........................................................................................................................................... 171
11.34. OSP (Lotes de Pagamento a Terceiros)........................................................................................................... 171
11.34.1. XMLData – Arquivo de Operação ................................................................................................................. 172
11.34.1.1. Explicação dos elementos e atributos ........................................................................................................ 172
11.34.1.2. Diagrama de Dependência entre os elementos do arquivo XMLData (OSP) ..................................................... 174
11.34.1.3. Importação ........................................................................................................................................... 174
11.34.1.4. Exportação ........................................................................................................................................... 174

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

1. Histórico de revisões
Data Rev. Autor Descrição
30/10/08 2 Oscar Barbosa Desenvolvimento de documentação referente à integração de informações entre sistemas através de arquivos XML.
05/11/08 3 Edson G. Freitas Revisão conforme conversado em 04/11/08 com Oscar.
26/11/08 4 Luiz F Campanha Inclusão de novas propriedades no XML de nota fiscal do pedido de venda.
12/12/08 5 Luiz F Campanha Correções e ajuste no exemplo da nota fiscal, implementação do tamanho máximo dos campos alfanuméricos.
06/01/08 6 Luiz F Campanha Inclusão do lote e da localização de estoque na nota de remessa.
26/02/09 7 Edson G. Freitas Manutenção da tabela de movimentação de estoque.
07/03/09 8 Luiz F Campanha Manutenção da tabela de movimentação de estoque.
21/04/09 9 Ewaldo Leme / Manutenção nos layouts e nomenclaturas.
Dennis Fazio /
Luciana Moreira
19/08/10 10 Luciana Moreira / Revisão.
Paulo Degering
20/09/2010 11 Luciana Moreira / Documentação do XML da integração do módulo Volumes.
Oscar Barbosa
22/09/2010 12 Luciana Moreira / Inclusão do XML de item de estoque para a versão 21.012.
Gleydson Ribeiro
23/09/2010 12 Luciana Moreira / Inclusão do XML de importação de lançamentos de Pós-Cálculo (ACR).
Oscar Barbosa
08/11/2010 13 Luciana Moreira / Inclusão de tags adicionais para o módulo Controle de Volumes.
Anderson Floriano
22/10/2010 14 Luciana Moreira / Inclusão do XML de exportação das informações de requisição de itens de estoque de Volumes.
Oscar Barbosa
15/12/2010 15 Luciana Moreira / Inclusão do XML de suspensão ou finalização do trabalho no Jobtrack.
Anderson Floriano
05/07/2011 16 Luciana Moreira / Inclusão do XML de importação de títulos financeiros e atualização do XML de transações de estoque.
Anderson Floriano
07/07/2011 17 Luciana Moreira / Inclusão de nova TAG para comportar dados de um arquivo texto contendo o XML, e inclusão de campo para inserir
Celso Nascimento o código do fornecedor caso o campo StockCode esteja vazio.
01/08/2011 18 Luciana Moreira / Inclusão de uma nova TAG para agrupamento de transações de custo, inclusão de uma nova TAG para moedas
Anderson Floriano estrangeiras de títulos financeiros e inclusão de TAGs referentes ao código fiscal do país e do vendedor no sistema
terceiro.
22/09/2011 19 Anderson Floriano Inclusão de TAGs para preenchimento de grupo de materiais, grupo de materiais master e tipos de materiais
personalizados no XML STKItem.
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

14/03/2012 20 Luciana Moreira / Inclusão de novos tipos para comissão do pedido de venda, itens de estoque, campo de item de estoque para os
Anderson Floriano itens de pedido de vendas na nota fiscal e referência ao vendedor no pedido de venda.
25/05/2012 21 Luciana Moreira / Inclusão de uma nova TAG para verificar se o item está ou não ativo.
Denise Cordeiro
27/07/2012 22 Luciana Moreira / Inclusão de uma nova TAG para informar o número de identificação de títulos financeiros.
Denise Cordeiro
11/09/2012 23 Denise Cordeiro Inclusão de uma nova TAG para informar se o cadastro é do tipo Vendedor ou não, e inclusão de uma nova TAG
para informar o tipo de produto vinculado ao cliente.
17/10/2012 24 Thiago Ishida Inclusão de uma nova TAG para informar os dados da agência do pedido de venda e de uma nova propriedade que
indica se a agência é responsável pelo pagamento do título.
07/01/2013 25 Juliana Diniz / Inclusão de uma nova TAG para informar observações para pedidos de venda.
Luciana Moreira
11/01/2013 25 Oscar Barbosa / Inclusão dos campos de usuário do Relacionamento Metrics;
Luciana Moreira Inclusão dos campos Código do Centro de Custo e Nome do Centro de Custo nas Transações de Estoque;
Inclusão dos campos ProjectCode e ProjectTitle no cabeçalho da ordem de produção;
Inclusão de 2 novas opções no campo Status do cabeçalho da ordem de produção: Ordem de produção bloqueada e
Ordem de produção em avaliação;
Inclusão da lista de serviços terceirizados no WorkOrder;
Inclusão do campo IsFSC para indicar se o produto final é ou não FSC no SDIWOFinishedItem.
07/03/2013 26 Denise Cordeiro / Inclusão de campos para:
Luciana Moreira  informar a Condição de pagamento padrão cadastrada no cadastro de Relacionamentos;
 informar o código da conta de custo de terceiros
 informar a descrição da conta de custo de terceiros
 informar o código de identificação da transação de estoque
 informar se o parâmetro “Utiliza controle de terceiros” do cadastro do item de estoque está ou não
selecionado
 informar o código do lote do fornecedor
14/03/2013 27 Sila Ferrari / Luciana Alterada a descrição do atributo Return da tag <sdiXmlReturn>.
Moreira
04/04/2013 27 Denise Cordeiro / Inclusão de uma nova TAG para exportar informações referentes aos volumes, cadastradas no item de estoque.
Luciana Moreira
08/04/2013 28 Denise Cordeiro / Inclusão de um novo atributo para informar o e-mail do cadastro do relacionamento.
Luciana Moreira
25/04/2013 29 Denise Cordeiro / Inclusão de 5 novos atributos para informar o número da OP origem, o Motivo de Reimpressão e outras
Luciana Moreira informações desejadas.
02/05/2013 30 Denise Cordeiro / Inclusão de um novo atributo para informar a moeda da atividade de terceiros do orçamento.
Luciana Moreira

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

17/06/2013 31 Denise Cordeiro / Inclusão de 11 novos atributos no contexto STKItem e do atributo CarrierCode para informar o código da
Luciana Moreira / transportadora.
Oscar Barbosa
17/07/2013 32 Denise Cordeiro / Inclusão de uma nova opção para informar o tipo de pessoa no cadastro de clientes.
Luciana Moreira
23/09/2013 33 Sila Ferrari / Luciana Remoção da tag ActorStageType dos contextos sdiCrmSupplier, sdiCrmCustomer e sdiCrmActorService.
Moreira
27/09/2013 34 Sila Ferrari / Luciana Alteração da obrigatoriedade da tag IsProspect.
Moreira
23/10/2013 35 Thiago Ishida / Inclusão de uma nova opção para exportar o plano de contas contábil do Metrics e de uma nova opção para
Luciana Moreira exportar a classificação fiscal do item de estoque.
30/10/2013 36 Oscar Silvério / Correção da tag sdiBilPayCondInfo
Luciana Moreira / Inclusão de novos contextos para importar a classificação fiscal dos itens de estoque e para exportar lançamentos
Thiago Ishida contábeis e saldos de estoque e revisão dos contextos CRM, STKItem e BIL.
01/01/2014 37 Oscar Barbosa Implementação da Interface IMetricsSDIBasicCall. Esta interface permite que programas escritos em JAVA e C#
acessem o WEBService.
02/01/2014 37 Ronaldo Carneiro Inclusão da exportação das notas fiscais dos módulos Compras e Faturamento no formato exigido pela SEFAZ para
nota fiscal eletrônica.
03/01/2014 37 Thiago Ishida Inclusão da exportação do cadastro de centros de custo.
14/01/2014 38 Denise Cordeiro Inclusão de atributo para informar a observação do pedido de venda.
29/01/2014 39 Sila Ferrari/Walisson Inclusão de atributos no contexto sdiStkVolumeItem.
Santos
19/03/2014 40 Denise Cordeiro / Inclusão de atributos no contexto sdiStkBalance.
Luciana Moreira
04/04/2014 41 Oscar Barbosa / Criação da .dll MetricsSDIClientDLL.dll para encapsular as chamadas do WebService da Efi Metrics.
Luciana Moreira
14/05/2014 42 Thiago Ishida / Criação de novo contexto para importação e exportação do Pedido de Compra.
Luciana Moreira
03/06/2014 43 Gustavo Gomes / Inclusão da operação INSERTUPDATE no contexto sdiOperation.
Luciana Moreira
22/08/2014 44 Sila Ferrari / Luciana Inclusão das propriedades UnitCostCode e QuantityUnitCost no contexto STK.
Moreira
02/02/2014 45 Denise Cordeiro / Inclusão de atributo para informar se o cadastro de relacionamento é optante do simples nacional.
Luciana Moreira
27/03/2015 46 Gustavo Gomes / Inclusão de atributos de apontamentos de produção.
Luciana Moreira
20/04/2015 47 Gustavo Gomes / Inclusão do Id da atividade da ordem de produção.
Luciana Moreira

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

24/04/2015 48 Gustavo Gomes / Inclusão de novos campos na interface XML JBT_APT.

Luciana Moreira
15/05/2015 49 Gustavo Gomes / Inclusão do atributo Quantity no XML JBT_APT.
Luciana Moreira
18/05/2015 50 Thiago Ishida / Inclusão de atributos para exportar detalhamento dos componentes definidos no Orçamento.
Luciana Moreira
21/07/2015 51 Sila Ferrari / Luciana Correção de nome de parâmetro.
Moreira
18/01/2016 52 Francilene Idalgo Inclusão de atributos de limite de crédito no contexto CRM
19/01/2016 52 Denise Cordeiro Inclusão de atributo TipoItemSped no contexto STKITEM
10/02/2016 53 Luciana Moreira / Inclusão dos campos de usuário do cadastro de Relacionamentos Metrics no contexto STKITEM
Alexandre Meletti
07/03/2016 54 Denise Cordeiro Inclusão de atributo TransactionCodeExtref no contexto STK
21/03/2016 55 Denise Cordeiro Inclusão de novos atributos no nó sdiLsoritemdelivery no contexto SOR
13/05/2016 56 Oscar Silvério / Inclusão de novo contexto para importação de solicitação de Picking (PCK).
Thiago Ishida /
Luciana Moreira
19/05/2016 57 Oscar Silvério / Inclusão de novos contextos para importação e exportação de lotes de pagamento a terceiros e para importação e
Thiago Ishida / exportação de solicitações de compra.
Luciana Moreira
21/06/2016 58 Calixto Basso / Inclusão de 3 atributos no contexto STKITEM.
Luciana Moreira
16/09/2016 59 Calixto Basso / Inclusão da tag para informar a chave de acesso da NFe no contexto BIL e das tags UnitWeight, PackagingQty e
Luciana Moreira PackagingUnit no contexto STKITEM.
17/10/2016 60 Calixto Basso / Inclusão de tags no contexto POR para campos de usuário e código externo do pedido de compra.
Luciana Moreira
27/12/2016 61 Calixto Basso / Inclusão de tag no contexto SOR para encerramento das entregas de um pedido de venda.
Luciana Moreira
02/02/2017 62 Calixto Basso / Inclusão de tags no contexto CR para permitir receber do site os títulos de Adiantamento associados ao Pedido
Luciana Moreira de venda quando for realizado o pagamento pelo cliente diretamente no site.
13/02/2017 63 Calixto Basso / Inclusão de tags no contexto SOR para permitir a importação e exportação do número da ordem de compra e do
Luciana Moreira número do item do pedido nas entregas.
29/03/2017 64 Luciana Moreira Inclusão de tags no contexto STK para preencher as informações do lote de estoque quando o item de estoque for
controlado por rastreabilidade.
22/05/2017 65 Alexandre Meletti / Correções.
Luciana Moreira
21/06/2017 66 Calixto Basso / Inclusão de tags no contexto CR de importação, para importar o Tipo de Documento e Conta Corrente do titulo
Luciana Moreira financeiro.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

13/07/2017 67 Calixto Basso / Inclusão de tag no contexto STK de exportação, para enviar o peso total da transação baseado na quantidade
Luciana Moreira movimentada, multiplicada pelo peso em kg do cadastro de itens de estoque.
20/07/2017 68 Calixto Basso / Inclusão de tags no contexto CR de importação para rateio de títulos financeiros.
Luciana Moreira
09/08/2017 69 Thiago Ishida / Inclusão de tags nos contextos SOR, CRM, STKITEM e inclusão de propriedade no XMLReturn para identificar o
Luciana Moreira registro importado.
25/09/2017 70 Thiago Ishida / Inclusão de tags nos contextos CRM e STKITEM.
Luciana Moreira
04/12/2017 71 Calixto Basso / Inclusão de tag no contexto CR para importar/exportar o código da forma de pagamento.
Luciana Moreira
15/12/2017 72 Calixto Basso / Inclusão de tags no contexto BIL para devoluções do pedido de venda.
Luciana Moreira
02/01/2018 73 Oscar Silvério / Remoção das tags e contextos referentes ao sistema Loguin.
Luciana Moreira
08/01/2018 74 Luciana Moreira Reestruturação do manual – inclusão de coluna Observações e redefinição da estrutura de tópicos do manual para
1. MÓDULO, 1.1 CONTEXTO, 1.1.1 DIAGRAMA, 1.1.2 OPERAÇÕES 1.1.2.1 IMPORTAÇÃO e 1.1.2.2 EXPORTAÇÃO.
11/07/2018 75 Leonardo Rocha/ Inclusão da observação sobre campos de usuário somente exportados.
Luciana Moreira
06/08/2018 76 Calixto Basso / Inclusão do contexto REC para exportação de notas fiscais de remessa de compra procesadas.
Luciana Moreira
07/09/2018 77 Alex Parolin / Inclusão do contexto INT-OP para permitir importar para o JobTrack as informações das ordens de produção
Luciana Moreira enviadas para o M3 Planner.

12/11/2018 78 Leonardo Rocha / Inclusão de tags no contexto STK.

Luciana Moreira
07/12/2018 79 Cristiano Carlos / Removidas as informações de campos somente exportados que agora podem ser também importados.
Luciana Moreira
03/01/2020 80 Oscar Silvério / Alteração da estrutura do manual.
Luciana Moreira
16/01/2020 81 Sila Ferrari / Luciana Inclusão de recurso de Exportação para o contexto INT-OP e inclusão de campos de usuário no contexto
Moreira / Calixto SDISorInfo.
Basso
07/02/2020 82 Danilo Sanchez / Disponibilizados, no contexto BIL, os campos Ordem de Compra e Nro item da entrega, como são enviados no item
Luciana Moreira do pedido.
08/06/2020 83 Thiago Ishida / Disponibilizadas tags para importação no contexto PCK.
Luciana Moreira

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

18/06/2020 84 Cristiano Vieira / Disponibilizados:

Luciana Moreira / - ajustes para permitir a importação de transações de atendimento e devolução de requisição de materiais.
Thiago Ishida - um novo contexto para importação e exportação de requisições de materiais (REQ).
23/06/2020 84 Calixto Basso / Disponibilizadas novas regras para importação do contexto PCK.
Luciana Moreira
22/10/2020 85 Calixto Basso / Disponibilizadas novas regras para a operação INSERT do contexto STK.
Luciana Moreira
12/11/2020 86 Thiago Ishida / Disponibilizados dois novos contextos WIP e WIP_TR.
Luciana Moreira

Legendas

Termo Significado
XMLOperation XML que informa a operação que será executada.
XMLData XML que contém os dados da operação que será executada.
XMLReturn XML que retorna o status da operação efetuada.
Elemento Tag XML <elemento></elemento>
Atributo Atributos referentes ao elemento do XML.

2. Introdução
Este documento aborda conceitos e técnicas para a integração de outros sistemas com o ERP Metrics. Juntamente com este documento, você
receberá um exemplo de código XML, que deve ser executado antes de se iniciar o desenvolvimento.

Após executar o código XML recebido como exemplo, caso encontre alguma divergência entre as tags nele encontradas e as tags deste
manual, utilize as tags encontradas no código de exemplo. Todos os atributos devem ser digitados em letras minúsculas, apesar de
constarem neste manual com algumas letras maiúsculas, com o objetivo único de facilitar a leitura.

3. Objetivo
Disponibilizar uma solução eficiente, segura e padronizada para intercâmbio de informações entre sistemas.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

4. Pré-Requisitos
Para que seja possível utilizar a integração descrita neste manual, é necessário que a configuração do IIS para o SDI seja de 32 bits.

5. Responsabilidades
5.1. Cliente
 Desenvolver recurso para gerar e gravar os arquivos XML de acordo com este documento, permitindo a importação e exportação de
informações.

5.2. Efi
 Manter este documento atualizado.
 Disponibilizar o módulo SDI para monitorar o intercâmbio de informações.
 Disponibilizar o servidor MTCSERVER para processar as transações.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

6. Tecnologias envolvidas
 XML
 SQL Server ou WebServices

7. Operações
7.1. Importação
A integração ocorre através da importação de registros gravados na tabela de integração para a base de dados do ERP Metrics.

7.2. Exportação
Quando o ERP Metrics identificar a necessidade de exportar uma informação (por exemplo, um telefone atualizado de um relacionamento), os
registros serão incluídos na tabela de integração. O sistema que necessitar desta informação deverá ler a tabela de integração para identificar a
existência de novos registros.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

8. Layout das tabelas de integração

8.1. Tabela de Importação
Nome da tabela: sdiTmImportData;
Localização: Banco de dados do ERP Metrics;
Atributos:
 DtProcessing datetime Data e hora em que o sistema Metrics importou o registro;
 InsDt datetime Data e hora em que o sistema terceiro gravou o registro;
 ExtRef varchar Campo livre para uso do sistema;
 InsUser varchar Usuário que incluiu o registro;
 XMLOperation text XML com informações das operações que foram realizadas no sistema de terceiros;
 XMLData text XML com informações do registro alterado;
 XMLReturn text XML com informações do resultado da importação dos dados pelo sistema Metrics;
 HasError int Indica o resultado do processamento do registro. Sendo “0”- registro processado sem erros, ou
Diferente de “0”- registro processado com erros;
 idimportdata int Chave primaria da tabela, campo seqüencial de auto incremento;
 ContextType varchar Determina o contexto dos dados exportados pelo sistema Metrics: informações sobre clientes
(CRM), Pedido de Venda (SOR), Notas Fiscais (BIL) e Contas a Receber (CR).

8.2. Tabela de Exportação

Nome da tabela: sdiTmExportData;
Localização: Banco de dados do ERP Metrics;
Atributos:
 DtProcessing datetime Data e hora em que o sistema importou o registro;
 InsDt datetime Data e hora em que o sistema Metrics gravou o registro;
 ExtRef varchar Campo para uso do sistema Metrics;
 InsUser varchar Usuário que incluiu o registro;
 XMLOperation text XML com informações das operações que foram realizadas no sistema Metrics
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

 XMLData text XML com informações do registro alterado.

 XMLReturn text XML com informações referentes ao resultado da importação dos dados;
 HasError int Indica o resultado do processamento do registro: sendo “0”- registro processado sem
erros, ou diferente de “0”- registro processado com erros;
 idExportdata int Chave primária da tabela, seqüencial;
 ContextType varchar Determina o contexto dos dados exportados pelo sistema Metrics: informações sobre
clientes (CRM), Pedido de Venda (SOR), Notas Fiscais (BIL) e Contas a Receber (CR).

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

9. Diagrama macro de funcionamento da integração através de banco de

dados

9.1. Importação

Sistema Terceiro ERP Metrics

Grava o resultado da
operação realizada.
Grava o tipo de operação. Tabela: sdiTMImportData C
A Tabela: sdiTMImportData Coluna: XMLReturn
Coluna: XMLOperation

XML Operação XML Retorno

DB
Metrics D

Processamento
A
XML Dados B
Consulta situação das
importações e exportações
Grava o dados da operação de relacionamentos e
Tabela: sdiTMImportData pedidos através do módulo
Coluna: XMLData SDI

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Legenda

A. O registro é gravado na tabela sdiTMImportData, no banco de dados Metrics.

B. O Metrics processa os dados importados.
C. Após processamento, é atualizado o registro com XMLReturn, informando ao usuário se a operação foi realizada com sucesso ou se ocorreu
alguma inconsistência.
D. Através do módulo Metrics SDI, o usuário realiza consultas para verificar se os processos de importação, atualização e exportação foram
realizados com sucesso ou para verificar o motivo que gerou inconsistências durante o processamento, permitindo a devida correção para
processamento posterior.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

9.2. Exportação

Sistema Terceiro ERP Metrics

Grava o tipo de operação.

Grava o resultado da Tabela: sdiTMExportData A
operação realizada. Coluna: XMLOperation
Tabela: sdiTMExportData
Coluna: XMLReturn
B

XML Operação

Grava o dados da operação

Tabela: sdiTMExportData
A
DB Coluna: XMLData
Metrics
XML Retorno

XML Dados

DB
Terceiro Consulta situação das
importações e exportações
de relacionamentos e
Alimenta sistema terceiro pedidos através do módulo C
SDI

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Legenda

A. Ao realizar alterações em algum pedido ou relacionamento, os XML’s de Operação e Data são gravados na tabela de exportação, para
posterior importação no sistema terceiro.
B. O sistema terceiro coleta informações dos XML´s que foram gravados na tabela de exportação, gerando um arquivo XMLReturn com o status
do processamento.
C. Através do módulo Metrics SDI, o usuário realiza consultas para verificar se os processos de importação, atualização e exportação foram
realizados com sucesso ou para verificar o motivo que gerou inconsistências durante o processamento, permitindo a devida correção para
processamento posterior.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

10. Diagrama macro de funcionamento da integração através do

WebServices

Servidor IIS

Sistema Metrics
ERP Metrics
Terceiro Metrics
SDI WebServices

MetricsSDIClientDLL.dll

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11. Funcionalidades e Interfaces do WebServices

11.1. Interface IMetricsSDIWebService
11.1.1 GetPendingTransaction
Permite obter as transações processadas no Metrics e que estão disponíveis para serem importadas em sistemas de terceiros.

Parâmetros de Entrada
SDICredentials

Parâmetros de Saída
GetPendingTransactionResponse

11.1.2 SetTransactionResult
Permite ao sistema de terceiro informar o resultado do processamento de uma transação gerada pelo sistema Metrics. Obtém a transação do
GetPendingTransaction, e utiliza esta função para devolver o resultado.

Parâmetros de Entrada
SDICredentials
SDITransactionHeader
SDITransactionResult

Parâmetros de Saída
SetTransactionResultResponse

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.1.3 ProcessTransaction
É acionada pelo sistema de terceiro para que o ERP Metrics processe a importação de informações.

Parâmetros de Entrada
SDICredentials
SDITransactionHeader
SDITransactionData
SDITransactionOperation

Parâmetros de Saída
ProcessTransactionResponse

11.2. Definição dos tipos de dados

Nome da interface
SDICredentials
GetTransactionResponse
Propriedade Formato Descrição
Interface Interface para validar o usuário
User String Código de logon do usuário no sistema Metrics
Password String Senha de logon do usuário no sistema Metrics
Interface Interface de retorno da função
GetPendingTransaction
SDIRequestResult Interface Interface de retorno do resultado da requisição
SDITransactionHeader Interface Cabeçalho da transação
SDITransactionOperation Interface Interface para informar qual operação será
realizada com o XML informado na interface
SDITransactionData.
SDITransactionData Interface Interface com o XMLData necessário para
processar a informação
SDITransactionResult Interface Interface de retorno do resultado do processamento
da transação

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

TotalPendingTransaction Int Total de transações pendentes, considerando a

atual.
SDIRequestResult Interface Interface de retorno do resultado da requisição
ReturnCode Int 0 – OK
Outro código - Erro
MSG String Mensagem de erro
SDITransactionHeader Interface Cabeçalho da transação
TransactionID Int Número de identificação da transação no sistema
Metrics
DtProcessing String Data de processamento da transação.
Formato: yyyy-mm-dd hh:nn:ss
InsDt String Data da inclusão da transação.
Formato: yyyy-mm-dd hh:nn:ss
ExtRef String Código utilizado pelo sistema de terceiro para
identificar a transação
InsUser String Código do usuário
HasError Int 0 - OK
1 – com erro
ContextType String Contexto da transação
SDITransactionOperation Interface Interface para informar qual operação será
realizada com o XML informado na interface
SDITransactionData.
Operation String Código da operação
SDITransactionData Interface Interface com o XMLData necessário para
processar a informação
XMLData String Contém o XMLData da operação, conforme o
contexto
SDITransactionResult Interface Interface de retorno do resultado do processamento
da transação
ReturnCode Int 0 – OK
Outro código – Erro
Operation String Operação que resultou em erro
MSG String Mensagem de erro

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

SetTransactionResultResponse Interface Interface de retorno da função

SetTransactionResult
SDIRequestResult Interface Interface de retorno do resultado da requisição
ProcessTransactionResponse Interface Interface de retorno do resultado do processamento
da função ProcessTransaction
SDITransactionResult Interface Interface de retorno do resultado do processamento
da transação
SDIRequestResult Interface Interface de retorno do resultado da requisição

11.3. Interface IMetricsSDIBasicCall

11.3.1 Parâmetros comuns
pUser: código do usuário cadastrado no controle de acesso do Metrics
pPsw: password do usuário
pIdTransaction: identificação da transação no Metrics processada pelo sistema de terceiro;
pExtref: identificação da transação no sistema de terceiro
pHasError: identificação de erro no processamento da transação: 0 ok, -1 com erro

11.3.1.1 GetPendingtrasctionBasic/GetPendingtrasctionBasic2
Permite obter as transações processadas no Metrics e que estão disponíveis para serem importadas em sistemas de terceiros.

Parâmetros de Entrada:
pUser: string; pPsw: string

Parâmetros de Saída
Result: string

<GetPendingtrasctionBasicResponse><RequestResult> ReturnCode="0" Msg="<![CDATA['Texto da mensagem de retorno']]>"

TotalPendingTransaction="1" </RequestResult> <SDITransactionHeader> TransactionID="12345" ContextType="CRM" Operation="INSERT"

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

</SDITransactionHeader> <XMLData> <![CDATA['<METRICS><crmttcactor> ..... </METRICS>']]> </XMLData> <TransactionResult>

ReturnCode="0" Operation="INSERT" Msg="<![CDATA['Texto da mensagem de retorno']]>" </TransactionResult>
</GetPendingtrasctionBasicResponse>

<XMLData></XMLData> Contém o xml com os dados para processamento da transação;

TransactionID : identificação da transação no Metrics;
TotalPendingTransaction : total de transações pendentes;

A diferença entre o GetPendingtrasctionBasic e o GetPendingtrasctionBasic2 é que o GetPendingtrasctionBasic2 não apresenta os caracteres

<![CDATA[', da seguinte maneira:

<GetPendingtrasctionBasicResponse><RequestResult> ReturnCode="0" Msg="Texto da mensagem de retorno"

TotalPendingTransaction="1" </RequestResult> <SDITransactionHeader> TransactionID="12345" ContextType="CRM" Operation="INSERT"
</SDITransactionHeader> <XMLData> XMLDATA=”<METRICS><crmttcactor> ..... </METRICS>” </XMLData> <TransactionResult>
ReturnCode="0" Operation="INSERT" Msg="Texto da mensagem de retorno" </TransactionResult> </GetPendingtrasctionBasicResponse>

11.3.1.2 SetTransactionResultBasic/SetTransactionResultBasic2
Permite ao sistema de terceiro informar o resultado do processamento de uma transação gerada pelo sistema Metrics. Obtém a transação do
GetPendingTransactionBasic, e utiliza esta função para devolver o resultado.

Parâmetros de Entrada
pUser: string; pPsw: string ; pIdTransaction: integer; pExtref: string; pHasError: integer; pResult: string

Parâmetros de Saída
Result: string

Formato da Saída:

<SetTransactionResultResponse> ReturnCode="0'' Msg="<![CDATA['Texto da mensagem de retorno']]>"

</SetTransactionResultResponse>

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

A diferença entre o SetTransactionResultBasic e o SetTransactionResultBasic2 é que o SetTransactionResultBasic2 não apresenta os

caracteres <![CDATA[', da seguinte maneira:

<SetTransactionResultResponse> ReturnCode="0'' Msg="Texto da mensagem de retorno" </SetTransactionResultResponse>

11.3.1.3 ProcessTransactionBasic/ProcessTransactionBasic2
É acionada pelo sistema de terceiro para que o ERP Metrics processe a importação de informações.

Parâmetros de Entrada
pUser: string; pPsw: string ; pContext: string; pExtRef: string; pXmlData: string; pOperation: string

Parâmetros de Saída
Result: string

Formato da Saída:
<ProcessTransactionBasicResponse> ReturnCode="0" Operation="INSERT" Msg="<![CDATA['Texto da mensagem de retorno']]>"
</ProcessTransactionBasicResponse>

A diferença entre o ProcessTransactionBasic e o ProcessTransactionBasic2 é que o ProcessTransactionBasic2 não apresenta os caracteres

<![CDATA[', da seguinte maneira:

<ProcessTransactionBasicResponse> ReturnCode="0" Operation="INSERT" Msg="Texto da mensagem de retorno"

</ProcessTransactionBasicResponse>

11.3.1.4 MetricsSDIClientDLL.dll
A DLL faz chamadas ao WebService da efi© facilitando o desenvolvimento da integração pelo cliente.
Deve ser utilizado o programa MetricsSDIClient.exe para gerar o arquivo de configuração utilizado pela DLL.

Funções implementadas pela DLL:

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

function ProcessTransactionBasic ( pContext: string; pExtRef: string; pXmlData: string; pOperation: string): string ;

Parâmetros de Entrada
pContext: string; pExtRef: string; pXmlData: string; pOperation: string

Parâmetros de Saída
Result: string

Formato da Saída:
<ProcessTransactionBasicResponse> ReturnCode="0" Operation="INSERT" Msg="Texto da mensagem de retorno"
</ProcessTransactionBasicResponse>

function SetTransactionResultBasic ( pIdTransaction: integer; pExtref: string; pHasError: integer; pResult: string): string ;

Parâmetros de Entrada
pIdTransaction: integer; pExtref: string; pHasError: integer; pResult: string

Parâmetros de Saída
Result: string

Formato da Saída:
<SetTransactionResultResponse> ReturnCode="0'' Msg="Texto da mensagem de retorno" </SetTransactionResultResponse>

function GetPendingTransactionBasic : string ;

Parâmetros de Saída
Result: string

<GetPendingtrasctionBasicResponse><RequestResult> ReturnCode="0" Msg="Texto da mensagem de retorno" TotalPendingTransaction="1"

</RequestResult> <SDITransactionHeader> TransactionID="12345" ContextType="CRM" Operation="INSERT" </SDITransactionHeader>
<XMLData> XMLDATA=”<METRICS><crmttcactor> ..... </METRICS>” </XMLData> <TransactionResult> ReturnCode="0" Operation="INSERT"
Msg="Texto da mensagem de retorno" </TransactionResult> </GetPendingtrasctionBasicResponse>

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.4. Metrics - Módulo SDI

O módulo SDI disponibiliza ao usuário uma ferramenta para consultar o status de suas importações e exportações de informações referentes a
cadastros de relacionamentos e pedidos de venda.

Através desta ferramenta o usuário poderá verificar se uma operação foi executada com sucesso ou se apresentou inconsistências.

Em caso de inconsistências, será exibida uma mensagem informando a origem do erro.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.4.1. Funcionalidades
11.4.1.1. Exibir Exportações / Exibir Importações
Ao clicar em um destes botões, serão carregadas as transações de importação ou exportação realizadas para consulta. Estas informações serão
listadas no grid Transações, e em Detalhes de transação serão exibidos detalhes do arquivo que estiver selecionado em Transações.

11.4.1.2. Pesquisar

Trata-se de uma tela de filtragem onde o usuário pode selecionar os XML´s cujo status deseja consultar, de acordo com o tipo de operação, situação,
tipo de processamento, data de inclusão, data de processamento e código externo.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Opções de filtragem
Opção Explicação
Tipo de Operação Informar:
SOR = Pedidos de Venda
ou
CRM = Relacionamentos
Situação Opções:
- Todas
- Aguardando
- Processadas
Tipo de processamento Opções:
- Todas
- OK
- c/ Erro
Data de inclusão Data em que o XML foi importado para o banco de dados.
Data de processamento Data em que o XML foi processado pelo sistema.
Código Externo Referência externa.
Exemplo: código do pedido no sistema terceiro.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.4.1.3. Atualizar

Permite exibir novos XMLs processados no momento.

11.4.1.4. Grade Transações

Nesta grade são exibidos os XML´s retornados após a filtragem de dados.

Colunas do Grid
Coluna Explicação
ID Transação Exibe a identificação da transação.
Tipo de Operação Exibe o tipo de operação que foi realizada: INSERT, UPDATE ou
DELETE.
Data Inclusão Exibe a data em que o arquivo XML foi importado para o banco de dados.
Usuário Inclusão Na exportação: usuário logado no Metrics
Na importação: usuário logado no sistema terceiro (gravado no
campoInsUser).
Data do Processamento Exibe a data em que o arquivo foi processado.
Status do Processamento Exibe o status do processamento: aguardando ou processado.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.4.1.4.1. Detalhes da Transação

Exibe informações detalhadas sobre cada um dos arquivos referentes a uma transação (Operação, Dados e Retorno).

11.5. Especificação dos arquivos XML

Verifique, a seguir, as estruturas dos arquivos XML (XMLOperation, XMLData e XMLReturn), informando ao desenvolvedor quais elementos
devem compor os arquivos, quais são obrigatórios, e que valores e atributos devem possuir.
Os atributos que não se aplicam podem ser enviados EM BRANCO.
Ex.: idcountry=””

11.5.1. XMLOperation – Arquivo de operação

Função: arquivo que informa ao sistema o tipo de operação que está sendo executada (INSERT, UPDATE ou DELETE), e também qual tipo de
informação (CRM = Relacionamentos, SOR = Pedidos de venda, etc) está sendo tratada.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.5.1.1. Explicação dos elementos e atributos

ID Elemento Pai Descrição Obrigatório Observações
OE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

OE02 <sdiStandardOperation> OE01 Elemento que dá início ao bloco de Sim
informações.

ID Elemento Pai Descrição Obrigatório Observações

OE3 <sdiLOperationContext> OE02 Informações referentes aos tipos de Sim
operações que serão realizadas.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de tipos de operações Sim
que serão realizadas.
Ex.: LCount=”1”
Obs.: Atualmente o recurso suporta UM
TIPO DE OPERAÇÃO por arquivo.
Deve ser gerado um XML de importação
para cada tipo de operação.

ID Elemento Pai Descrição Obrigatório Observações

OE04 <sdiOperationContext> OE03 Elemento que informa o tipo de Sim
operação que será realizada.
Atributos Tipo Descrição Obrigatório Observações
Name String(10) Informa qual o tipo de operação. Sim
SOR = Pedidos de Venda Metrics
CRM = Relacionamentos Metrics/M3
BIL = Faturas/remessas Metrics
STK = Movimento Estoque Metrics
STK_VL = Importação de Itens de
Volumes
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

STK_VT - Importação e exportação de

Transações de Volumes
STK_VR = Exportação de Requisições
de Volumes
CR = Contas a Receber Metrics
WO = Exportação de Ordem de
Produção
STKITEM = Item de Estoque Metrics/M3
Sequence Int Caso seja realizado mais de um tipo de Sim
operação por vez, cada tipo de
operação receberá um número
seqüencial que deve ser informado
neste atributo.
Obs.: Atualmente o recurso suporta UM
TIPO DE OPERAÇÃO por arquivo.
Deve ser gerado um XML de importação
para cada tipo de operação.
O padrão é =”1”

ID Elemento Pai Descrição Obrigatório Observações

OE5 <sdiLOperation> OE04 Informações referentes à operação que Sim
será realizada.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de operações que Sim
serão realizadas.
Ex.: LCount=”1”
Obs.: Atualmente o recurso suporta
UMA OPERAÇÃO por arquivo. Deve
ser gerado um XML de importação para
cada operação.

ID Elemento Pai Descrição Obrigatório Observações

OE06 <sdiOperation> OE05 Elemento que informa o tipo de Sim
operação que será realizada.
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

Name String(10) Informa qual o tipo de operação: Sim
INSERT, UPDATE ou DELETE.
Sequence int Caso realize mais de uma operação por Sim
vez, cada operação receberá um
número sequencial que deve ser
informado neste atributo.
Obs.: Atualmente o recurso suporta
UMA OPERAÇÃO por arquivo.
Deve ser gerado um XML de importação
para cada operação.
O padrão é =”1”

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.5.1.2. Diagrama de dependência entre os elementos do arquivo

XMLOperation
<Metrics>
OE01

<sdistandardoperation>
OE02

<sdiloperationcontext>
OE03

<sdioperationcontext>
OE04

<sdiloperation>
OE05

<sdioperation>
OE06

11.5.2. XML Return – Arquivo de Status de Processamento

11.5.2.1. Explicação dos elementos e atributos

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

RE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

RE02 <sdiStandardXmlReturn> RE01 Elemento que inicia o bloco de Sim
informações de retorno.

ID Elemento Pai Descrição Obrigatório Observações

RE03 <sdiLXmlReturn> RE02 Informações referentes à operação Sim
que será realizada.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de operações Sim Atualmente o recurso suporta
que serão realizadas. UMA OPERAÇÃO por arquivo.
Ex.: LCount=”1” Deve ser gerado um XML de
importação para cada
operação.

ID Elemento Pai Descrição Obrigatório Observações

RE04 <sdiXmlReturn> RE03 Informações referentes à operação Sim
que será realizada.
Atributos Tipo Descrição Obrigatório Observações
Return Int Código de retorno do Sim
processamento
0 = processamento OK.
1 = ocorreu erro no
processamento.
Msg String(200) Informa mensagem com a Sim
inconsistência ocorrida durante o
processamento.
Operation String(200) Tipo de operação que foi realizada: Sim
INSERT, UPDATE ou DELETE.
OperationSequence Int Número seqüencial de operação. Sim
Sempre será 1.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Atualmente, o sistema comporta

uma operação por XML.
Context String(10) Tipo de informação que consta na Sim
operação.
SOR = Pedidos de Venda Metrics
CRM = Relacionamentos
Metrics/M3
BIL = Faturas/remessas Metrics
STK = Movimento Estoque Metrics
STK_VL = Importação de Itens de
Volumes
STK_VT = Importação e
exportação de Transações de
Volumes
STK_VR = Exportação de
Requisições de Volumes
CR = Contas a Receber Metrics
WO = Exportação de Ordem de
Produção
STKITEM = Item de Estoque
Metrics/M3
ContextSequence Int Número seqüencial de operação. Sim
Sempre será 1.
Atualmente, o sistema comporta
uma operação por XML.
DocNumber Varchar(32) Número identificador único no Não
Metrics do registro importado, que
pode ser:
STKITEM = Código do item de
estoque
SOR = Número do pedido de
venda
CRM = Código do cliente

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

POR = Número do pedido de

compra

11.5.2.2. Diagrama de Dependência entre os elementos do arquivo

XMLReturn

<metrics> <sdiStandardXmlReturn> <sdiLXmlReturn> <sdiXmlReturn>

RE01 RE02 RE03 RE04

11.6. CRM (Relacionamentos)

11.6.1. XMLData – Arquivo de Operação
11.6.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
CE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CE02 <sdiCrmActor> CE01 Contém dados referentes ao Sim
relacionamento
Atributos Tipo Descrição Obrigatório Observações
Code Int Código do relacionamento Sim
OwnerCode Int Código do proprietário Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

PersonTypeCompl Int Informa a Estrutura Corporativa do Sim

relacionamento. "0"=Matriz "1"= Filial
"2"=Área
PersonType Int Informa o tipo do relacionamento que Sim
está sendo cadastrado.
0 = Pessoa Física
1 = Pessoa Jurídica
2 = Governo
3 = Exportação
IdCountry SmalInt Id do cadastro do país no M3. Não
CountryDocumentNumber String(35) CNPJ ou CPF Sim
StateDocumentNumber String(35) Inscrição Estadual Não
CityDocumentNumber String(35) Inscrição Municipal Não
Name String(70) Nome fantasia Sim
FullName String(140) Razão Social Sim
Phone String(60) Telefone comercial Não
Website String(50) Endereço do website. Não
Fax String(60) Número de fax. Não
Note Text Observação sobre o relacionamento. Não
ExtRef String(50) Código do relacionamento no sistema Sim O valor deste campo deve
terceiro. ser diferente do ExtRef do
contato e do endereço.
ExtRefOwnerCode String(50) Código de referência do proprietário. Não
Isactv Boolean Informa se o relacionamento está ativo. Sim
“0”= não “1”=sim
IsCustomer Boolean Informa se o relacionamento é um Sim
cliente.
“0”= não “1”=sim
IsSupplier Boolean Informa se o relacionamento é um Sim
fornecedor.
“0”= não “1”=sim
IsPerson Boolean Informa se o relacionamento é pessoa Sim
física.
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

“0”= não “1”=sim

IsBroker Boolean Informa se o relacionamento é agência. Sim
“0”= não “1”=sim
isCustomerService Int Informa se o relacionamento é Sim
vendedor.
“0”= não “1” =sim
IsRepres Boolean Descontinuado, não utilizar. Não
IsTransport Boolean Informa se o relacionamento é Sim
Transportadora.
“0”= não “1”=sim
CountryCode String(10) Código de países BACEN. Sim
CountryFiscalCode String(10) Código fiscal do país. Sim
UserFieldClassic1 String(50) Informa o campo de usuário definido no Não
relacionamento Metrics
UserFieldClassic2 String(50) Informa o campo de usuário definido no Não
relacionamento Metrics
UserFieldClassic3 String(50) Informa o campo de usuário definido no Não
relacionamento Metrics
UserFieldClassic4 String(50) Informa o campo de usuário definido no Não
relacionamento Metrics
UserFieldClassic5 String(50) Informa o campo de usuário definido no Não
relacionamento Metrics
ConditionPaymentStandard String(30) Informa a condição de pagamento Não
padrão definida no relacionamento
Metrics
Email String(200) Informa o email definido no Não
relacionamento Metrics
Emailtax String(200) Informa o email fiscal definido no Não
relacionamento Metrics
BroptingSimpleNational Int Informa se o cadastro de Não
relacionamento é optante do simples
nacional:
0 - Nenhum

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

1 - Simples Nacional
2 - Simples Nacional - Excesso de
sublimite de receita bruta
3 - Regime Normal
LimitValueCredit Float Informa o limite de crédito definido para Não
um determinado cliente
CreditExpirationDt TDateTime Informa a data de expiração do limite de Não
crédito definido para um determinado
cliente.
EmailBilling String(255) Email de cobrança do relacionamento Não
Metrics.
InvoiceCFOP String(10) CFOP de Fatura do cadastro do Não
Relacionamento
ShippingCFOP String(10) CFOP de Remessa do cadastro do Não
Relacionamento
InvoiceandShippingCFOP String(10) CFOP de Fatura/Remessa do cadastro Não
do Relacionamento

ID Elemento Pai Descrição Obrigatório Observações

CE03 <sdiLCrmActorContact> CE02 Informações referentes aos contatos do Sim
relacionamento
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de contatos que Sim
serão carregados.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

CE04 <sdiCrmActorContact> CE03 Informações referentes aos contatos do Sim
relacionamento
Atributos Tipo Descrição Obrigatório Observações
Code String(50) Código do contato no M3. Não
Name String(70) Primeiro nome do contato. Sim
FullName String(140) Nome completo do contato. Não

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ExtRef String(50) Código do contato no sistema terceiro. Não O valor deste campo deve
ser diferente do ExtRef do
cliente e do endereço.
Phone String(60) Telefone do contato. Não
PhoneExtension String(10) DDD do telefone. Não
MobilePhone String(60) Telefone celular do contato. Não
EMail String(200) E-mail do contato. Não
Division String(50) Departamento do contato. Não
Note Text Comentários sobre o contato. Não
BirthDate TDateTime Data de nascimento do contato. Não
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
TreatmentForm String(50) Forma de tratamento. Não
IsActv Boolean Informa se o contato está ativo. Não
“0”= não “1”=sim

ID Elemento Pai Descrição Obrigatório Observações

CE05 <sdiLCrmAddress> CE02 Informações referentes aos endereços Sim
do relacionamento
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de endereços Sim
contidos no bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

CE06 <sdiCrmAddress> CE05 Informações referentes aos endereços Sim
do relacionamento.
Atributos Tipo Descrição Obrigatório Observações
IdAddress Int Identificador do endereço no M3. Não
CityCode Int Código da cidade Sim
AddressPrefix String(10) Rua, Avenida, etc. Sim
AddressName String(100) Nome da rua, avenida, etc. Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

AddressNumber String(10) Número do endereço Sim

AddressComplement String(60) Complemento do endereço Não
District String(60) Nome do Bairro Sim
ZipCode String(20) CEP Sim
Reference String(60) Ponto de referência Não
Note Text Pode conter observações ou notas Não
sobre este endereço.
CityName String(70) Nome da cidade Sim
StateName String(70) Nome do Estado Sim
CountryName String(70) Nome do País Sim
IsBilling Boolean Informa se o endereço é de faturamento Sim
“0”= não “1”=sim
IsCharging Boolean Informa se o endereço é de cobrança Sim
“0”= não “1”=sim
IsMailing Boolean Informa se o endereço é de Sim
correspondência
“0”= não “1”=sim
IsDelivery Boolean Informa se o endereço é de entrega Sim
“0”= não “1”=sim
ExtRef String(50) Código de referência do sistema terceiro Sim O valor deste campo deve
para o endereço. ser diferente do ExtRef do
cliente e do contato.
StateCode String(10) Código do Estado Sim

ID Elemento Pai Descrição Obrigatório Observações

CE07 <sdiCrmCustomer> CE02 Contém dados do relacionamento Sim
quando este for cliente.
Atributos Tipo Descrição Obrigatório Observações
SalesManCode String(32) Código do vendedor Não
Note Text Notas do cliente Não
IsActv Boolean Informa se o relacionamento está ativo Sim
“0”= não “1”=sim
IsProspect Boolean Informa se o cliente é prospect Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

“0”= não “1”=sim

Obs: Essa propriedade só será
considerada na exportação.
Clientes importados só serão
considerados como prospect quando
estes obedecerem às regras do CRM-
M3.
IDIndustry Int Identificador do Segmento Industrial Sim
IndustryTitle String(70) Nome do Segmento Industrial Sim
IDSaleRegion Int Identificador da Região de Venda Sim
SaleRegionTitle String(70) Nome da Região de Venda Sim
SalesManExtRef String(32) Código do vendedor no sistema de Não
terceiros
Corporation String(60) Nome da corporação do relacionamento Não
Metrics
Unity String(20) Unidade do relacionamento Metrics Não

ID Elemento Pai Descrição Obrigatório Observações

CE08 <crmcustomer_u> CE07 Informações referentes à Tabela de Não
Clientes criada pelo usuário.
Atributos Tipo Descrição Obrigatório Observações
idActor Int Informa o ID da Tabela de Clientes Não
criada pelo usuário.

ID Elemento Pai Descrição Obrigatório Observações

CE09 <sdiCrmSupplier> CE02 Contém dados do relacionamento Sim
quando este for fornecedor.
Atributos Tipo Descrição Obrigatório Observações
Note Text Observação referente ao fornecedor. Sim
IsActv Boolean Informa se o relacionamento está ativo. Sim
“0”= não “1”=sim

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

CE10 <crmSupplier_u> CE09 Informações referentes a Tabela de Não

Fornecedores criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações
idActor Int Informa o ID da Tabela de Não
Fornecedores criada pelo usuário.

ID Elemento Pai Descrição Obrigatório Observações

CE11 <sdiCrmPerson> CE02 Contém dados do relacionamento Sim
quando este for pessoa física.
Atributos Tipo Descrição Obrigatório Observações
IdActor Int Código interno Metrics Não
TreatmentForm String(50) Forma de tratamento. Não
BirthDate TDateTime Data de nascimento. Não
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
MobilePhone String(60) Telefone Celular Não
Email String(200) E-mail Não

ID Elemento Pai Descrição Obrigatório Observações

CE12 <crmPerson_u> CE09 Informações referentes à Tabela de Não
Pessoas Físicas criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações
idActor Int Informa o ID da Tabela de Pessoas Não
Físicas criada pelo usuário.

ID Elemento Pai Descrição Obrigatório

CE13 <sdiCrmCustomerService> CE09 Informações referentes à Tabela de Não
Vendedores criada pelo usuário
Atributos Tipo Descrição Obrigatório
ActorAssociatedCode String(50) Código do Relacionamento associado Sim
ao Vendedor

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ActorAssociatedExtRef String(50) Código de referência do sistema terceiro Sim

para o Relacionamento associado ao
Vendedor
Note Text Notas / Observações Não
IsActv Int Indica se o Vendedor está ativo: Sim
“0”=não “1”=sim
StaffCode String(50) Código do Assistente Sim
StaffExtRef String(50) Código de referência do sistema terceiro Sim
para o Assistente
IdSaleTeam String(50) Código da Equipe de Venda à qual o Sim
Vendedor pertence
SaleTeamTitle String(50) Título da Equipe de Venda à qual o Sim
Vendedor pertence
TeamManagerCode String(50) Código do Gerente da Equipe de Venda Sim
à qual o Vendedor pertence
TeamManagerExtRef String(50) Código de referência do sistema terceiro Sim
para o Gerente da Equipe de Venda à
qual o Vendedor pertence
IsSalesman Int Informa a Classificação à qual o Sim
Vendedor pertence:
“0” = Não é vendedor e “1” = É vendedor
IsSalesManager Int Informa a Classificação à qual o Sim
Vendedor pertence:
“0” = Não é gerente de vendas e “1” = É
gerente de vendas
IsSalesStaff Int Informa a Classificação à qual o Sim
Vendedor pertence:
“0” = Não é assistente e “1” = É
assistente
IsSalesExtRep Int Informa a Classificação à qual o Sim
Vendedor pertence:
“0” = Não é representante de vendas e
“1” = É representante de vendas

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

CE14 <crmCustomerService_u> CE09 Informações referentes à Tabela de Não
Vendedores criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações
idActor Int Informa o ID da Tabela de Vendedores Não
criada pelo usuário.

ID Elemento Pai Descrição Obrigatório Observações

CE15 <sdilCrmProduct> CE09 Informações referentes à Tabela de Não
Produtos do Cliente criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de produtos Não
contidos no bloco.
Ex.: LCount = ”8”

ID Elemento Pai Descrição Obrigatório Observações

CE16 <sdiCrmProduct> CE09 Informações referentes à Tabela de Não
Produtos do Cliente criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações
Title String(70) Titulo do Produto. Sim
PrdClassExtref String(03) Código de referência do sistema terceiro Sim
para o código da classe de Produto no
sistema terceiro
UnitExtref String(50) Código da Unidade de Medida no Sim
sistema terceiro.
IdCurrency Int Codigo da moeda padrão para o Produto Sim

ID Elemento Pai Descrição Obrigatório Observações

CE17 <crmActor_u> CE02 Informações referentes à Tabela de Não
Relacionamentos criada pelo usuário
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

idActor Int Informa o ID da Tabela de Não

Relacionamentos criada pelo usuário.

11.6.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (CRM)

<sdilCrmActorContact> <sdiCrmActorContact>

CE03 CE04

<sdilCrmAddress> <sdiCrmAddress>

CE05 CE06

<metrics> <sdiCrmActor> <sdiCrmCustomer> <Crmcustomer_u>

CE01 CE02 CE07 CE08

<sdiCrmSupplier> <crmSupplier_u>

CE09 CE10

<sdiCrmPerson> <crmPerson_u>

CE11 CE12

<crmActor_u>

CE17

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.6.1.3. Importação e Exportação

Na importação e na exportação do CRM são permitidas as operações de INSERT, UPDATE e DELETE.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.7. SOR (Pedidos de Venda)

11.7.1. XMLData – Arquivo de Operação
11.7.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
SE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

SE02 <sdiSORSalesOrder> SE01 Inicia as informações de pedidos Sim

ID Elemento Pai Descrição Obrigatório Observações

SE03 <sdiSORInfo> SE02 Contém informações referentes ao Sim
pedido.
Atributos Tipo Descrição Obrigatório Observações
IdCompany SmallInt Código da empresa que realizou a venda, Sim
conforme cadastro no Metrics.
SaleOrderNumber String(13) Número do Pedido Sim
Status Int Status do Pedido Sim
“1” = Aguardando liberação
“2” = Liberado
“3” = Bloqueado
“4” = Encerrado
SalesManCode String(20) Código do vendedor Sim
CustomerOrderId String(50) Número do pedido de compra Sim
DueDt TDateTime Data do pedido Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

ExtRef String(50) Número do pedido no sistema terceiro ou Sim

qualquer outra referência.
IdCurrency Int Código da moeda no Metrics Sim
QuotationDt TDateTime Data de cotação da moeda Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
ExchangeRate Double Taxa de câmbio Sim
SalesManExtRef String(50) Código de referência para o vendedor Não
SalesOrderNote String(2000) Observações do pedido de venda Não
ShippingType Int Tipo de Frete do Pedido de Venda, que Não
pode ser:
0 = Emitente
1 = Destinatário/Remetente
2 = Terceiros
9 = Sem Frete
UserInfo1 Varchar(50) Campo de usuário 1 Não
UserInfo2 Varchar(50) Campo de usuário 2 Não
UserInfo3 Varchar(50) Campo de usuário 3 Não
UserInfo4 Varchar(50) Campo de usuário 4 Não
UserInfo5 Varchar(50) Campo de usuário 5 Não
UserInfo6 Varchar(50) Campo de usuário 6 Não

ID Elemento Pai Descrição Obrigatório Observações

SE04 <sdiSORPayCondInfo> SE03 Contém dados sobre a condição de Sim
pagamento.
Atributos Tipo Descrição Obrigatório Observações
ConditionCode String(30) Condição de pagamento. Sim
Ex.: À vista, 30/60/90, etc.

ID Elemento Pai Descrição Obrigatório Observações

SE05 <sdiLSORPayCondDueDate> SE04 Contém informações sobre os Sim
vencimentos.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

LCount Int Informa a quantidadede vencimentos do Sim
bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

SE06 <sdiSORPayCondDueDate> SE05 Contém informações sobre os Sim
vencimentos
Atributos Tipo Descrição Obrigatório Observações
DueDate TDateTime Data do vencimento Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
Value Double Valor do Vencimento Sim

ID Elemento Pai Descrição Obrigatório Observações

SE07 <sdiLSORCommissioninfo> SE03 Contém informações sobre as comissões Sim
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de comissões do Sim
bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

SE08 <sdiSORCommissioninfo> SE07 Contém informações sobre as comissões Sim
Atributos Tipo Descrição Obrigatório Observações
CostAccountCode String(16) Código da conta de custo Sim
Código do comissionado (vendedor ou Sim
Code String(30)
agência)
ExtRef String(30) Referência externa no sistema terceiro Sim
Name String(50) Nome do comissionado Sim
CommissionType Int Tipo de comissionado: Sim
1 = Vendedor
2 = Agência

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

3 = Produtor
ValueType Int Tipo de comissão Sim
1 = Percentual
2 = Valor monetário
Value Double Valor da comissão (Monetário ou %) Sim

ID Elemento Pai Descrição Obrigatório Observações

SE09 <sdiSORCustomerinfo> SE02 Contém dados referentes ao cliente Sim
Atributos Tipo Descrição Obrigatório Observações
Code String(32) Código do cliente Sim
Name String(70) Nome Fantasia Sim
ExtRef String(50) Referência externa do cliente (ex.: código Sim
do cliente no sistema terceiro).
ContactName String(75) Nome do contato Sim

ID Elemento Pai Descrição Obrigatório Observações

SE10 <sdiLSORItemInfo> SE02 Contém dados referentes aos itens do Sim
pedido.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de itens de pedidos Sim
do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

SE11 <sdiSORItemInfo> SE10 Contém dados referentes aos itens do Sim
pedido.
Atributos Tipo Descrição Obrigatório Observações
Código preenchido pelo Metrics. Padrão: Não
ItemId String(20)
“”
Seq Int Ordenação dos itens... 1, 2, 3, n Sim
StockCode String(30) Código do item no Metrics Sim
ProductName String(100) Nome do item Sim
UnitValue Double Valor Unitário Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Quantity Double Quantidade Sim

TotalValue Double Valor total do pedido Sim
UnitCode String(10) Unidade do item do pedido (UN, KG, etc.) Sim
WONumber String(8) Número da OP Não
QuoteNumber String(12) Número do Orçamento Não
WoObs Text Observação do Item Não
CustomerStockCode String(30) Código do ítem para o fornecedor Não
Porcentagem de Markup para pedidos Sim
itemmarkuprate Double gerados automaticamente na aprovação
do orçamento pelo OrcClassic
customerpurchaseorder Varchar(15) Número do pedido de compra do cliente Não
Número do item no pedido de compra do Não
customeritempurchaseorder Int
cliente
Campo de Usuário 1. Este campo Não
userinfo1 Varchar(50) somente é utilizado para a exportação de
informações.
Campo de Usuário 2, Este campo Não
userinfo2 Varchar(50) somente é utilizado para a exportação de
informações.
Campo de Usuário 3. Este campo Não
userinfo3 Varchar(50) somente é utilizado para a exportação de
informações.
Campo de Usuário 4. Este campo Não
userinfo4 Varchar(50) somente é utilizado para a exportação de
informações.
Campo de Usuário 5. Este campo Não
userinfo5 Varchar(50) somente é utilizado para a exportação de
informações.
Campo de Usuário 6. Este campo Não
userinfo6 Varchar(50) somente é utilizado para a exportação de
informações.

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

SE12 <sdiLSORItemTaxInfo> SE11 Contém dados referentes aos impostos e Sim

taxas.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de taxas do bloco. Sim
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

SE13 <sdiSORItemTaxInfo> SE12 Contém dados referentes aos impostos. Sim
Atributos Tipo Descrição Obrigatório Observações
TaxId Int Informa o número de identificação da taxa Sim
ou imposto.
Ex.: LCount=”5”
Code String(16) Código da taxa Sim
Name String(40) Descrição do Imposto Sim
ValueType Int Tipo de valor do imposto Sim
1 = Percentual
2 = Valor monetário
Value Double Valor em percentual ou valor monetário. Sim

ID Elemento Pai Descrição Obrigatório Observações

SE14 <sdiLSORItemDelivery> SE11 Contém dados referentes às entregas do Sim
pedido.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de entregas do Sim
bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

SE15 <sdiSORItemDelivery> SE14 Contém dados referentes às Sim
entregas do pedido.
Atributos Tipo Descrição Obrigatório Observações
DeliveryDt TDateTime Data da entrega Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
DeliveryQty Double Quantidade da entrega. Sim
CarrierCode Int Informa o código da Não
transportadora no sistema Metrics
Delivery Int Indica se o documento é remessa. Não
0= Não
1= Sim
Billing Int Indica se o documento é fatura. Não
0= Não
1= Sim
DeliveryCustomerCode String(32) Código do cliente da entrega no Não
sistema Metrics
DeliveryCustomerExtref String(32) Código do cliente da entrega no Não
sistema terceiro
Status Int Status da entrega. Não
0 = Em aberto
1 = Encerrado
DeliveryCustomerPurchaseOrder Varchar(15) Número da ordem de compra da Não
programação de entrega do
pedido.
DeliveryCustomerItemPurchaseOrder Varchar(6) Número do item do pedido na Não
programação de entrega do item.

ID Elemento Pai Descrição Obrigatório Observações

SE16 <sdiSORAddress> SE15 Contém os endereços referentes Sim
às entregas
Atributos Tipo Descrição Obrigatório Observações
AddressPrefix String(10) Rua, Avenida, etc. Sim
AddressName String(100) Nome da rua Sim
AddressNumber String(10) Número Sim
AddressComplement String(60) Complemento Não

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

District String(60) Bairro Sim

ZipCode String(20) CEP Sim
CityName String(70) Nome da cidade Sim
StateName String(70) Nome do Estado Sim
CountryName String(70) Nome do País Sim
Referência do endereço no Não
ExtRef String(50)
sistema terceiro, caso exista.
CityCode String(30) Código da cidade Sim
StateCode String(10) Código do Estado Sim

ID Elemento Pai Descrição Obrigatório Observações

SE17 <sdiRecOrignInfo> SE02 Contém os dados do arquivo texto Não
que compõe o XML
Atributos Tipo Descrição Obrigatório Observações
String(200) Contém o nome do arquivo texto Não
RecordId
que originou o XML

ID Elemento Pai Descrição Obrigatório Observações

SE18 <sdiLRecord> SE17 Lista dos Registros Sim
Atributos Tipo Descrição Obrigatório Observações
Lcount Int Total de registros do arquivo Texto Sim

ID Elemento Pai Descrição Obrigatório Observações

SE19 <sdiRecord> SE18 Lista dos Registros Sim
Atributos Tipo Descrição Obrigatório Observações
Data String(400) Linha do arquivo Texto Sim

11.7.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (SOR)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<sdiSORInfo> <sdiSORPayCondInfo> <sdiLPayCondDueDate> <sdiPayCondDueDate>

SE03 SE04 SE05 SE06

<sdiLSORCommissionInfo> <sdiSORCommissionInfo>

SE07 SE08

<metrics> <sdiSORSalesOrder> <sdiSORCustomerInfo>

SE01 SE02 SE09

<sdiLSORItemInfo> <sdiSORItemInfo> <sdiLSORItemTaxInfo> <sdiSORItemTaxInfo>

SE10 SE11 SE12 SE13

<sdiLSORItemDelivery> <sdiSORItemDelivery> <sdiSORAddress>

SE14 SE15 SE16

<sdiRecOrignInfo> <sdiLRecord> <sdiRecord>

SE17 SE18 SE19

11.7.1.3. Importação e Exportação

Na importação e na exportação do SOR são permitidas as operações de INSERT, UPDATE E DELETE.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.8. BIL (Faturas/Remessas)

11.8.1. XMLData – Arquivo de Operação
11.8.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
BE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

BE02 <sdiBilInvoice> BE01 Contém informações sobre a nota Sim
fiscal

ID Elemento Pai Descrição Obrigatório Observações

BE03 <sdiBilInvoiceInfo> BE02 Contém informações sobre a nota Sim
fiscal
Atributos Tipo Descrição Obrigatório Observações
InvoiceReqNumber String(10) Número da requisição da nota Sim
fiscal
InvoiceNumber String(10) Número da nota fiscal Sim
InvoiceCompl String(3) Série da nota fiscal Sim
Status Int Status da nota fiscal Sim
1= Não processado
2= Processado
3= Cancelado
EmissionDt TDateTime Data de emissão da nota fiscal Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

IdCompany Int Código da empresa que está Sim

conectada ao sistema
Extref String(50) Referência externa da nota fiscal. Sim
Ex.: código no sistema terceiro.
UserInfo1 String(50) Campo de usuário 1 Não
UserInfo2 String(50) Campo de usuário 2 Não
UserInfo3 String(50) Campo de usuário 3 Não
UserInfo4 String(50) Campo de usuário 4 Não
UserInfo5 String(50) Campo de usuário 5 Não
InvoiceType Int Tipo de nota fiscal: Sim
0 = Compra
1 = Venda
2 = Devolução de Compra
3 = Devolução de Venda
InvoiceMessage Text Mensagem da nota fiscal Sim
IsBrokerResponsiblePayment Boolean Indica se a agência é responsável Sim
pelo pagamento do titulo.
“0”`= Não “1”=Sim
accesskey String(100) Chave de acesso da NFe. Não

ID Elemento Pai Descrição Obrigatório Observações

BE04 <sdiBilPayConInfo> BE03 Informa as condições de Sim
pagamento
Atributos Tipo Descrição Obrigatório Observações
ConditionCode String(30) Código da condição de pagamento Sim
ExtRef String(30) Informa a referência do sistema Sim
terceiro de onde se originam os
dados.

ID Elemento Pai Descrição Obrigatório Observações

BE05 <sdiLBilPayCondDueDate> BE04 Informa os vencimentos das Sim
condições de pagamento
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LCount Int Informa a quantidade de Sim

vencimentos do bloco

ID Elemento Pai Descrição Obrigatório Observações

BE06 <sdiBilPayCondDueDate> BE05 Informações referentes à condição Sim
de pagamento
Atributos Tipo Descrição Obrigatório Observações
DueDate TDateTime Data de vencimento Sim
Exemplo: 1970-12-
30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
Value Double Valor do vencimento (Monetário) Sim

ID Elemento Pai Descrição Obrigatório Observações

BE07 <sdilAddress> BE03 Informações referentes ao Sim
endereço de faturamento
LCount Int Informa a quantidade de Sim
endereços de faturamento do
bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

BE08 <sdiBilAddress> BE07 Informações referentes ao Sim
endereço de faturamento
Atributos Tipo Descrição Obrigatório Observações
AddressPrefix String(10) Rua, Avenida, etc. Sim
AddressName String(100) Descrição do endereço Sim
AddressNumber String(10) Número do endereço Sim
AddressComplement String(60) Informação complementar do Não
endereço
District String(60) Nome do bairro Sim
ZipCode String(20) Código postal Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

CityName String(70) Nome da Cidade Sim

StateName String(70) Nome do Estado Sim
CountryName String(70) Nome do País Sim
IsBilling Boolean Indica se o endereço é de Sim
faturamento.
“0”`= Não “1”=Sim
IsCharging Boolean Indica se o endereço é de Sim
cobrança.
“0”`= Não “1” = Sim
IsDelivery Boolean Indica se o endereço é de entrega. Sim
“0”`= Não “1” = Sim
ExtRef String(50) Informa a referência do sistema Sim
terceiro de onde se originam os
dados.

ID Elemento Pai Descrição Obrigatório Observações

BE09 <sdiBilCustomerInfo> BE02 Informações sobre o cliente Sim
Atributos Tipo Descrição Obrigatório Observações
Code String(32) Código do cliente Sim
Name String(70) Nome Fantasia Sim
ExtRef String(50) Referência externa do cliente. Ex.: Sim
código do cliente no sistema
terceiro.
ContactName String(75) Nome do contato Sim

ID Elemento Pai Descrição Obrigatório Observações

BE10 <sdiLBilItemInfo> BE02 Informações sobre os itens da Sim
fatura
LCount Int Informa a quantidade de itens da Sim
fatura no bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

BE11 <sdiBilItemInfo> BE10 Informações sobre os itens da Sim

fatura
Atributos Tipo Descrição Obrigatório Observações
ItemID String(20) Código preenchido pelo Metrics. Sim
Padrão=””
Seq Int Ordenação sequencial dos itens: Sim
1, 2, 3, 4, etc.
StockCode String(20) Código do item no Metrics Sim
CustomerStockCode String(30) Código do item no fornecedor Sim
ProductName String(400) Descrição do produto Sim
UnitValue Double Valor unitário do produto Sim
Quantity Double Quantidade total do produto Sim
TotalValue Double Valor total do produto Sim
UnitCode String(10) Unidade do item (UN, KG, etc.) Sim
CFOP String(5) CFOP do item Sim
CustomerPurchaseOrder Varchar(15) Número da ordem de compra dos Não
dados adicionais do item
CustomerItemPurchaseOrder Varchar(6) Número do item na ordem de Não
compra dos dados adicionais do
item

ID Elemento Pai Descrição Obrigatório Observações

BE12 <sdiBilItemReturned> BE11 Informações da nota que está Não Este atributo somente será
sendo devolvida. obrigatório caso o atributo
InvoiceType seja 2 ou 3.
ReturnedInvoiceNumber Int Número da nota fiscal origem Sim
(devolvida)
ReturnedInvoiceCompl String(3) Série da nota fiscal origem Sim
(devolvida)
Seq Int Ordem do item na nota origem Sim
ReturnedTotalQuantity Double Quantidade total Devolvida Sim
UnitCode String(5) Unidade do item Sim
ReturnedTotalValue Double Valor Total Devolvido Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

BE13 <sdiBilLItemReturnedDetail> BE12 Informações do detalhe dos lotes Não Este atributo somente será
devolvidos obrigatório caso o atibuto
InvoiceType seja 2 ou 3.
LCount Int Informa a quantidade de lotes a Sim
serem devolvidos.

ID Elemento Pai Descrição Obrigatório Observações

BE14 <sdiBilItemReturnedDetail> BE13 Informações da nota que está Não Este atributo somente será
sendo devolvida. obrigatório caso o atibuto
InvoiceType seja 2 ou 3.
ReturnedQuantity Double Quantidade devolvida Sim
UnitCode String(5) Unidade do item Sim
Lot String(20) Lote de estoque Sim
StockPlaceCode String(20) Local de Estoque Sim
StockAddress String(20) Localização do estoque Sim

ID Elemento Pai Descrição Obrigatório Observações

BE15 <sdiLBilItemTaxInfo> BE11 Identifica o pedido de venda que Sim
se refere ao item da fatura.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de pedidos Sim
de referência do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

BE16 <sdiBilItemTaxInfo> BE15 Informa o imposto do item. Sim
Atributos Tipo Descrição Obrigatório Observações
Name String(16) Nome da taxa Sim
Value Double Valor do imposto Sim

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

BE17 <sdiLBilItemCommissionInfo> BE11 Informações referentes à comissão Sim

Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de Sim
comissões do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

BE18 <sdiBilItemCommissionInfo> BE17 Informações referentes à comissão Sim
Atributos Tipo Descrição Obrigatório Observações
CostAccountCode String(20) Código da conta de custo Sim
Code String(20) Código do comissionado Sim
(vendedor ou agência)
ExtRef String(30) Campo para informar a referência Sim
do sistema terceiro onde se
originam os dados.
Name String(60) Nome do comissionado Sim
CommissionType Int Tipo de comissão: Sim
“1” = Vendedor
“2” = Agência
ValueType Int Tipo de valor de comissão: Sim
“1” = Percentual
“2” = Valor monetário
Value Double Valor da comissão (percentual ou Sim
monetário)

ID Elemento Pai Descrição Obrigatório Observações

BE19 <sdiLBilItemSorItemRef> BE11 Identifica o pedido de venda que Sim
se refere ao item da fatura.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de Pedidos Sim
de referência do bloco.
Ex.: LCount=”8”

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

BE20 <sdiBilItemSorItemRef> BE19 Identifica o pedido de venda que Sim
se refere ao item da fatura.
ID Atributos Tipo Descrição Obrigatório Observações
ItemID String(20) Código preenchido pelo Metrics. Sim
Padrão=””
Quantity Double Quantidade do pedido de venda. Sim
TotalValue Double Valor total do pedido de venda. Sim
WONumber String(12) Número da ordem de produção. Não
QuoteNumber String(12) Número do orçamento. Não
Billing Boolean Indica se o documento é fatura. Sim
“0”= Não
“1”= Sim
Delivery Boolean Indica se o documento é remessa. Sim
“0”= Não
“1”= Sim
SalesOrderNumber String(13) Número do pedido de venda Não
(SOR)
SalesOrderExtRef String(50) Número do código externo do Não
pedido de venda.
StockCode String(20) Código do item de estoque. Sim
ItemObs Varchar(200 Observação do item no pedido de Não
0) venda.
CustomerPurchaseOrder Varchar(15) Número do pedido de compra dos Não
dados adicionais do item.
CustomerItemPurchaseOrder Varchar(6) Número do item no pedido dos Não
dados adicionais do item.

ID Elemento Pai Descrição Obrigatório Observações

BE21 <sdiLBilItemSorItemStockLocal> BE20 Informações referentes aos Sim
movimentos de estoque por local
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LCount Int Informa a quantidade de Sim

movimentos de estoque do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

BE22 <sdiBilItemSorItemStockLocal> BE21 Identifica os locais de estoque que Sim
sofreram movimentação
Atributos Tipo Descrição Obrigatório Observações
Local String(20) Identificador do local de estoque Sim
Quantity Double Quantidade movimentada. Sim
Location String(20) Localização do item no local de Sim
estoque.
Caso deixe em branco, será
considerado “ÚNICO”.
Lot String(20) Número do lote de produção. Sim
Caso deixe em branco, será
considerado “ÚNICO”.

ID Elemento Pai Descrição Obrigatório Observações

BE23 <sdiBilBrokerInfo> BE20 Informações referentes à agência Sim
do pedido de venda
Atributos Tipo Descrição Obrigatório Observações
Code String(32) Código da agência Sim
Name String(70) Nome Fantasia Sim
ExtRef String(50) Referência externa da agência. Sim
Ex.: código da agência no sistema
terceiro.

11.8.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (BIL)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<sdiBilPayCondInfo> <sdiLBilPayCondDueDate> <sdiBilPayCondDueDate>

BE04 BE05 BE06

<sdiBilInvoiceInfo>

BE03
<sdiLBilAddress> <sdiBilAddress>
BE07 BE08

<sdiLBilItemTaxInfo <sdiBilItemTaxInfo>

BE12 BE13
<metrics> <sdiBilInvoice> <sdiBilCustomerInfo>
BE09
BE01 BE02

<sdiLBilItemCommissionInfo> <sdiBilItemCommissionInfo>

BE14 BE15

<sdiLBilItemInfo> <sdiBilItemInfo>

BE10 BE11
<sdiLBilItemSorItemRef> <sdiBilItemSorItemRef> <sdiBilBrokerInfo>

BE16 BE17 BE20

<sdiLBilItemSorItemStockLocal> <sdiBilItemSorItemStockLocal>

BE18 BE19

11.8.1.3. Importação e Exportação

Na importação e na exportação do BIL são permitidas as operações de INSERT, UPDATE, DELETE, CANCEL e PROCESS.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.9. STKItem (Itens de Estoque)

Arquivo que informa ao sistema os dados referentes aos itens de estoque como matérias-primas, produtos acabados e semi acabados, a serem
importados/exportados.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.9.1. XMLData – Arquivo de Operação

11.9.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
STE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

STE02 <sdiStkItem> STE01 Item de estoque Sim
Atributos Tipo Descrição Obrigatório Observações
idItem Int Informa a chave primária do item Não
de estoque. Utilizado apenas nas
exportações.
StockCode String(20) Código do item de estoque Sim
Status Boolean Indica se o item está ou não ativo. Sim
“0”= Não
“1”= Sim
MaterialType Int Informa o tipo de material. Sim
1 – tinta
2 – chapa
3 – outros
4 – papel em folha
5 – papel em bobina
6 – Personalizado
ItemType Int Tipo de item de estoque. Sim
0 – matéria-prima
1 – produto acabado
2 – produto intermediário
3 – serviço
4 – consumíveis
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

MaterialName String(60) Nome do material Sim

UnitCode String(8) Código da unidade do item de Sim
estoque. Exemplo: KG.
UnitCodeDemand String(8) Código da unidade de consumo do Sim
item. Exemplo: FL.
UnitCodeCost String(8) Código da unidade de custo do Sim
item. Exemplo: KG.
Height Double Altura Não Este atributo somente será
obrigatório caso o atibuto
MaterialType seja 4.
Width Double Largura Não Este atributo somente será
obrigatório caso o atibuto
MaterialType seja 4.
Grammage Int Gramatura Não Este atributo somente será
obrigatório caso o atibuto
MaterialType seja 4.
CustomMaterialTypeCode String(4) Código do tipo de material. Não Este atributo somente será
obrigatório caso o atibuto
MaterialType seja 6.
CustomMaterialTypeDescription String(60) Descrição do tipo de material. Não Este atributo somente será
obrigatório caso o atibuto
MaterialType seja 6.
MaterialGroupCode String(20) Código do grupo de materiais. Sim
MaterialGroupDescription String(50) Descrição do grupo de materiais. Sim
MasterMaterialGroupCode String(20) Código do grupo de materiais Sim
master.
MasterMaterialGroupDescription String(40) Descrição do grupo de materiais Sim
master.
UsesCtrlVolume Boolean Indica se o parâmetro “Utiliza Não
controle de volumes” do cadastro
do item de estoque está ou não
selecionado.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

NCM Varchar(20) Informa a classificação fiscal do Não

item de estoque
ISBN Varchar(40) Informa o número ISBN do item de Não
estoque
WeightKg Double Informa o peso do item de Não
estoque, para importação e
exportação.
UnitWeight Double Descontinuado, não utilizar. Não
EAN Varchar(20) Informa o código EAN do item de Não
estoque
OriginItem Int Informa a origem do item de Não
estoque
IsFSC Boolean Indica se o item é FSC Não
“0”= Não
“1”= Sim
Obs Varchar(255 Observações do item de estoque Não
)
UseLot Boolean Indica se o item de estoque requer Não
lote
“0”= Não
“1”= Sim
UseAddress Boolean Indica se o item de estoque requer Não
localização
“0”= Não
“1”= Sim
IsInventoried Boolean Indica se o item de estoque é Não
inventariado
“0”= Não
“1”= Sim
ControlTraceability Boolean Indica se o item de estoque é Não
controlado por rastreabilidade
TipoItemSped Indica à qual tipo de classificação Não
SPED o item pertence

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

00 - Mercadoria para revenda

01 - Matéria-prima
02 - Embalagem
03 - Produto em processo
04 - Produto acabado
05 - Subproduto
06 - Produto Intermediário
07 - Material de uso e consumo
08 - Ativo imobilizado
09 - Serviços
10 - Outros insumos
99 - Outras
userfield1 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield2 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield3 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield4 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield5 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield6 String(50) Informa o campo de usuário Não
definido no relacionamento
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Metrics. O nome userfield deve

estar em letras minúsculas.
userfield7 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
userfield8 String(50) Informa o campo de usuário Não
definido no relacionamento
Metrics. O nome userfield deve
estar em letras minúsculas.
IsSupplied Boolean Informa se o material é ou não Não
fornecido.
FinancialNatureCode String(20) Representa o código Metrics da Não
Natureza Financeira.
BusinessUnitCode String(10) Representa o código Metrics da Não
Unidade de Negócios
PackagingQty Double Quantidade por embalagem do Não
item de estoque.
PackagingUnit String(4) Unidade de medida de embalagem Não
do item de estoque.
BillingDescription String(400) Descrição do item a ser exibida na Não
nota fiscal de faturamento. Caso
seja preenchida, a opção Venda
do cadastro do item será
automaticamente habilitada.
ProductClassification String(32) Classificação do produto, Não
proveniente do campo Referência
Externa do cadastro de
Classificação de Produto
NeedSeparation Boolean Define se o item requer separação Não
de material:
“0”= Não
“1”= Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

DifferentLotsSeparation Boolean Define se serão permitidos, na Não

mesma separação de material,
itens de lotes diferentes:
“0”= Não
“1”= Sim
InvoiceItemType Int Tipo de item para faturamento - Não
Fatura, que pode ser:
 0 – Padrão
 1 – Produto
 2 – Serviço
ShippingItemType Int Tipo de item para faturamento – Não
Remessa, que pode ser:
 0 – Padrão
 1 – Produto
 2 – Serviço
InvoiceShippingItemType Int Tipo de item para faturamento – Não
Fatura e Remessa, que pode ser:
 0 – Padrão
 1 – Produto
 2 – Serviço
DaysForItemDeactivation Int Define a quantidade de dias sem Não
movimento tolerados antes de
inativar o item.
UsedinEstimate Boolean Indica se o item de estoque Não
poderá ser utilizado no orçamento:
“0”= Não
“1”= Sim

ID Elemento Pai Descrição Obrigatório Observações

STE03 <sdistkitemvolumeinfo> - Agrupa as informações de Não
volumes do item de estoque
Volumeminweightun String(4) Unidade de medida do peso Não
mínimo da bobina
Volumeminweight Double Peso mínimo da bobina Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Volumemaxweightun String(4) Unidade de medida do peso Não

máximo da bobina
Volumemaxweight Double Peso máximo da bobina Não
Standarddiameterun String(4) Unidade de medida do diâmetro Não
padrão da bobina
Standarddiameter Double Diâmetro padrão da bobina Não
Labeldescription String(100) Descrição da etiqueta da bobina Não

11.9.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STKItem)
<Metrics> <sdiStkItem>
STE01 STE02

11.9.1.3. Importação e Exportação

Na importação e na exportação do STKItem são permitidas as operações de INSERT, UPDATE E DELETE.
Na operação INSERT, se já existir o StockCode, será acionada a operação UPDATE.
Na operação UPDATE, se não houver o StockCode, será acionada a operação INSERT.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.10. STK (Movimentações de Estoque)

Arquivo que informa ao sistema os dados referentes às movimentações de estoque a serem importados/exportados.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.10.1. XMLData – Arquivo de Operação

11.10.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
STE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

STE02 <sdiStkTransactionGroup> STE01 Grupo de transações Sim

ID Elemento Pai Descrição Obrigatório Observações

STE03 <sdiLStkTransaction> STE02 Lista de transações de estoque Sim
Atributos Tipo Descrição Obrigatório
LCount Int Informa a quantidade de Sim
movimentos de estoque do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

STE04 <sdiStkTransaction> STE01 Contém as movimentações a Sim
serem efetuadas no estoque
Atributos Tipo Descrição Obrigatório Observações
TransactionType Int Tipo de transação, que pode ser: Sim No caso da TransactionType 0,
0 = Atendimento ou devolução de o atributo OperationType
Requisição de matéria-prima identificará se trata-se de um
1 = Entrega de produção atendimento (saída) ou
2 = Compras devolução (entrada) de
3 = Vendas requisição.
4 = Inventário
5 = Transferência entre itens de
estoque
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

6 = Volumes
7 = Transferência entre empresas
8 = Transferência
9 = Ajuste de saldo
10 = Outro
11 = Recálculo do custo médio
Lot String(40) Lote de armazenamento Sim
DocNumber String(20) Número do documento de Sim
movimentação de estoque
DocNumberCompl String(20) Complemento do documento de Não
movimentação de estoque
StockAddress String(20) Localização de estoque Sim
StockMovementType Int Tipo de movimentação de estoque, Sim
que pode ser:
0 = Físico
1 = Financeiro
2 = Físico/Financeiro
OperationType Int Tipo de operação Sim
0 = Entrada de estoque
1 = Saída de estoque
TransactionDt TDateTime Data da transação Sim Ao cancelar uma operação,
Ex.: 1970-12-30T00:00:00.000 envie, neste campo, a data da
Sintaxe: AAAA-MM- transação original (data do
DDTHH:MM:SS.MMM INSERT da transação) e a
operação CANCEL no XML
Operation.
StockCode String(16) Código do item de estoque Sim
UnitCode String(10) Código da unidade do item: UN, Sim
KG, MT etc.
Quantity Double Quantidade do item Sim
TotalValue Double Valor monetário total da transação Sim
WONumber String(20) Número da OP de origem Sim
StockPlaceCode String(20) Local de estoque Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

IdCompany Int Código da Empresa Sim

CostCenterCode String(20) Código do Centro de Custos Não
CostCenterName String(30) Nome do Centro de Custos Não
TransactionCode String(15) Código de identificação da Não
transação no Metrics.

UnitCostCode String(10) Código da unidade de custo do Não

item, que pode ser: UN, KG, MT,
etc.

QuantityUnitCost Double Quantidade do item na unidade de Não

custo

TransactionCodeExtRef
RelatedTransactionCodeExtRef
Double Código único de identificação da
transação no sistema de origem.
Double Código único de identificação da
transação relacionada, quando
houver, no sistema de origem.
Não Este código deve ser único,
não pode conter repetições em
movimentos diferentes. Em
caso de cancelamento de uma
operação, deverá ser enviado
neste campo o código da
transação original e a operação
CANCEL no XML Operation.
Não Necessário para a correta
valorização de transferências e
devoluções de requisição. Nas
transações de entrada de
transferência, identifica a
respectiva transação de saída.
Nas transações de devolução
de requisição, identifica a
respectiva transação de
atendimento de requisição
(que está sendo devolvida).

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

TransactionOriginExtRef Double Código de identificação do registro Não Depende do tipo de transação.

de origem da transação, quando No caso das transações de
houver, no sistema Metrics. atendimento de requisição,
deve obrigatoriamente
identificar o item da requisição.
No caso de devoluções de
requisição, deve também
obrigatoriamente identificar o
item da requisição, quando não
for informada a tag
RelatedTransactionCodeExtR
ef.

ExpirationDate TDateTime Data de validade do lote Não Este atributo somente será
obrigatório se o item de
estoque for controlado por
rastreabilidade.
ProductionDate TDateTime Data de produção do lote Não Este atributo somente será
obrigatório se o item de
estoque for controlado por
rastreabilidade.
ProviderLot String(40) Lote do fornecedor Não Este atributo somente será
obrigatório se o item de
estoque for controlado por
rastreabilidade.
UnitLot String(10) Unidade do lote Não Este atributo somente será
obrigatório se o item de
estoque for controlado por
rastreabilidade.
GrossWeight Double Peso total da transação, baseado Não Este atributo é somente
na quantidade movimentada, utilizado na exportação do
multiplicada pelo peso em kg do XML.
cadastro de itens de estoque.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LogUser String(20) Código do usuário no sistema Não Este atributo é somente

Metrics. utilizado na exportação do
XML.
UserField1 String(50) Informações adicionais da Não
movimentação de estoque.

UserField2 String(50) Informações adicionais da Não

movimentação de estoque.

UserField3 String(50) Informações adicionais da Não

movimentação de estoque.

UserField4 String(50) Informações adicionais da Não

movimentação de estoque.

UserField5 String(50) Informações adicionais da Não

movimentação de estoque.

11.10.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK)

<metrics> <sdiStkTransactionGroup> <sdiLStkTransaction> <sdiStkTransaction>

STE01 STE02 STE03 STE04

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.10.1.3. Importação e Exportação

Na importação e na exportação do STK são permitidas as operações de INSERT e CANCEL.
Na operação INSERT da importação, é possível gerar lotes de Produto Adquirido e de Produção Interna. Os lotes de estoque do tipo Produção
Interna serão criados quando o item informado na tag StockCode estiver configurado para Controlar Rastreabilidade e a tag TransactionType for =
1 (Entrega de produção).
Neste caso, a tag WONumber será obrigatória e, quando não informada, será exibida a mensagem: "Necessário informar o número da OP.
<WONumber>."
Quando informada:
- Se a OP informada na tag WONumber não existir, exibirá a mensagem: Ordem de produção "%s" não está cadastrada.
- Se o item de estoque não existir na OP, exibirá a mensagem: Item de estoque: %s não encontrado na OP: %s.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.11. REQ (Requisições de Materiais)

Arquivo que informa ao sistema os dados referentes às requisições de materiais a serem importadas/exportadas.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.11.1. XMLData – Arquivo de Operação

11.11.1.1. Explicação dos elementos e atributos

ID Elemento Pai Descrição Obrigatório Observações
REQ01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

REQ02 <sdiReqRequisition> REQ01 Contém as requisições de Sim
materiais
Atributos Tipo Descrição Obrigatório Observações
IdReq Int Número da requisição no sistema Não Caso não seja informado, será
Metrics Printware gerado internamente.
IdCompany Int Código da empresa no sistema Sim
Metrics Printware
RequesterName String(32) Nome do requisitante Sim
EmissionDt DateTime Data de criação da requisição Sim
ApprovalName String(32) Nome do usuário que aprovou a Não
requisição
ApprovalDt DateTime Data de aprovação da requisição Não
TransactionCode String(20) Código da transação da requisição Sim
WONumber String(20) Número da ordem de produção Não
relacionada à requisição
UserField1 String(50) Informações adicionais da Não
requisição de material
UserField2 String(50) Informações adicionais da Não
requisição de material

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

UserField3 String(50) Informações adicionais da Não

requisição de material
UserField4 String(50) Informações adicionais da Não
requisição de material
UserField5 String(50) Informações adicionais da Não
requisição de material
ID Elemento Pai Descrição Obrigatório Observações
REQ03 <sdiLReqRequisitionItem> REQ02 Contém a lista de itens da Sim
requisição de materiais
Atributos Tipo Descrição Obrigatório Observações
LCount Int Quantidade de itens da requisição Sim
de materiais
ID Elemento Pai Descrição Obrigatório Observações
REQ04 <sdiReqRequisitionItem> REQ03 Contém o item da requisição Sim
Atributos Tipo Descrição Obrigatório Observações
IdReqItem Double Código interno do item da Não Caso não seja informado, será
requisição gerado internamente.
StockCode String(20) Código do item de estoque da Sim
requisição
Quantity Double Quantidade do item na requisição Sim
UnitCode String(8) Código da unidade de estoque do Sim Caso a unidade de medida do
item item de estoque seja diferente
da unidade do item da
requisição, deve existir, para
cada item da requisição, a
respectiva unidade de
conversão.
QuantityUnitCost Double Quantidade do item na sua Sim
unidade de custo
UnitCostCode String(8) Código da unidade de custo do Sim
item
CostCenterCode String(20) Código do centro de custo do item Não
da requisição

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Status Int Situação do item da requisição, Sim

que pode ser:
0 – Aberto
1 – Encerrado
Note String(100) Observações adicionais do item da Não
requisição

11.11.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (REQ)

<metrics> <sdiReqRequisition> <sdiLReqRequisitionItem> <sdiReqRequisitionItem>

REQ01 REQ02 REQ03 REQ04

11.11.1.3. Importação e Exportação

Na importação e exportação do REQ são permitidas as operações de INSERT, UPDATE e DELETE. Na importação, a requisição importada não é
uma requisição de OP, pode ser uma requisição de matéria-prima, mas não está diretamente associada à OP.
Ao importar a operação DELETE, caso algum item da requisição tenha sido atendido, a importação não será efetuada.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.12. WO (Ordens de Produção)

Arquivo que contém as informações das ordens de produção que serão importadas/exportadas.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.12.1. XMLData – Arquivo de Operação

11.12.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
WE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

WE02 <sdiWOWorkOrder> WE01 Informações sobre a ordem de Sim
produção

ID Elemento Pai Descrição Obrigatório Observações

WE03 <sdiWOWorkOrderInfo> WE02 Informações sobre a ordem de Sim
produção
Atributos Tipo Descrição Obrigatório Observações
IdCompany SmallInt Código da empresa, conforme Sim
cadastro no Metrics
WONumber String(20) Número da OP Sim
QuoteNumber String(20) Número do orçamento Sim
Status Int Status da OP Sim
“0”= OP aberta
“1”= OP finalizada
“2”= OP cancelada
“3”= OP bloqueada
“4”= OP avaliação de carga
InsertDt TDateTime Data de criação da OP Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
WODescription String(200) Descrição da OP Sim
ProjectCode String(20) Código do projeto Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

ProjectTitle String(100) Título do projeto Não

Userinfo1 String(50) Campo de usuário 1 Não
Userinfo2 String(50) Campo de usuário 2 Não
Userinfo3 String(50) Campo de usuário 3 Não
Userinfo4 String(50) Campo de usuário 4 Não
Userinfo5 String(50) Campo de usuário 5 Não

ID Elemento Pai Descrição Obrigatório Observações

WE04 <sdiWOCustomerInfo> WE02 Informações sobre o cliente da Sim
ordem de produção
Atributos Tipo Descrição Obrigatório Observações
Code String(32) Código do cliente Sim
ExtRef String(50) Referência externa do cliente. Não
Ex.: código do cliente no sistema
de origem
Name String(100) Nome Fantasia do cliente Sim

ID Elemento Pai Descrição Obrigatório Observações

WE05 <sdiLWOFinishedItem> WE02 Informações sobre o produto Sim
acabado da ordem de produção
LCount Int Informa o número de itens que Sim
serão carregados.
Ex.: LCount=”10”.

ID Elemento Pai Descrição Obrigatório Observações

WE6 <sdiWOFinishedItem> WE05 Informações sobre o produto Sim
acabado da ordem de produção
Atributos Tipo Descrição Obrigatório Observações
StockCode String(16) Código do item no estoque Sim
ProductName String(70) Descrição do produto acabado Sim
UnitCode String(10) Unidade de medida do produto Sim
acabado
Padrão: “UN”
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Quantity Double Quantidade do produto acabado Sim

DeliveryDt TDateTime Data de entrega do produto Sim
acabado
IsFSC Boolean Informa se o item é FSC. Não
“0”=não “1”=sim

ID Elemento Pai Descrição Obrigatório Observações

WE07 <sdiLWORawMaterial> WE02 Informações sobre os materiais Sim
utilizados na ordem de produção.
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de materiais Sim
do bloco.
Ex.: LCount=”10”.

ID Elemento Pai Descrição Obrigatório Observações

WE08 <sdiWORawMaterial> WE07 Informações sobre os materiais Sim
utilizados na ordem de produção.
Atributos Tipo Descrição Obrigatório Observações
MaterialType Int Tipo de material Sim
0= Papel
1= Tinta
2= Chapa
3= Outro
StockCode String(16) Código do material no estoque Sim
MaterialName String(70) Descrição do material Sim
UnitCode String(10) Unidade do material Sim
Ex.: UN, KG, MT etc.
Quantity Double Quantidade do material Sim
ProcessGroupCode String(15) Código do elemento Sim

ID Elemento Pai Descrição Obrigatório Observações

WE09 <sdiLWOOperation> WE02 Informações sobre o trabalho Sim
realizado na ordem de produção.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

LCount Int Informa a quantidade de trabalhos Sim
do bloco.
Ex.: LCount=”10”.

ID Elemento Pai Descrição Obrigatório Observações

WE10 <sdiWOOperation> WE09 Informações sobre o trabalho Sim
realizado na ordem de produção.
Atributos Tipo Descrição Obrigatório Observações
ResourceCode String(15) Código do recurso (máquina) Sim
ResourceName String(30) Nome do recurso (máquina) Sim
TotalTime Double Tempo total de trabalho apontado Sim
para o recurso
ProcessGroupCode String(50) Código do elemento Sim
ActivityCode String(50) Código da atividade Sim
AllocGrpCode String(50) Código do grupo de alocação Sim
Quantity Double Quantidade a ser produzida na Sim
atividade
SetupTime Int Tempo de setup Sim
ProductionTime Double Tempo de produção Sim
Sequence SmallInt Número de sequência da atividade Sim
IdAtiv Int Id da atividade Sim
ProcessGroupSeq Varchar(12) Sequência da atividade no Não
processo

ID Elemento Pai Descrição Obrigatório Observações

WE11 <sdiLWOOutsourcing> WE02 Lista de serviços terceirizados Não
WE12 <sdiWOOutsourcing> WE05 Itens da lista de serviços Não
terceirizados
Atributos Tipo Descrição Obrigatório Observações
Code String(50) Código do serviço Não
Title String(50) Descrição do serviço Não
Quantity Double Quantidade do serviço Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

UnitCode String(8) Código da unidade de medida do Não

serviço
TotalValue Double Valor total do serviço Não
CostAccountCode String(16) Código da conta de custo de Não
terceiros
CostAccountDescription String(40) Descrição da conta de custos de Não
terceiros

Currency String(15) Moeda da atividade de terceiros Não

do orçamento

ID Elemento Pai Descrição Obrigatório Observações

WE13 <sdiLWOComponent> WE02 Informações sobre os Sim
componentes utilizados na ordem
de produção
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de Sim
componentes.
Ex.: LCount=”10”.

ID Elemento Pai Descrição Obrigatório Observações

WE14 <sdiWOComponent> WE13 Informações sobre os Sim
componentes utilizados na ordem
de produção
Atributos Tipo Descrição Obrigatório Observações
Name Varchar(14) Nome do componente Sim
Quantity Float Quantidade do componente Sim
StockCode Varchar(20) Código de estoque do componente Não

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

WE15 <sdiLWOInputComponent> WE14 Informações sobre os componentes Não
geradores do componente
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de Sim
componentes geradores.
Ex.: LCount=”10”.

ID Elemento Pai Descrição Obrigatório Observações

WE16 <sdiWOInputComponent> WE15 Informações sobre os componentes Não
geradores do componente
Atributos Tipo Descrição Obrigatório Observações
<InputComponentName> Varchar(14) Nome do componente Não
<InputComponentQuantity> Float Quantidade do componente Não

11.12.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (WO)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<sdiWOWorkOrderInfo>

WE03

<sdiWOCustomerInfo>

WE04

<metrics> <sdiWOWorkOrder> <sdiLWOFinishedItem> <sdiWOFinishedItem>

WE01 WE02 WE05 WE06

<sdiLWORawMaterial> <sdiWORawMaterial>

WE07 WE08

<sdiLWOOutsourcing> <sdiWOOutsourcing>

WE11 WE12

<sdiLWOOperation> <sdiWOOperation>

WE09 WE10

<sdiLWOComponent> <sdiWOComponent> <sdiLWOInputComponent> <sdiWOInputComponent>

WE13 WE14 WE15 WE16

11.12.1.3. Importação
Este contexto não suporta operações de importação.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.12.1.4. Exportação
Na exportação do WO são permitidas as operações de INSERT, UPDATE E DELETE.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.13. INT-OP (Integração de Ordens de Produção)

Arquivo que contém as informações das ordens de produção que serão importadas. Permite importar para o Jobtrack as mesmas informações das
ordens de produção importadas para o M3 Planner.

11.13.1. XMLData – Arquivo de Operação

11.13.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
WO01 <WOMainNode> - Inicia e finaliza o arquivo XML Sim
WO02 <CustomerInfo> WO01 Grupo para identificação do Não
cliente.
Atributos Tipo Descrição Obrigatório Observações
<CustomerName> String(70) Nome do cliente Não
<CustomerId> String(50) Código do cliente, conforme Não Proveniente da tabela
cadastrado no M3 Planner crmTCActor, coluna ExtRef.

ID Elemento Pai Descrição Obrigatório Observações

WO03 <ChangeStatus> WO01 Determina a alteração de status Sim Este elemento é utilizado
da OP apenas nas operações
UPDATESTATUS
<LogUser> String(32) Login do usuário que efetuou a Sim
operação
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

<WOStatusID> String(50) Código do status a ser assumido Sim

pela OP
<WSCode> String(32) Código da OP a ser alterada Sim

ID Elemento Pai Descrição Obrigatório Observações

WO04 <WorkOrderInfo> WO01 Identificação do grupo. Sim
Atributos Tipo Descrição Obrigatório Observações
<PlantId> String(50) Código de identificação da planta Sim Proveniente da tabela
plnTCPlant, coluna ExtRef.
<Code> String(32) Número da ordem de produção. Sim
<WorkOrderId> String(50) Código ou número de identificação Sim
da ordem de produção.
<CompanyId> String(30) Código da empresa. Sim

ID Elemento Pai Descrição Obrigatório Observações

WO05 <WorkOrderVersionInfo> WO01 Grupo para identificação da Sim
estrutura da ordem de produção.
Atributos Tipo Descrição Obrigatório Observações
<DtRefACR> TDateTime Data de referência para análise da Sim
ordem de produção no pós-
cálculo.
<DtMinStart> TDateTime Data mínima de início da Sim
produção, no formato dd/mm/yyyy
hh:mm.
<Priority> Int Prioridade da ordem de produção. Sim
<JobColor> Int Cor da orden de produção no Sim Esta tag utiliza a codificação
Gantt. de cor Tcolor, ou seja, um
número hexadecimal de 4
bytes. Os primeiros 3 bytes
representam a intensidade de
cor para azul, verde e
vermelho, respectivamente
(padrão RGB).
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

<WOStatusId> String(50) Identificação do status da ordem Sim Proveniente da tabela

de produção. Esta informação plnTCWOStatus, coluna
depende dos status da ordem de ExtRef.
produção no orçamento. Os status
utilizados para a geração do XML
de integração não são fixos. Estes
status podem ser cadastrados no
Metrics Planner de acordo com o
sistema de orçamento a ser
integrado. O valor a ser informado
nesse campo será o campo de
ligação (ExtRef) entre o Metrics
Planner e o sistema de orçamento;
Exemplos: ‘L’ – Liberado, ‘B’ –
Bloqueado, ‘C’ – Cancelado.
UserFields De acordo Grupo que permite a inclusão de Não As tags a seguir foram criadas
com o tipo campos de usuários no XML. a partir dos campos de
de dados usuário da tabela
Exemplo:
plnTMWO_U. Não é
<WorkOrderVersionInfo necessário incluí-las na
DtMinStart="13/10/2008 10:00" geração do XML.
Priority="100"  EstimateNumber (String,
JobColor="12177407" xxx) - número do
WOStatusId="L"> orçamento;
 WOType (String, xxx) -
<UserFields tipo da ordem de
estimatenumber="06524P" produção;
wotype="NOVO"  SalesmanName (String,
salesmanname="José" xxx) - nome do vendedor;
producttype="MERC INT  ProductType (String, xxx)
TRIBUTADO PROGR/OUTROS"/> - tipo do produto.
</WorkOrderVersionInfo>

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

WO06 <WorkOrderGroupInfo> WO01 Informações da versão da Sim

estrutura do produto no ambiente
de planejamento.
Atributos Tipo Descrição Obrigatório Observações
<ProductScenarioId> Int Cenário onde está a ordem de Sim
produção. O padrão é 1 (cenário
real).
<GroupId> String(50) Identificação da versão da ordem Sim
de produção.

ID Elemento Pai Descrição Obrigatório Observações

WO07 <Deliveries> WO01 Informações das entregas da Sim
ordem de produção.

ID Elemento Pai Descrição Obrigatório Observações

WO08 <Delivery> WO07 Informações da entrega. Sim
Atributos Tipo Descrição Obrigatório Observações
<DueDate> TdateTime Data da entrega, no formato Sim
dd/mm/yyyy.
<DeliveryId> String(10) Código de identificação da Sim
entrega.

ID Elemento Pai Descrição Obrigatório Observações

WO09 <DeliveryComponents> WO08 Lista de componentes que serão Sim
entregues na data DueDate.
Atributos Tipo Descrição Obrigatório Observações
<Quantity> Double Quantidade a entregar do produto. Sim
<ComponentId> String(50) Identificação do produto a entregar Sim

ID Elemento Pai Descrição Obrigatório Observações

WO10 <ProductInfo> WO01 Informações sobre a estrutura do Sim
produto.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

WO11 <Components> WO10 Informações sobre componentes. Sim
Atributos Tipo Descrição Obrigatório Observações
<Description> String(200) Descrição do componente. Sim
<ComponentId> String(50) Identificação do componente que Sim
será produzido ou consumido.
Deve ser uma identificação única
dentro da ordem de produção.
<UnitId> String(50) Unidade de medida do Sim Proveniente da tabela
componente. basTCUnit, coluna ExtRef.
<StockItemId> String(30) Código do item de estoque do Sim
sistema MetricsPrintware.

ID Elemento Pai Descrição Obrigatório Observações

WO12 <ProcessGroups> WO10 Identificação dos grupos de Sim
processos (elementos).

ID Elemento Pai Descrição Obrigatório Observações

WO13 <UserFields> WO12 Campos adicionais para o grupo Não
de processos.
Atributos Tipo Descrição Obrigatório Observações
<IdProcessGroup> Int Id interno do processo Metrics. Não
Enviar 0.
<PaperCode> String(200) Código do item de estoque do Não
papel utilizado no processo.
<PaperName> String(200) Nome do papel utilizado no Não
processo.
<PaperFormat> String(30) Formato do papel. Não
<PaperGramme> Double Gramatura do papel. Não
<UnPaperGramme> SmallInt(2) Unidade da gramatura do papel. Não
<ServiceFormat> String(30) Formato do trabalho. Não
<PrintWidth> Double Largura da impressão. Não
<PrintHeight> Double Altura da impressão. Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

<UnPrintFormat> SmallInt(2) Unidade do formato de impressão. Não

<FinishWidth> Double Largura final da impressão. Não
<FinishHeight> Double Altura final da impressão. Não
<UnFinishFormat> SmallInt(2) Unidade final do formato de Não
impressão.
<StructureDescription> String(100) Descrição da estrutura do produto. Não
<PrintColor> String(10) Quantidade de cores do trabalho Não
frente e verso. Ex.: 4x1.
<PaperThickness> Double Espessura do papel. Não
<IsSuppliedPaper> String(1) Indica se o papel é fornecido Não
(S/N).

ID Elemento Pai Descrição Obrigatório Observações

WO14 <ProcessGroup> WO12 Identificação do grupo de Sim
processos.
Atributos Tipo Descrição Obrigatório Observações
<GroupLevel> Int Nível do grupo de processos na Sim
árvore produtiva, utilizado para
organização visual das atividades
de uma ordem de produção.
Exemplo: 0 - Produto Final, 1 -
Acabamento, 2 - Impressão, 3 -
Pré-Imp, etc.
<Description> String(200) Descrição do processo. Sim
Exemplo: Caderno 1.
<WaitTimeNextProcess> Int Tempo de espera mínimo para Sim
início do próximo processo.
<WaitNextProcessQtd> Double Quantidade mínima para início do Sim
próximo processo.

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

WO15 <InputComponents> WO14 Indica quais componentes de Sim

entrada o grupo de processos
consome. Deve conter todos os
componentes produzidos
consumidos pelo ProcessGroup.
Atributos Tipo Descrição Obrigatório Observações
<ComponentId> String(50) Identificação do componente. Sim Este componente deve estar
descrito na tag
<Components>.
<Quantity> Double Quantidade do componente. Sim

ID Elemento Pai Descrição Obrigatório Observações

WO16 <OutputComponents> WO14 Indica quais componentes de Sim
saída o grupo de processos
produz. Deve conter todos os
componentes produzidos por este
ProcessGroup.
Atributos Tipo Descrição Obrigatório Observações
<ComponentId> String(50) Identificação do componente. Sim Este componente deve estar
descrito na tag
<Components>.
<Quantity> Double Quantidade do componente. Sim
<WaitTimeNextProcess> Int Tempo de espera mínimo para Sim
início do próximo processo.
<WaitNextProcessQtd> Double Quantidade mínima para início do Sim
próximo processo.

ID Elemento Pai Descrição Obrigatório Observações

WO17 <ProcessList> WO14 Lista de processos (atividades) do Sim
grupo de processos.

ID Elemento Pai Descrição Obrigatório Observações

WO18 <Process> WO17 Definição do processo da lista Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

<CostPercentualAcc> double Custo percentual do acerto Sim
<PlanActivity> Int ID do Plano de Atividade Sim
<DeliveryId> String(32) ID da Entrega Sim
<SetupTime2> int Tempo do ajuste, em segundos Sim
<WorkStyle> String(50) Nome do modelo de processo Sim
<WaitNextProcessQtd> int Quantidade acumulada necessária Sim
para o próximo processo
<WaitTimeNextProcess> int Tempo acumulado para o próximo Sim
processo
<OutputComponentQuantity> int Quantidade de saída dos Sim
componentes
<SplitsQuantity> int Quantidade de divisões do Sim
trabalho
<ResToRunSpeedQtd> int Quantidade de Tempo Restante Sim
para o início do processo
<RunQuantity> int Quantidade do processo a ser Sim
executada
<RunSpeed> int Velocidade do processo, em Sim
segundos
<SetupTime> int Tempo de Ajuste, em segundos Sim
<Description> String(50) Descrição do processo Sim
<ActivityId> int ID da Atividade Sim
<ProcessId> int ID do processo Sim
<Sequence> int Sequência de execução na lista de Sim
processos

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

WO19 <ResourceDefinition> WO18 Definição do grupo de alocação do Sim

processo.
Atributos Tipo Descrição Obrigatório Observações
<AllocationGroupId> String(50) Identificação do grupo de Sim Proveniente da tabela
alocação. É utilizado quando o plnTCAllocGrp, coluna ExtRef.
processo está fixado em um
recurso específico.
<AllocationResourceQuantity> Int Informe 1. Sim
<TryGroupBlock> String(30) Identificação de agrupamento de Sim
splits em um mesmo bloco.
Quando dois processos diferentes
tiverem um mesmo
TryGroupBlock, estes serão
agrupados em um mesmo bloco
no Gantt.
<GroupBlockOriginalOrder> Int Ordem da atividade dentro de um Sim
bloco agrupado (conforme
TryGroupBlock).

ID Elemento Pai Descrição Obrigatório Observações

WO20 <Materials> WO18 Lista de materiais (matéria-prima) Sim
consumidos pelo processo.
Atributos Tipo Descrição Obrigatório Observações
<ComponentId> String(50) Identificação do componente Sim
(material).
<Description> String(200) Descrição do componente. Sim
<UnitId> String(50) Unidade de medida do Sim Proveniente da tabela
componente. basTCUnit, coluna ExtRef.
<Quantity> Int Quantidade utilizada. Sim
<StockItemId> String(30) Código do item de estoque do Sim
material consumido no processo.

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

WO21 <LogicalEvents> WO18 Lista de eventos lógicos a serem Sim

considerados para este processo.
Representa um evento que será
considerado no planejamento.
Atributos Tipo Descrição Obrigatório Observações
<ComponentId> String(50) Identificação do componente Sim
(evento).
<Description> String(200) Descrição do evento. Sim
<PlanDate> TDateTime Data planejada para o evento, no Sim
formato dd/mm/yyyy hh:mm.
<IsAvailable> String(1) Conceder permissão (preencha Sim
com 1) ou não (preencha com 0)
para planejar o processo que
consome o componente lógico.
Exemplos: entrega de filme, ou
algum outro evento que possa ser
considerado como uma restrição
de planejamento.

ID Elemento Pai Descrição Obrigatório Observações

WO22 <UnitConversions> WO18 Unidades de conversão para este Sim
processo.
Atributos Tipo Descrição Obrigatório Observações
<UnitId> String(50) Identificação da unidade. Sim Proveniente da tabela
basTCUnit, coluna ExtRef.
<ConversionQtd> Double Fator de conversão da unidade Sim.
real do processo para esta
unidade.

ID Elemento Pai Descrição Obrigatório Observações

WO23 <UserFields> WO18 Campos adicionais para este Não
processo.
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<ColorDescription> String(200) Descrição das cores. Não

<FrontColorQtdUn> SmallInt(2) Quantidade de cores da impressão Não
Frente.
<VerseColorQtdUn> SmallInt(2) Quantidade de cores da impressão Não
Verso.
<IdProcess> String(1) Id interno do processo Metrics. Não
Enviar 0.
<IsSpecialColor> String(1) Indica se é cor especial (S/N). Não
<LosesNextPhase> Double Percentual de perda nos próximos Não
processos.
<WyeldQty> Double Quantidade líquida do processo Não
(Quantidade – Perdas).

ID Elemento Pai Descrição Obrigatório Observações

WO24 <GraphCarac> WO18 Atributos da otimização de setup. Não
Atributos Tipo Descrição Obrigatório Observações
<PaperGramme> String(10) Gramatura do papel. Não
<PaperType> String(200) Tipo de papel. Não
<PrintFormat> String(100) Formato de impressão. Não
<ColorDescription> String(600) Descrição das cores. Não
<KnifeCode> String(30) Código da ferramenta (faca, clichê, Não
etc).

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.13.1.2. Diagrama de Dependência

entre os elementos do arquivo XMLData
(INT-OP)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.13.1.3. Importação
Na importação do INT-OP são permitidas as operações de UPDATE, DELETE, UPDATESTATUS e CANCEL. A estrutura do XML será igual em
todas as operações, exceto na operação UPDATESTATUS, quando o XML será composto apenas da tag <WOMainNode> (ID WO01) e uma única
tag interna <WOChangeStatus> (ID WO03). A tag <WOChangeStatus> não é obrigatória nas demais operações.

11.13.1.4. Exportação
Na exportação do INT-OP são permitidas as operações de UPDATE, DELETE, UPDATESTATUS e CANCEL. A estrutura do XML será igual em
todas as operações, exceto na operação UPDATESTATUS, quando o XML será composto apenas da tag <WOMainNode> (ID WO01) e uma única
tag interna <WOChangeStatus> (ID WO03). A tag <WOChangeStatus> não é obrigatória nas demais operações.

11.14. WIP (Work-in-Progress)

Arquivo que contém as informações das etiquetas de produtos em processo.

11.14.1. XMLData – Arquivo de Operação

11.14.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
WI01 <sdiWIPLabel> - Inicia e finaliza o arquivo XML Sim
Atributos Tipo Descrição Obrigatório Observações
IdPalletLabel Int Código de identificação da etiqueta Sim
do pallet.
BarCode String(100) Código de barras da etiqueta WIP Não
Quantity Double Quantidade da etiqueta WIP Sim
QuantityKG Double Quantidade da etiqueta WIP em Kg Sim
UnitCode String(10) Unidade de medida do item Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

IsValid Boolean Indica se a etiqueta está validada Sim

DtValidation TDateTime Data de validação da etiqueta Não
UserValidation String(32) Nome do usuário que validou a Não
etiqueta
Status Int Situação da etiqueta, que pode ser: Sim
1 = Aguardando o uso
2 = Em Uso
3 = Processado
4 = Parcialmente Em Uso
5 = Não utilizado
6 = Cancelado
7 = Dividido
8 = Em máquina
9 = Bloqueado
10 = Em revisão
InsDt TDateTime Data de inclusão da etiqueta Sim
InsUser String(32) Usuário que incluiu a etiqueta Sim
OutputDescription String(50) Descrição do componente de saída Não
da etiqueta
IsFinalProduct Boolean Indica se é produto final Sim
StkCode String(20) Código do item de estoque Não Este campo somente será
obrigatório para produto final.
StkDescription String(100) Descrição do item de estoque Não
Shift Int Turno Não
Note String(50) Observação da etiqueta Não
PalletWeight Double Peso do pallet Não
TubeWeight Double Peso do tubete Não
IsBobbin Boolean Indica se o elemento é bobina Sim
ComponentId String(32) Código de identificação do Não
componente
FlagsQty Int Quantidade de bandeiras Não
Lot String(20) Lote do item Não

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

StkPackageBarCode String(30) Código de barra do pacote do Não

estoque
PrintSequence Int Número da sequencia de Não
impressão da etiqueta
ElementNumber Int Índice do elemento na impressão Não
da etiqueta
ProcessID Int Código de identificação do Não
processo
ProcessDescription String(200) Descrição do processo Não

11.14.1.2. Importação
Não é permitida a importação do contexto WIP.

11.14.1.3. Exportação
Na exportação do WIP somente é permitida a operação de INSERT.

11.15. WIP_TR (Transação de Etiqueta WIP)

Arquivo que contém as informações das transações das etiquetas de produtos em processo.

11.15.1. XMLData – Arquivo de Operação

11.15.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
WI02 <sdiWIPTransaction> - Inicia e finaliza o arquivo XML Sim
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

TransactionType Int Tipo de transação. Sim Possui valores diferentes para

importação e exportação (vide
tópico Importação e
Exportação).
IdPalletLabel Int Código de identificação da Sim
etiqueta do pallet.
TransactionDt TDateTime Data da transação Sim
Status Int Situação da etiqueta, que pode Sim
ser:
1 = Aguardando o uso
2 = Em Uso
3 = Processado
4 = Parcialmente Em Uso
5 = Não utilizado
6 = Cancelado
7 = Dividido
8 = Em máquina
9 = Bloqueado
10 = Em revisão
QtyBefore Double Quantidade da etiqueta antes da Não
transação
QtyAfter Double Quantidade da etiqueta depois da Não
transação
UnitCode String(10) Unidade de medida do item Sim
QtyBeforeKG Double Quantidade da etiqueta antes da Não
transação, em Kg
QtyAfterKG Double Quantidade da etiqueta depois da Não
transação, em Kg
StockPlaceCodeBefore String(32) Código do local de estoque antes Não
da transação
StockPlaceCodeAfter String(32) Código do local de estoque depois Não
da transação

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

StockAddressBefore String(30) Localização de estoque antes da Não

transação
StockAddressAfter String(30) Localização de estoque depois da Não
transação
LogUser String(32) Usuário que efetuou a transação Sim
Note String(100) Observações sobre a transação Não
Lot String(20) Lote do item Não
MachineInputCode String(30) Código da entrada de máquina Não

11.15.1.2. Importação
Na importação do contexto WIP_TR somente é permitida a operação de INSERT.
Para a importação do contexto WIP_TR, estão disponíveis as seguintes transações:

ID Descrição
2 Validação
3 Movimento
4 Registro peso
7 Finalização
24 Reabertura de pallet

11.15.1.3. Exportação
Na exportação do contexto WIP_TR somente é permitida a operação de INSERT.
Para a exportação do contexto WIP_TR, estão disponíveis as seguintes transações:

ID Descrição
1 Novo
2 Validação
3 Movimento

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

4 Registro peso
7 Finalização
10 Entrada em estoque
11 Cancelamento de entrada em estoque
16 Etiqueta dividida
17 Totalmente consumida
18 Parcialmente consumida
20 Entrega de Produção de item controlado por volumes
Cancelamento de entrega de Produção de item controlado
21
por volumes
24 Reabertura de pallet
27 Pallet Cancelado

11.16. STK_VL (Itens de Estoque controlados por Volumes)

Arquivo que contém as informações referentes aos itens de estoque controlados por volumes a serem importados/exportados.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.16.1. XMLData – Arquivo de Operação

11.16.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
VE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

VE02 <sdiStkVolumeInputLot> VE01 Cabeçalho do lote de volume Sim
Atributos Tipo Descrição Obrigatório Observações
DocType Int Informa o tipo do documento: Sim
1 – Entrada
DocOrigin String(30) Identifica o documento de origem. Sim
Exemplo: número da nota fiscal.
AddonDoc String(30) Complemento do documento de Sim
origem. Exemplo: série da nota
fiscal
ExtRef String(50) Referência externa para Sim
localização do lote de volume.
ID Elemento Pai Descrição Obrigatório Observações
VE03 <sdiLStkVolumeItem> VE02 Lista de itens de estoque Sim
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de itens de Sim
estoque.
Ex.: LCount=”10”.
ID Elemento Pai Descrição Obrigatório Observações
VE04 <sdiStkVolumeItem> VE03 Item de estoque Sim
Atributos Tipo Descrição Obrigatório Observações
StockCode String(20) Código do item de estoque Sim
MaterialType Int Informa o tipo de material. Sim
1 – tinta
2 – chapa
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

3 – outros
4 – papel em folha
5 – papel em bobina
7 - pallet
ItemType Int Tipo de item de estoque Sim
0 – matéria-prima
1 – produto acabado
MaterialName String(60) Nome do material Sim
UnitCode String(8) Código da unidade. Exemplo: KG. Sim
Height Double Altura Não Este atributo somente é
obrigatório quando o atributo
MaterialType for 4.
Width Double Largura Não
Grammage Int Gramatura Sim
NominalQtd Double Quantidade nominal Sim
UnNominalQtd String(8) Unidade da quantidade nominal Sim
StockPlaceCode String(32) Código do local de estoque Sim
StockAddressCode String(30) Código do endereço (localização) Sim
de estoque
MakerName String(30) Nome do fabricante Sim
UnWidth String(8) Unidade da largura Sim
UnHeight String(8) Unidade da Altura Sim
Diameter Double Diâmetro Sim
UnDiameter String(8) Unidade do Diâmetro Sim
UnGrammage String(8) Unidade da Gramatura Sim
ValidityDt TDateTime Validade do lote Não
ID Elemento Pai Descrição Obrigatório Observações
VE05 <sdiLStkVolume> VE04 Lista de volumes Sim
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de volumes Sim
Ex.: LCount=”10”.
ID Elemento Pai Descrição Obrigatório Observações
VE06 <sdiStkVolume> VE05 Informações sobre o volume. Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

StockCode String(20) Código do item de estoque. Deve Sim
ser o mesmo código do
<sdiStkVolumeItem> StockCode.
IdVolume Int Identificação do volume Não
CheckDigit String(1) Dígito de controle Sim
SupplierCode String(32) Código do fornecedor Sim
ExtRef String(40) Referência externa Sim
NumberBobbinTrack Int Número da bobina de origem do Não
fornecedor
VolumeStatus String(30) Status do volume Sim
IsFreeToUse Int Indica se está disponível para uso Sim
0 - Não
1 - Sim
MakerName String(30) Nome do fabricante Sim
Height Double Altura Sim
UnHeight String(8) Unidade da Altura Sim
Width Double Largura Sim
UnWidth String(8) Unidade da Largura Sim
Weight Double Gramatura Sim
UnWeight String(8) Unidade da gramatura Sim
Diameter Double Diâmetro Sim
ActualDiameter Double Diâmetro atual Sim
UnDiameter String(8) Unidade do diâmetro Sim
NominalQtd Double Quantidade nominal Sim
UnNominalQtd String(8) Unidade da quantidade nominal Sim
RealQtd Double Quantidade real Sim
UnRealQtd String(8) Unidade da quantidade real Sim
AvailableQtd Double Quantidade disponível Sim
UnAvailableQtd String(8) Unidade da quantidade disponível Sim
SupplierLot String(32) Lote do fornecedor Sim
ManufactureDt teTime Data de fabricação Sim
Ex.: 1970-12-30T00:00:00.000
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
ValidityDt TDateTime Data de validade Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
StockPlaceCode String(32) Código do local de estoque Sim
StockAddressCode String(30) Código do endereço (localização) Sim
de estoque

11.16.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK_VL)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<Metrics>
VE01

<sdiStkVolumeInputLot>
VE02

<sdiLStkVolumeItem>
VE03

<sdiStkVolumeItem>
VE04

<sdiLStkVolume>
VE05

<sdiStkVolume>
VE06

11.16.1.3. Importação
Na importação do STK_VL, são permitidas as operações de UPDATE, DELETE e CANCEL.
Permite importar lotes de entrada, sendo que na operação:
 Update – inclui o lote de entrada de volumes (Header e Item). Se existirem volumes descritos no XML, incluirá os volumes e processará a entrada do lote;
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

 Delete – exclui o lote de entrada de volumes;

 Cancel – cancela o lote de entrada de volumes.

11.16.1.4. Exportação
Este contexto não suporta operações de exportação.

11.17. STK_VT (Transações de Volumes)

Arquivo que contém as informações das transações efetuadas no módulo Volumes.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.17.1. XMLData – Arquivo de Operação

11.17.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
VE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

VE01 <metrics> - Inicia e finaliza o arquivo XML Sim
ID Elemento Pai Descrição Obrigatório Observações
VE04 <sdiStkVolumeTransactionLot> VE01 Cabeçalho do lote de transação Sim
VE02 <sdiLStkVolumeTransaction> VE04 Lista de transações Sim
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa a quantidade de Sim
transações
Ex.: LCount=”10”.
ID Elemento Pai Descrição Obrigatório Observações
VE03 <sdiStkVolumeTransaction> VE02 Transação de estoque Sim
Atributos Tipo Descrição Obrigatório Observações
IdTransaction Int Identificação da Transação Não
TransactionCode String(32) Código da Transação Sim
DocType Int Tipo de documento Sim
1 – entrada
2 – saída
3 – reserva
4 – transferência
IdVolume Int Identificação do volume Não
SupplierCode String(32) Código do fornecedor Sim
VolumeExtRef String(40) Referência externa do volume Sim
WasteType String(40) Nome do tipo de perda Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

TransactionQtd Double Quantidade da transação Sim

UnTransactionQtd String(8) Unidade da quantidade da Sim
transação
TransactionDt TDateTime Data da transação Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
TransactionProcDt TDateTime Data de processamento da Não
transação
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
Status Int Status da transação Sim
1 – cancelada
2 – processada
3 – aguardando
StockPlaceCodeBefore String(32) Local do estoque antes da Sim
execução da transação
StockPlaceCodeAfter String(32) Local do estoque depois da Sim
execução da transação
StockAddressBefore String(30) Endereço de estoque antes da Sim
execução da transação
StockAddressAfter String(30) Endereço de estoque depois da Sim
execução da transação
StockCodeBefore String(20) Código de estoque antes da Sim
execução da transação
StockCodeAfter String(20) Código de estoque depois da Sim
execução da transação
VolumeStatusBefore String(30) Status do volume antes da Sim
execução da transação
VolumeStatusAfter String(30) Status do volume depois da Sim
execução da transação
DocOrigin String(30) Origem do documento Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

AddonDoc String(30) Complemento do documento Sim

IdReserve Int Número da reserva Não
WOExtRef String(50) Referência externa da ordem de Não Este atributo somente é
produção obrigatório para operação de
consumo para produção ou
devolução da produção.
InsUser String(32) Nome do usuário que executou a Não
transação
TransactionSourceID String(32) Campo livre para preenchimento do Não
código da transação proveniente
de outros sistemas
SupplierLot String(32) Código do lote do fornecedor Não

11.17.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK_VT)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<metrics>
VE01

<sdiStkVolumeTransactionLot>

VE04

<sdiLStkVolumeTransaction>

VE02

<sdiStkVolumeTransaction>
VE03

11.17.1.3. Importação e Exportação

Na importação e na exportação do STK_VT é permitida a operação de PROCESS.

11.18. STK_VR (Requisições de Volumes)

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Arquivo que contém as informações das requisições efetuadas no módulo Volumes.

11.18.1. XMLData – Arquivo de Operação

11.18.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
VE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

VE01 <metrics> - Inicia e finaliza o arquivo XML Sim
VE02 <sdiStkRequestedMaterial> VE01 Relação de materiais requisitados Sim
Atributos Tipo Descrição Obrigatório Observações
ResourceName String(32) Nome do recurso Sim
WONumber String(32) Número da ordem de produção Sim
WOTitle String(70) Título da ordem de produção Sim
ProcessId String(16) Código de identificação do Sim
processo
ProcessTitle String(70) Título do processo Sim
PlannedQtd String(32) Quantidade planejada Sim
StartDt TDateTime Data de início planejada. Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
Restart Int Indica se o serviço interrompido Sim
será ou não reinicializado:
0 – indica que o serviço não será
reinicializado
1 – indica que o serviço será
reinicializado
Additional Int Indica se a requisição é ou não Sim
complementar:
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

0 – para indicar que a requisição

não é complementar
1 – para indicar que a requisição é
complementar
ID Elemento Pai Descrição Obrigatório Observações
VE03 <sdiLStkRequestedItem> VE02 Item de estoque requisitado Sim
Atributos Tipo Descrição Obrigatório Observações
StockCode String(20) Código do item de estoque Não
MaterialName String(60) Nome do material Sim
Qtd Double Quantidade requisitada do item de Sim
estoque
UnQtd String(8) Unidade da quantidade requisitada Sim
do item de estoque

11.18.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK_VR)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<metrics>
VE01

<sdiStkRequestedMaterial>

VE02

<sdiLStkRequestedItem>

VE03

11.18.1.3. Importação
Este contexto não suporta operações de importação.

11.18.1.4. Exportação
Na exportação do STK_VR são permitidas as operações de PROCESS.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.19. ACR (Pós-Cálculo)

Arquivo que contém as informações dos custos associados às ordens de produção.

11.19.1. XMLData – Arquivo de Operação

11.19.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
AC01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório

AC02 <sdiACRTransactionGroup> ACE01 Contém o agrupamento das Sim
transações de pós cálculo
AC03 <sdiLACRTransaction> ACE02 Contém a lista dos custos Sim
associados a uma ordem de
produção
Atributos Tipo Descrição Obrigatório
LCount Int Informa a quantidade de Sim
lançamentos de custos
Ex.: LCount=”10”.
ID Elemento Pai Descrição Obrigatório
AC04 <sdiACRTransaction> ACE03 Lançamento de custo Sim
Atributos Tipo Descrição Obrigatório
ACRTransactionType Int 1 – Previsto – indica o lançamento Sim
de custo previsto ocorrido
2 – Previsto Estorno – indica o
estorno do lançamento de custo
previsto

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

3 – Real – indica o lançamento de

custo real ocorrido
4 – Real Estorno – indica o estorno
do lançamento de custo real
ACRWONumber String(8) Número da ordem de produção Sim
ReferenceDT TDateTime Data do lançamento do custo Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
ACRAccountType Int Tipo de conta Sim
1 – materiais
2 – mão-de-obra
3 – terceiros
4 – impostos
5 – comissões
6 – custo financeiro aplicado à
venda
7 - outros
AccountCode String(16) Código da conta de custo Sim
SubAccountCode String(16) Código da sub conta de custo, que Sim
pode ser:
Para ACRAccountType = 1, será o
código do material
Para ACRAccountType = 2, será o
código do recurso
Para ACRAccountType = 3, será o
código do fornecedor
Para ACRAccountType = 4, será o
código do imposto
Para ACRAccountType = 5, será o
código do comissionado
Para ACRAccountType = 6, será o
código da classificação do custo
financeiro
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Para ACRAccountType = 7, será o

código de outros custos de venda
SubAccountTitle String(90) Título da sub conta de custo Sim
TransactionQtd Double Quantidade do lançamento Sim
UnTransactionQtd String(8) Unidade da quantidade informada Sim
no campo TransactionQtd
TransactionValue Double Valor do lançamento Sim
SourceID String(20) Código da origem do lançamento no Sim
sistema de terceiros
CurrencyID String(5) Código da moeda referente ao valor Sim
informado no campo
TransactionValue

11.19.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (ACR)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<metrics>

AC01

<sdiACRTransactionGroup>

AC02

<sdiLACRTransaction>

AC03

<sdiACRTransaction>

AC04

11.19.1.3. Importação
Na importação do ACR é permitida a operação de INSERT. Caso seja enviado um movimento incorreto, não será possível exclui-lo. Para correção
das informações, deverá ser enviado um movimento exatamente igual ao movimento errado, com o campo de valor negativo.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.19.1.4. Exportação
Este contexto não suporta operação de exportação.

11.20. JBT (JobTrack)

Arquivo que informa se o trabalho foi suspenso ou finalizado no JobTrack.

11.20.1. XMLData – Arquivo de Operação

11.20.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
JB01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

JB02 <jbtJobFinalization> JB01 Informações referentes à Sim
suspensão ou finalização do
trabalho
Atributos Tipo Descrição Obrigatório Observações
EndJobDt TDateTime Data de suspensão ou finalização Sim
do trabalho
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
PlannedQtd Double Quantidade planejada Sim
ProcessTitle String(70) Título da atividade Sim
ProcessId String(16) Código da atividade Sim
WOTitle String(70) Título da ordem de produção Sim
WONumber String(30) Número da ordem de produção Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ResourceName String(30) Nome do recurso (máquina) Sim

Interrupted Int Indica se o trabalho foi interrompido Sim
ou finalizado:
0 – finalizado
1 – interrompido
QtdProduced Double Quantidade produzida. Sim
AddOnDoc String(30) Complemento do documento de Sim
origem. Exemplo: número do grupo
do processo.

11.20.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (JBT)

<metrics> <jbtJobFinalization>

JB01 JB02

11.20.1.3. Importação
Este contexto não suporta operação de Importação.

11.20.1.4. Exportação
Na importação e na exportação do JBT é permitida a operação de INSERT.
Na geração do arquivo, serão enviados os lançamentos do período, mesmo que já tenham sido anteriormente exportados.
O gatilho deste processo deve ser disparado manualmente pelo usuário.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.21. CR (Títulos Financeiros)

Arquivo que contém as informações dos títulos financeiros.

11.21.1. XMLData – Arquivo de Operação

11.21.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
JB01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CR01 <metrics> - Inicia e finaliza o arquivo XML Sim
ID Elemento Pai Descrição Obrigatório Observações
CR02 <sdiCRGroup> CR01 Informações referentes ao grupo de Sim
títulos importados
CR03 <sdiLCR> CR02 Informações referentes à lista de Sim
títulos
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de operações Sim
que serão realizadas.
Ex.: LCount=”1”
ID Elemento Pai Descrição Obrigatório Observações
CR04 <sdiCR> CR03 Informações referentes ao título a Sim
ser importado
Atributos Tipo Descrição Obrigatório Observações
CrId String(20) Número do título Sim
InvoiceNumber String(10) Número da nota fiscal Não Este atributo somente será
obrigatório se o atributo
OriginDocumentType for
diferente de 7.
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

IdTitulo Int Identificação do título financeiro Sim

InvoiceCompl String(3) Série da nota fiscal Não Este atributo somente será
obrigatório se o atributo
OriginDocumentType for
diferente de 7.
IdCompany Int Código da empresa cujos títulos Sim
estão sendo importados
CurrentValue Double Valor do título em moeda corrente Sim
CurrentPaidValue Double Valor pago do título em moeda Não
corrente
Discount Double Valor do desconto do título Não
Interest Double Valor dos juros do título Não
InsDate TDateTime Data de emissão do título Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
DueDate TDateTime Data de vencimento do título Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
PayDate TDateTime Data de pagamento do título Não
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
CrStatus Int Status do título, que pode ser: Sim
1 – Aberto
2 – Baixado
3 - Cancelado
ValuePaymentCommission Int Valor a ser utilizado para Sim
pagamento de comissão, que pode
ser:
0 – Valor do título
1 – Valor do pagamento

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

IdCurrency Int Código de identificação da moeda Sim

ExtRef String(20) Referência externa do título Não
ExchangeRate Double Taxa da moeda Não

OriginDocumentType Int Origem do título, que pode ser: Não

0 – Título incluído pelo usuário;
1 – Título gerado pelo Metrics
Faturamento;
2 – Título gerado pelo Metrics
Compras;
3 – Título gerado pelo Metrics
Comissões;
5 – Título gerado pelo processo do
lançamento de frete;
6 – Título gerado pelo Controle de
Terceiros;
7 – Título gerado por adiantamento
do Pedido de Vendas
ForeignValue Double Valor do título em moeda Não
estrangeira
ForeignPaidValue Double Valor pago pelo título em moeda Não
estrangeira
ActorCode Int Código do cliente/fornecedor Não
ExtRefActor String(50) Código de referência externa do Não
cliente/fornecedor
SalesOrderNumber String(13) Número do pedido de venda Não Este atributo somente será
obrigatório se o atributo
OriginDocumentType for = 7
IdDoctoType Int Tipo de documento do título Não
financeiro
IdBankAccount Int Conta corrente do título financeiro Não
financialtype Int Indica o tipo do título financeiro, Não
que pode ser:

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Contas a Receber = 0
Contas a Pagar = 1
PaymentFormCode String(16) Indica o código da forma de Não
pagamento.

ID Elemento Pai Descrição Obrigatório Observações

CR05 <sdilcrallocation> CR04 Informações referentes à lista de Não
rateios
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de operações Sim
que serão realizadas.
Ex.: LCount=”1”
ID Elemento Pai Descrição Obrigatório Observações
CR06 <sdicrallocation> CR05 Informações referentes ao rateio do Sim
título
CostCenterID String(20) Código de identificação do centro Sim
de custo no sistema Metrics
(FIN_CentroCusto.CCusto)
FinancialAccountingID String(20) Código de identificação da Sim
Natureza Financeira no sistema
Metrics
(FIN_PlanoContas.CodConta)
BusinessUnitID String(20) Código de Identificação da Unidade Sim
de Negocio no sistema Metrics
Percentage Double Percentual de rateio do título Sim
financeiro

11.21.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (CR)

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

<metrics> <sdiCRGroup> <sdiLCR> <sdiCR>

CR01 CR02 CR03 CR04

<sdilcrallocation>

CR05

<sdicrallocation>

CR06

11.21.1.3. Importação e Exportação

Na importação e na exportação do CR são permitidas as operações de INSERT, UPDATE e DELETE.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.22. CTB_CTA (Plano de Contas Contábil)

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Arquivo que contém as informações das contas contábeis do sistema.

11.22.1. XMLData – Arquivo de Operação

11.22.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
CT01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CT02 <sdiCtbCtaContabil> CT01 Contém dados referentes às contas Sim
contábeis
Atributos Tipo Descrição Obrigatório Observações
Code String(30) Código da conta contábil Sim
ShortCode Int Código reduzido da conta contábil, Sim
usado internamente pelo sistema
Title String(120) Descrição da conta contábil Sim
ParentCode String(30) Código da conta contábil Não
imediatamente superior
Level Int Número que identifica o nível da Sim
conta contábil dentro do plano de
contas
AccountClass Int Classificação da conta contábil, que Sim
pode ser:
0 – Nenhum
1 – Ativo
2 – Passivo
3 – Resultado Receita
4 – Resultado Despesa
5 – Lucro Líquido
6 – Compensação
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

7 – Outras
Nature Int Natureza da conta contábil, que Sim
pode ser:
0 – Débito
1 – Crédito
AccountType Int Tipo de conta contábil, que pode Sim
ser:
0 – Sintético
1 – Analítico

11.22.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (CTB_CTA)

<metrics> <sdiCtbCtaContabil>

CT01 CT02

11.22.1.3. Importação
Este contexto não suporta operação de Importação.

11.22.1.4. Exportação
Na exportação do CTB_CTA são permitidas as operações de INSERT e UPDATE.
A exportação não será efetuada para cada conta contábil, e sim para o plano de contas completo, em lote, a partir da intervenção do usuário.
Para exportar, não basta salvar, é necessário selecionar, no menu SDI, a opção Exportação do Plano de Contas Contábil para o SDI 
Inserção/Atualização.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.23. STK_NCM (Classificações Fiscais de Itens de Estoque)

Arquivo que contém as classificações fiscais dos itens de estoque.

11.23.1. XMLData – Arquivo de Operação

11.23.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
CF01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CF02 <sdiStkNCM> CF01 Contém dados referentes às Sim
classificações fiscais
Atributos Tipo Descrição Obrigatório Observações
Code String(20) Código da classificação fiscal Sim
Title String(50) Descrição da classificação fiscal Não
Status Int Status da classificação fiscal, que Sim
pode ser:
0 - Isento
1 - Suspenso
2 - Taxado
TaxRate Double Alíquota de IPI Não
AppliesICMS Boolean Indica se incide ou não ICMS: Não
“0”= não “1”=sim
NCMCode String(20) Código NCM da classificação fiscal Sim
NCMTitle String(60) Descrição do NCM Não
ExtIPI String(5) Código da tabela EXTIPI Não
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

11.23.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK_NCM)

<metrics> <sdiStkNCM>

CF01 CF02

11.23.1.3. Importação
Este contexto não suporta operação de Importação.

11.23.1.4. Exportação
Na exportação do STK_NCM são permitidas as operações de INSERT, UPDATE e DELETE.
A exportação não é efetuada para cada NCM, e sim para a lista completa, a partir da intervenção do usuário.
Para exportar, não basta salvar, é necessário selecionar, no menu SDI, opção Exportação de Classificações Fiscais para o SDI 
Inserção/Atualização.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.24. CTB_LCTO (Lançamentos Contábeis)

Arquivo que contém as informações dos lotes de lançamentos contábeis do sistema.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.24.1. XMLData – Arquivo de Operação

11.24.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
CT01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CT02 <sdiCtbLoteLactoContabil> CT01 Contém dados referentes ao lote de Sim
lançamentos contábeis
Atributos Tipo Descrição Obrigatório Observações
NumLot Int Número do lote Sim
SerieLot Int Série do lote Sim
LotDate TDateTime Data do lote Sim
LotPeriodStartDt TDateTime Data de início do período dos Sim
lançamentos contábeis do lote
LotPeriodEndDt TDateTime Data final do período dos Sim
lançamentos contábeis do lote
InsUser String(32) Código do usuário que incluiu o lote Sim
RecordCount Int Quantidade total de lançamentos Sim
do lote

ID Elemento Pai Descrição Obrigatório Observações

CT03 <sdiLCtbLactoContabil> CT02 Contém a lista de lançamentos Sim
contábeis
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de lançamentos Sim
que serão exportados.
Ex.: LCount=”1”

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

CT04 <SdiCtbLactoContabil> CT03 Contém os dados referentes aos Sim
lançamentos contábeis
Atributos Tipo Descrição Obrigatório Observações
Lacto String(ilimitado) Dados do lançamento contábil Sim

11.24.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (CTB_LCTO)

<metrics> <sdiCtbLoteLactoContabil> <sdiLCtbLactoContabil> <sdiCtbLactoContabil>

CT01 CT02 CT03 CT04

11.24.1.3. Importação
Este contexto não suporta operação de Importação.

11.24.1.4. Exportação
Na exportação do CTB_LCTO são permitidas as operações de INSERT, UPDATE e DELETE.
Neste contexto, cada registro é uma linha de um arquivo texto. Assim, é necessário efetuar a leitura de todos os registros para montar o arquivo
texto, que deverá ser posteriormente lido para processamento dos dados.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.25. STK_BLC (Saldos de Estoque)

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Arquivo que contém as informações dos saldos de estoque do sistema.

11.25.1. XMLData – Arquivo de Operação

11.25.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
SE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

SE02 <sdiStkBalance> SE01 Contém dados referentes aos Sim
saldos de estoque
Atributos Tipo Descrição Obrigatório Observações
IdCompany Int Código de identificação da empresa Sim
Company String(30) Nome da empresa Sim
BalanceDate TDateTime Data de referência do saldo de Sim
estoque
StockPlaceCode String(32) Código do local de estoque Não

ID Elemento Pai Descrição Obrigatório Observações

SE03 <sdiLStkBalanceOutsideItemHeldBy SE02 Contém a lista de saldos de itens de Sim
Company> estoque em poder de terceiros
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de itens e saldos Sim
que serão exportados.
Ex.: LCount=”1”

ID Elemento Pai Descrição Obrigatório Observações

SE04 <sdiStkBalanceOutsideItemHeldByC SE03 Contém a lista de saldos de itens de Sim
ompany> estoque em poder de terceiros

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Atributos Tipo Descrição Obrigatório Observações

OutsideCompanyName Varchar(60) Nome da empresa terceira Sim
OutsideCompanyCode Int Código do relacionamento no Sim
cadastro Metrics
AverageCost Double Custo médio do item em poder de Sim
terceiros
FinancialBalance Double Valor do item em poder de terceiros Sim
PhysicalBalance Double Quantidade do item em poder de Sim
terceiros
UnitCode Varchar(4) Código da unidade do item em Sim
poder de terceiros
Description Varchar(100) Descrição do item em poder de Sim
terceiros
StockCodeExt Varchar(30) Código externo do item em poder de Sim
terceiros
StockCode Varchar(20) Código Metrics do item em poder de Sim
terceiros

ID Elemento Pai Descrição Obrigatório Observações

SE05 <sdiLStkBalanceItemHeldByOutside SE02 Contém a lista de saldos de itens de Sim
Company> terceiros em poder da gráfica
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de itens e saldos Sim
que serão exportados.
Ex.: LCount=”1”

ID Elemento Pai Descrição Obrigatório Observações

SE06 <sdiStkBalanceItemHeldByOutsideC SE05 Contém a lista de saldos de itens de Sim
ompany> terceiros em poder da gráfica
Atributos Tipo Descrição Obrigatório Observações
OutsideCompanyName Varchar(60) Nome da empresa terceira Sim
OutsideCompanyCode Int Código do relacionamento no Sim
cadastro Metrics

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

AverageCost Double Custo médio do item em poder da Sim

gráfica
FinancialBalance Double Valor do item em poder da gráfica Sim
PhysicalBalance Double Quantidade do item em poder da Sim
gráfica
UnitCode Varchar(4) Código da unidade do item em poder Sim
da gráfica
Description Varchar(100) Descrição do item em poder da Sim
gráfica
StockCodeExt Varchar(30) Código externo do item em poder da Sim
gráfica
StockCode Varchar(20) Código Metrics do item em poder da Sim
gráfica

ID Elemento Pai Descrição Obrigatório Observações

SE07 <sdiLnStkBalanceItem> SE02 Contém a lista de itens e seus saldos Sim
de estoque
Atributos Tipo Descrição Obrigatório Observações
LCount Int Informa o número de itens e saldos Sim
que serão exportados.
Ex.: LCount=”1”

ID Elemento Pai Descrição Obrigatório Observações

SE08 <sdiStkBalanceItem> SE07 Contém os dados referentes aos Sim
saldos dos itens de estoque
Atributos Tipo Descrição Obrigatório Observações
StockCode String(20) Código do item de estoque Sim
StockCodeExt String(30) Código externo do item de estoque Não
Description String(100) Descrição do item de estoque Sim
UnitCode String(4) Código da unidade de medida do Sim
item de estoque
PhysicalBalance Double Saldo físico do item de estoque Sim
FinancialBalance Double Saldo financeiro do item de estoque Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

AverageCost Double Custo médio do item de estoque Sim

11.25.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (STK_BLC)

<metrics> <sdiStkBalance>

SE01 SE02

<sdiLStkBalanceOutsideI <sdiStkBalanceOutsideIt
temHeldByCompany> emHeldByCompany>
SE03 SE04

<sdiLStkBalanceItemHel <sdiStkBalanceItemHeld
dByOutsideCompany> ByOutsideCompany>
SE05 SE06

<sdiLnStkBalanceItem> <sdiStkBalanceItem>
SE07 SE08

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.25.1.3. Importação
Este contexto não suporta operação de Importação.

11.25.1.4. Exportação
Este arquivo não é gerado automaticamente. É necessário acessar Controlar Materiais  Estoque  Relatórios  SDI  Exportação de Saldos de
Estoque via SDI.

Na exportação do STK_BLC é permitida a operação de INSERT.

A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.26. BIL_NFE_REC (Notas Fiscais de Compra)

Arquivo que contém as informações das notas fiscais processadas através do módulo Compras, no padrão da NFe, conforme exigido pela SEFAZ.
Para maiores informações, consulte o Manual de Orientação do Contribuinte mais atualizado, que pode ser obtido através do site
http://www.nfe.fazenda.gov.br, clicando-se no menu Documentos e selecionando-se a opção Manuais.

Na exportação do XML, o campo CFOP será preenchido com o conteúdo do campo CFOP do cadastro de CFOP (em Controlar Finanças
 Cadastros  Faturamento  CFOP).

11.27. REC (Notas Fiscais de Compra Processadas)

Arquivo que contém as informações das notas fiscais de compras que já foram processadas.

11.27.1. XMLData – Arquivo de Operação

11.27.1.1. Explicação dos elementos e atributos
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório Observações

RE01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

RE02 <SdiProviderReceipt> RE01 Contém dados referentes ao Sim
cabeçalho da nota fiscal
Atributos Tipo Descrição Obrigatório Observações
ReceiptExchangeRate Double Taxa de câmbio da nota fiscal Sim
ReceiptCurrencyDate DateTime Data da taxa de câmbio da nota Sim
fiscal
ReceiptCurrencyCode Int Código da moeda da nota fiscal Sim
PayCondition String(30) Condição de pagamento da nota Sim
fiscal
ProviderPhone String(30) Telefone do fornecedor Sim
ProviderDistrict String(60) Bairro do fornecedor Sim
ProviderPostalCode String(20) CEP do fornecedor Sim
ProviderCity String(60) Nome da cidade do fornecedor Sim
ProviderState String(5) Código do Estado do fornecedor Sim
ProviderAddress String(100) Endereço do fornecedor Sim
ProviderCountryDocument String(35) Número do documento de Sim
identificação do fornecedor
ReceiptProcessing DateTime Data de inclusão da nota fiscal Sim
ReceiptDate DateTime Data de emissão da nota fiscal Sim
ReceiptNumber String(12) Número da nota fiscal Sim
ReceiptSerie String(10) Série da nota fiscal Sim
ProviderName String(120) Nome do fornecedor Sim
ProviderCode Int Código do fornecedor Sim

ID Elemento Pai Descrição Obrigatório Observações

RE03 <SdiLProviderItemReceipt> RE02 Lista de itens da nota fiscal Sim
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LCount Int Informa o número de itens da nota Sim

fiscal a serem exportados
Ex.: LCount=”1”

ID Elemento Pai Descrição Obrigatório Observações

RE04 <SdiProviderItemReceipt> RE03 Item da nota fiscal Sim
Atributos Tipo Descrição Obrigatório Observações
ItemSequence Int Sequência do item na nota fiscal Sim
ItemCode String(20) Codigo do item da nota fiscal Sim
ItemDescription String(100) Descrição do item da nota fiscal Sim
ItemQuantity Double Quantidade do item da nota fiscal Sim
Unidade de medida de inclusão do Sim
ItemUnit String(4) item da nota fiscal
ItemUnitPrice Double Preço unitário do item da nota fiscal Sim
ItemTotalPrice Double Preço total do item na nota fiscal Sim
ItemDiscount Double Valor de desconto Sim
Indica se o item é de faturamento (0 Sim
IsBilling String(1) = Não / 1 = Sim)
Indica se o item é de remessa (0 = Sim
IsDelivery String(1) Não / 1 = Sim)
Percentual de IPI do item da nota Sim
Tax1Percentage Double fiscal
Tax1Value Double Valor de IPI do item da nota fiscal Sim
TransportationCost Double Custo de frete do item da nota fiscal Sim
Custo de seguro do item da nota Sim
TransportationInsurance Double fiscal
TransportationOtherCosts Double Outros custos de transporte Sim
TotalTransportation Double Custo total de transporte Sim

ID Elemento Pai Descrição Obrigatório Observações

RE05 <SdiLReceiptPurchaseOrder> RE04 Lista de itens de pedido atendidos Sim
por um item da nota fiscal

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LCount Int Informa o número de itens de Sim

pedido atendidos por um item da
nota fiscal
Ex.: LCount=”1”

ID Elemento Pai Descrição Obrigatório Observações

RE06 <SdiReceiptPurchaseOrder> RE05 Item de pedido Sim
PurchaseOrder Int Número do pedido de compra Sim
Quantidade do item de pedido atendido Sim
PurchaseOrderQuantity Double pelo item da nota fiscal
Valor do item de pedido atendido pelo Sim
PurchaseOrderValue Double item da nota fiscal
Unidade de medida do pedido atendido Sim
PurchaseOrderItemUnit String(4) pelo item da nota fiscal

11.27.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (REC)

<metrics> <SdiProviderReceipt> <SdiLProviderItemRe <SdiProviderItemRec <SdiLReceiptPurchas <SdiReceiptPurchase

RE01 RE02 ceipt> eipt> eOrder> Order >
RE03 RE04 RE05 RE06

11.27.1.3. Importação
Este contexto não suporta operação de Importação.

11.27.1.4. Exportação

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Este arquivo é gerado automaticamente se a opção Notas Fiscais (Compras) estiver selecionada nas configurações do módulo SDI, em
Integrações  SDI  Configurações do SDI.
Na exportação do REC é permitida a operação de INSERT, UPDATE e CANCEL.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.28. BIL_NFE_ENV (Notas Fiscais de Faturamento)

Arquivo que contém as informações das notas fiscais emitidas através do módulo Faturamento, no padrão da NFe, conforme exigido pela SEFAZ.
Para maiores informações, consulte o Manual de Orientação do Contribuinte mais atualizado, que pode ser obtido através do site
http://www.nfe.fazenda.gov.br, clicando-se no menu Documentos e selecionando-se a opção Manuais.

Na exportação do XML, o campo CFOP será preenchido com o conteúdo do campo CFOP do cadastro de CFOP (em Controlar Finanças
 Cadastros  Faturamento  CFOP).

11.29. CTB_CTC (Centros de Custo)

Arquivo que contém as informações dos centros de custos do sistema.

11.29.1. XMLData – Arquivo de Operação

11.29.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
CC01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

CC02 <sdiCtbCostCenter> CC01 Contém dados referentes aos Sim
centros de custo
Atributos Tipo Descrição Obrigatório Observações
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

CostCenterCode String(20) Código do centro de custo Sim

Title String(30) Descrição do centro de custo Sim
CostCenterType Int Tipo de centro de custo: Sim
0 = Nenhum
1 = Administrativo
2 = Auxiliar
3 = Produtivo
IsAccountPayable Boolean Informa se o centro de custo é Sim
utilizado para o Contas a Pagar.
“0”= não “1”=sim
IsAccountReceivable Boolean Informa se o centro de custo é Sim
utilizado para o Contas a Receber.
“0”= não “1”=sim
IsActive Boolean Informa se o centro de custo está Sim
ativo.
“0”= não “1”=sim
AccountCode String(30) Código da conta contábil do centro Não
de custo.

ID Elemento Pai Descrição Obrigatório Observações

CC03 <sdiCtbBusinessUnit> CC02 Contém dados referentes aos Não
centros de custo
Atributos Tipo Descrição Obrigatório Observações
Code String(10) Código da unidade de negócio do Não
centro de custo
Title String(40) Descrição da unidade de negócio Não
do centro de custo

ID Elemento Pai Descrição Obrigatório Observações

CC04 <sdiCtbLCompany> CC02 Contém dados referentes aos Sim
centros de custo
Atributos Tipo Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

LCount Int Informa o número de empresas que Sim

utilizam o centro de custo.
Ex.: Lcount=”1”

ID Elemento Pai Descrição Obrigatório Observações

CC05 <sdiCtbCompany> CC04 Contém dados referentes aos Não
centros de custo
Atributos Tipo Descrição Obrigatório Observações
IDCompany Int Código de identificação da empresa Não
NickName String(30) Nome da empresa Não

11.29.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (CTB_CTC)

<metrics> <sdiCtbCostCenter> <sdiCtbBusinessUnit>

CC01 CC02 CC03

<sdiCtbLCompany> <sdiCtbCompany>
CC04 CC05

11.29.1.3. Importação
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Este contexto não suporta operação de Importação.

11.29.1.4. Exportação
Na exportação do CTB_CTC são permitidas as operações de INSERT e UPDATE.
A exportação não será efetuada para cada centro de custo, e sim para a lista completa, em lote, a partir da intervenção do usuário.
Para exportar, não basta salvar, é necessário selecionar, no menu SDI, opção Exportação em Lote de Contas de Custo via SDI 
Inserção/Atualização.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.30. POR (Pedidos de Compra)

Arquivo que contém as informações dos pedidos de compra a serem importados/exportados.

11.30.1. XMLData – Arquivo de Operação

11.30.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
PO01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

PO02 <sdiPORPurchaseOrder> PO01 Inicia as informações de pedidos Sim

ID Elemento Pai Descrição Obrigatório Observações

PO03 <sdiPORPurchaseOrderInfo> PO02 Contém informações referentes ao Sim
pedido.
Atributos Tipo Descrição Obrigatório Observações
IDCompany Int Código de identificação da empresa Sim
PurchaseOrderNumber Int Código do Pedido de compra Sim
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Data de emissão do Pedido Sim

Ex.: 1970-12-30T00:00:00.000
EmissionDt TDateTime
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
SupplierCode String (32) Código Metrics do fornecedor Sim
ContactName String(30) Nome do contato Sim
LimitReceiptDt TDateTime Data máxima de entrega do pedido Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
TotalValue Double Valor total do Pedido Sim
Situation Small Int Situação de aprovação do Pedido: Sim
0 = Não aprovado
1 = Aprovado
2 = Rejeitado
3 = Em aprovação
Status Small Int Status do Pedido: Sim
0 = Aberto
1 = Fechado
IDCurrency Int Código da moeda do pedido Sim
TransporterCode String (32) Código Metrics da Transportadora Não
ExtRef Varchar(50) Número da Ordem de Compra do Não
sistema terceiro na integração SDI.

ID Elemento Pai Descrição Obrigatório Observações

PO04 <sdiPORPayCondInfo> PO03 Contém dados sobre a condição de Sim
pagamento.
Atributos Tipo Descrição Obrigatório Observações
ConditionCode String(30) Condição de pagamento. Sim
Ex.: À vista, 30/60/90, etc.

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

PO05 <sdiLPORPayCondDueDate> PO04 Contém informações sobre os Sim

vencimentos.
Atributos Tipo Descrição Obrigatório Observações
Lcount Int Informa a quantidade de Sim
vencimentos do bloco.
Ex.: Lcount=”8”

ID Elemento Pai Descrição Obrigatório Observações

PO06 <sdiPORPayCondDueDate> PO05 Contém informações sobre os Sim
vencimentos
Atributos Tipo Descrição Obrigatório Observações
DueDate TDateTime Data do vencimento Sim
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
Value Double Valor do Vencimento Sim

ID Elemento Pai Descrição Obrigatório Observações

PO07 <sdiLPORItemInfo> PO02 Contém dados referentes aos itens Sim
do pedido.
Atributos Tipo Descrição Obrigatório Observações
Lcount Int Informa a quantidade de itens de Sim
pedidos do bloco.
Ex.: Lcount=”8”
UserField1 Varchar(50) Informações adicionais do pedido Não
de compra.
UserField2 Varchar(50) Informações adicionais do pedido Não
de compra.
UserField3 Varchar(50) Informações adicionais do pedido Não
de compra.
UserField4 Varchar(50) Informações adicionais do pedido Não
de compra.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

UserField5 Varchar(50) Informações adicionais do pedido Não

de compra.

ID Elemento Pai Descrição Obrigatório Observações

PO08 <sdiPORItemInfo> PO07 Contém dados referentes aos itens Sim
do pedido.
Atributos Tipo Descrição Obrigatório Observações
StockCode String(20) Código de estoque do item Metrics Sim
Quantidade na unidade do item do Sim
Quantity Double
pedido
Quantidade recebida na unidade do Não
TotalReceiptQty Double
item do pedido
Unidade do item do pedido (UN, Sim
UnitCode String(10)
KG, etc.)
UnitValue Double Valor Unitário Sim
TransportCost Double Custo do frete Sim
TotalValue Double Valor total item do pedido Sim
Data máxima para entrega do item Sim
LimitReceiptDt TDateTime
do pedido
Status Small Int Situação do Item do Pedido: Sim
0 = Pendente
1 = Parcialmente entregue
2 = Totalmente entregue
OtherCosts Double Valor dos custos adicionais Não
IdCurrency Int Código da moeda do item do pedido Sim
ExchangeRate Double Taxa de câmbio Sim
ExchangeRateDt TDateTime Data da taxa de câmbio da moeda Não
Informações adicionais do pedido Não
UserField1 Varchar(50)
de compra.
Informações adicionais do pedido Não
UserField2 Varchar(50)
de compra.
Informações adicionais do pedido Não
UserField3 Varchar(50)
de compra.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Informações adicionais do pedido Não

UserField4 Varchar(50)
de compra.
Informações adicionais do pedido Não
UserField5 Varchar(50)
de compra.

ID Elemento Pai Descrição Obrigatório Observações

PO09 <sdiLPORItemReceiptInfo> PO08 Contém dados referentes às Sim
entregas dos itens do pedido
Atributos Tipo Descrição Obrigatório Observações
Lcount Int Informa a quantidade de entregas Sim
do bloco.
Ex.: Lcount=”8”

ID Elemento Pai Descrição Obrigatório Observações

PO10 <sdiPORItemReceiptInfo> PO09 Contém dados referentes às Sim Esta informação é apenas
entregas dos itens do pedido exportada, não é processada
na importação do XML.
Atributos Tipo Descrição Obrigatório Observações
ReceiptDate TDateTime Data de entrega do item da entrega Sim
ReceiptQty Double Quantidade da entrega Sim
Número da Nota de entrada Sim
DocumentNumber String(20) referente à entrega do item do
pedido
Número da sequência do Item na Sim
ItemDocumentNumber Int
Nota de Entrada
UnitValue Double Valor unitário do item da entrega Sim
TotalValue Double Valor total da entrega Sim
Unidade do item da entrega (UN, Sim
ReceiptUnit String(10)
KG, etc.)

11.30.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (POR)
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

<metrics> <sdiPORPurchaseOrder> <sdiPORPurchaseOrderInfo> <sdiPORPayCondInfo> <sdiLPORPayCondDueDate> <sdiPORPayCondDueDate>

PO01 PO02 PO03 PO04 PO05 PO06

<sdiLPORItemInfo> <sdiPORItemInfo> <sdiLPORItemReceiptInfo> <sdiPORItemReceiptInfo>

PO07 PO08 PO09 PO10

11.30.1.3. Importação e Exportação

Na importação e na exportação do POR são permitidas as operações de INSERT, UPDATE e DELETE.
A estrutura do XML será igual em todas as operações. Somente o atributo NAME do elemento sdiOperation deve ser modificado, de acordo com a
operação.

11.31. JBT_APT (Apontamentos do Jobtrack)

Arquivo que contém as informações dos apontamentos efetuados através do Jobtrack a serem importados/exportados.

11.31.1. XMLData – Arquivo de Operação

11.31.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
JBT01 <metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

JBT02 < Ljbtjobentry > STE01 Lista de Apontamento Sim

Atributos Tipo Descrição Obrigatório Observações
lcount Int Informa a quantidade de Sim
apontamentos do bloco.
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

JBT03 <jbtjobentry> STE01 Contém os apontamentos do Sim
período exportado
Atributos Tipo Descrição Obrigatório Observações
wonumber String(12) Número da ordem de produção. É Sim
apresentado vazio para
apontamentos não relacionados a
uma OP.
resource String(30) Código do Recurso onde foi Sim
realizada a atividade
hours String(20) Total de horas, por tipo, desta OP Sim
registradas neste recurso e data.
quantity Int Quantidade Produzida total da OP, Sim
por tipo, registrada neste recurso e
data
dateref TDateTime Data da Entrada de máquina no Sim
JobTrack
Ex.: 1970-12-30T00:00:00.000
Sintaxe: AAAA-MM-
DDTHH:MM:SS.MMM
type String (1) Tipo de hora Sim
P = Produtivo
I = Improdutivo
ProcessGroupCode String(50) Código do elemento Sim
ActivityCode String(50) Código da atividade Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

AllocGrpCode String(50) Código do grupo de alocação Sim

IdAtiv Int Id da atividade Sim

11.31.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (JBT_APT)

<metrics> < Ljbtjobentry > < jbtjobentry >

JBT 01 JBT 02 JBT 03

11.31.1.3. Importação
Este contexto não suporta operação de Importação.

11.31.1.4. Exportação
Na exportação do JBT_APT é permitida a operação de PROCESS.
Na geração do arquivo, serão enviados os lançamentos do período, mesmo que já tenham sido anteriormente exportados.
O gatilho deste processo deve ser disparado manualmente pelo usuário.

11.32. PCK (Solicitação de Picking)

Arquivo que contém as informações de solicitações de Picking.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.32.1. XMLData – Arquivo de Operação

11.32.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
PC01 <Metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

PC02 <SdiPCKSeparation> PR01 Inicia as informações da separação Sim
Atributos Tipo Descrição Obrigatório Observações
Código de identificação da
IDSeparation Int separação de materiais no sistema Sim
Metrics
Código de identificação da empresa
IDCompany Int Sim
no sistema Metrics
Código do Cliente no sistema
CustomerCode String (32) Sim
Metrics
InvoiceReqNumber String (10) Número da solicitação de nota Sim
Situação da separação no sistema
Metrics
0 = Pendente
Status Int 1 = Atendida Sim
2 = Processada
3 = Liberada para emissão
4 = Nota emitida
Peso líquido total da separação, em
NetWeight Double Não
Quilos
Peso bruto total da separação, em
GrossWeight Double Não
Quilos
Quantidade total de volumes na
Contents Double Não
separação
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

VolumeType String (30) Tipo ou espécie para o volume Não

ID Elemento Pai Descrição Obrigatório Observações
Sim para
Informações do processamento da
PC03 <SdiPCKProcessInfo> PR02 importação
separação
Process
Atributos Tipo Descrição Obrigatório Observações
Código do local de estoque do O local de estoque informado
processamento deve estar cadastrado no
sistema Metrics Printware.
Caso o local de estoque
informado não pertença à
empresa da separação, será
exibida uma mensagem
informativa e a importação não
será efetuada.
Caso não tenha sido
Sim para
informado, será exibida uma
StockPlaceCode String (32) importação
mensagem solicitando o local
Process
para processamento da
separação.
Caso o local de estoque
informado não esteja
configurado para receber
produtos separados para
emissão de nota fiscal, será
exibida uma mensagem
informativa, e a importação não
será efetuada.
Código da localização de estoque A localização de estoque
do processamento informada deve estar
Sim para
cadastrado no sistema Metrics
StockAddressCode String (30) importação
Printware.
Process
Caso não tenha sido
informado, será exibida uma
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

mensagem solicitando a
localização para
processamento da separação.

ID Elemento Pai Descrição Obrigatório Observações

Lista os itens que compoem a
PC04 <SdiLPCKSeparationItem> PR02 Sim
separação
Atributos Tipo Descrição Obrigatório Observações
Informa a quantidade de itens de
LCount Int estoque para a separação. Sim
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

PC05 <SdiPCKSeparationItem> PR03 Contém os itens da separação Sim
Atributos Tipo Descrição Obrigatório Observações
Código interno de identificação do
IDSeparationItem Int Sim
item da separação
StockCode String (20) Código de estoque do item. Sim
Situação do item na separação:
0 = Não atendido
Status Int Sim
1 = Atendido Parcialmente
2 = Atendido
Quantity Double Quantidade total do produto Sim
UnitCode String (10) Unidade do item (UN, KG, etc.) Sim
UnitWeight Double Peso unitário do item, em Quilos Não

ID Elemento Pai Descrição Obrigatório Observações

PC06 <SdiLPCKTrackOutputEntry> PR04 Contém os itens separados Sim
Atributos Tipo Descrição Obrigatório Observações
Informa a quantidade de itens de
LCount Int estoque para a separação. Sim
Ex.: LCount=”8”

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

ID Elemento Pai Descrição Obrigatório

PC07 <SdiPCKTrackOutputEntry> PR05 Contém os lotes de itens separados Sim
Atributos Tipo Descrição Obrigatório
Quantity Double Quantidade movimentada Sim
UnitCode String (10) Unidade do item (UN, KG, etc.) Sim
Quantidade do item em cada
PackageQuantity Double Sim
embalagem (pacote, caixa, etc.)
Unidade da embalagem (PCT, CX,
UnitPackage String (10) Sim
etc.)
Número do lote de produção.
Lot String(20) Caso deixe em branco, será Sim
considerado “ÚNICO”.
Identificador do local de estoque de
Stockplacecode String(20) Sim
origem.
Localização do item no local de
estoque origem.
StockAddress String(20) Sim
Caso deixe em branco, será
considerado “ÚNICO”.

11.32.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (PCK)

<SdiPCKSeparatio <SdiPCKProcessI <SdiLPCKSepa <SdiPCKSepar <SdiLPCKTrackO <SdiPCKTrackO

<metrics> n> nfo> rationItem> ationItem> utputEntry> utputEntry>
PC01 PC02 PC03 PC04 PC05 PC06 PC07

11.32.1.3. Importação
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Na importação do PCK são permitidas as operações de UPDATE, PROCESS, DELETE e CANCEL. Caso não exista a separação de material
informada no XML, será exibida uma mensagem informativa.
Nas operações de UPDATE, quando a situação da separação de materiais não for Pendente ou Atendida, nenhuma outra informação será
atualizada, somente a situação da separação.
Nas operações de PROCESS:
 quando a situação da separação de materiais não for Pendente ou Atendida, será exibida uma mensagem informativa indicando que o
processamento não será possível;
 o processamento somente poderá ser efetuado caso todos os itens tenham sido atendidos;
Nas operações de DELETE:
 somente será permitido excluir separações de materiais EM ABERTO;
 não será permitido excluir separações de materiais que possuam itens já atendidos. Para que seja possível excluir a separação, é
necessário primeiramente importar a operação de UPDATE, alterando a sua situação para EM ABERTO, e depois importar a operação de
DELETE;
 após deletar a separação, o usuário deverá abrir a tela de Solicitação de Nota Fiscal e efetuar a separação ou abrir a tela de Separação de
Materiais e incluir a separação manualmente.
Nas operações de CANCEL:
 somente será possível cancelar uma separação cuja situação esteja Processado ou Liberado para Emissão;
 separação de pedido com solicitação de nota fiscal emitida não poderá ser cancelada;
 o material da separação cujo processamento foi cancelado retornará para o local de origem da separação, exceto se a configuração do
módulo Estoque indicar que o material deverá retornar ao local de destino.

11.32.1.4. Exportação
Na exportação do PCK são permitidas as operações de INSERT, UPDATE e DELETE.
Para a operação UPDATE, o XML será igual ao de INSERT, porém, no arquivo XML de Operação, o atributo NAME do elemento sdiOperation
deve ser UPDATE.

11.33. PRQ (Solicitações de Compra)

Arquivo que contém as informações de solicitações de compra para importação/exportação.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

11.33.1. XMLData – Arquivo de Operação

11.33.1.1. Explicação dos elementos e atributos
ID Elemento Pai Descrição Obrigatório Observações
PR01 <Metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

PR02 <SdiPRQPurchaceRequest> PR01 Inicia as informações de solicitações Sim
Atributos Tipo Descrição Obrigatório Observações
Código de identificação da empresa
IDCompany Int Sim
no sistema Metrics.
Código do grupo de solicitação de
PurchaseRequestNumber Int Sim
compra
Código do Centro de custo no
CostCenter String (20) Sim
sistema Metrics
Data de emissão da Solicitação.
Ex.: 1970-12-30T00:00:00.000
EmissionDt TDateTime Sim
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
RequesterName String (20) Usuario que criou a solicitação. Sim
StockCode String(20) Código do item no estoque Metrics Sim
Situação da Solicitação:
0 = Aberto (não enviada para
aprovação)
1 = Em Processo de Cotação
2 = Em Processo de Pedido de
Situation Small Int Sim
Compra
3 = Aberto aprovado
4 = Recusada
5 = Pendente de aprovação
7 = Atendido Parcial
DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

8 = Atendido Total.
Data de emissão da Solicitação.
Ex.: 1970-12-30T00:00:00.000
ApprovalDt TDateTime Não
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
ApprovalName String (20) Usuario que aprovou a solicitação. Não
RejectionsReason String (255) Motivo da recusa da solicitação Não
Data de emissão da Solicitação.
Ex.: 1970-12-30T00:00:00.000
CancelDt TDateTime Não
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
CancelerName String (20) Usuário que cancelou a solicitação. Não
Quantidade solicitada do item (em
RequestedQty Double Sim
sua unidade de custo)
Quantidade aprovada para o item
ApprovedQty Double Não
(na unidade de custo do item).
Unidade de custo do item da
UnitCode String(10) Sim
solicitação de compra (UN, KG, etc.)
SuggestedUnitValue Double Preço unitário sugerido Não
Data mínima para entrega do
MinDeliveryDate TDateTime Sim
produto pelo fornecedor.
Data máxima para entrega do
MaxDeliveryDate TDateTime Sim
produto pelo fornecedor.
Quantidade solicitada do item em
RequestedQtyUnitStock Double Sim
sua unidade de estoque.
Quantidade aprovada para o item
ApprovedQtyUnitStock Double Não
em sua unidade de estoque.
Unidade de estoque do item da
StockUnitCode String(10) Não
solicitação de compra (UN, KG, etc.)
WONumber String(20) Número da OP Não
Observações para o item da
Obs String (2000) Não
solicitação de compra
IdCurrency Int Código da moeda no Metrics Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Informa o código da unidade de

ProfitCenter String (10) Sim
negócio no sistema Metrics.
String(20) Informa o código do local de Não
StockPlaceCode
estoque no sistema Metrics.

11.33.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (PRQ)

11.33.1.3. Importação
Na importação do PRQ é permitida a operação de UPDATE, permitindo somente a atualização do campo Situação, efetuando as seguintes
validações:
- se o campo Número de Solicitação está preenchido;
- se a situação está correta - valores válidos: 1, 2, 6, 7 ou 8;
- se o item de estoque da solicitação está correto.

11.33.1.4. Exportação
Na exportação do PRQ são permitidas as operações de INSERT, UPDATE e DELETE.
Para a operação UPDATE, o XML será igual ao de INSERT, porém, no arquivo XML de Operação, o atributo NAME do elemento sdiOperation
deve ser UPDATE.

11.34. OSP (Lotes de Pagamento a Terceiros)

DOCUMENTO DE REQUISITOS TÉCNICOS
 Manual para integração entre sistemas via XML

Arquivo que contém as informações referentes aos lotes de pagamento a terceiros, obtidas ao gerar o lote através da tela de Pagamento de
Fornecedores.

11.34.1. XMLData – Arquivo de Operação

11.34.1.1. Explicação dos elementos e atributos

ID Elemento Pai Descrição Obrigatório Observações

PR01 <Metrics> - Inicia e finaliza o arquivo XML Sim

ID Elemento Pai Descrição Obrigatório Observações

PR02 <SdiOSPPaymentLot> PR01 Inicia as informações do Lote Sim
Atributos Tipo Descrição Obrigatório Observações
Código de identificação do lote no
IDLot Int Sim
sistema Metrics.
Código de identificação da empresa
IDCompany Int Sim
no sistema Metrics.
Código do fornecedor no sistema
SupplierCode Int Sim
Metrics.
Data de emissão da solicitação. Ex.:
1970-12-30T00:00:00.000
EmissionDt TDateTime Sim
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
Situação do lote no Metrics:
1 = Aberto
Status Int Sim
2 = Fechado
3 = Cancelado
ReleasedValue float Valor total liberado dos formulários. Sim
DiscountedValue float Valor de desconto aplicado no lote Sim

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

PaymentValue float Valor total a pagar para o lote Sim

Data de vencimento do lote
Ex.: 1970-12-30T00:00:00.000
DueDate TDateTime Sim
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
Usuário que gerou o lote no sistema
InsUser String (20) Sim
Metrics
Usuário que finalizou o lote no
EndUser String (20) Não
sistema Metrics
Obs String (2000) Observações do lote Não

ID Elemento Pai Descrição Obrigatório Observações

Lista os formulários de retorno
PR03 <SdiLOSPReturnForm> PR03 Sim
liberados no lote
Atributos Tipo Descrição Obrigatório Observações
Informa a quantidade de
LCount Int movimentos de estoque do bloco. Sim
Ex.: LCount=”8”

ID Elemento Pai Descrição Obrigatório Observações

Contém os formulários de retorno
PR04 <SdiOSPReturnForm> PR03 Sim
liberados no lote
Atributos Tipo Descrição Obrigatório Observações
ReturnFormNumber Int Código do formulário de retorno Sim
Código do serviço no sistema
ServiceCode float Sim
Metrics
Descrição do serviço no sistema
ServiceName String (60) Sim
Metrics
SendFormNumber Int Código do formulário de envio Sim
WONumber String(20) Número da OP Sim
PurchaseOrderNumber Int Código da Ordem de compra Não
String (20) Código de estoque do item da
StockCode Não
ordem de compra.

DOCUMENTO DE REQUISITOS TÉCNICOS

 Manual para integração entre sistemas via XML

Data do formulário de retorno

Ex.: 1970-12-30T00:00:00.000
ReturnDate TDateTime Sim
Sintaxe:
AAAA-MM-DTHH:MM:SS.MMM
ReleasedValue float Valor liberado do formulário Sim
Valor de desconto aplicado no
DiscountedValue float Sim
formulário

11.34.1.2. Diagrama de Dependência entre os elementos do arquivo

XMLData (OSP)

11.34.1.3. Importação
Este contexto não suporta operação de Importação.

11.34.1.4. Exportação
Na exportação do OSP são permitidas as operações de INSERT, UPDATE e DELETE.
Para a operação UPDATE, o XML será igual ao de INSERT, porém, no arquivo XML de Operação, o atributo NAME do elemento sdiOperation
deve ser UPDATE.

DOCUMENTO DE REQUISITOS TÉCNICOS