Transações/Entidades/Mensagens únicas

Abaixo são demostradas as transações/entidades, e as informações transitadas:



Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Método

ID

Descrição

Origem

Destino

Tipo

XSD (versões podem variar)












Cadastros












01

Centro de Custo

Protheus

PIMS

SOAP

CostCenter_2_000.xsd

02

Grupo de Produtos

Protheus

PIMS

SOAP

Family_2_002.xsd

03

Produtos

Protheus

PIMS

SOAP

Item_ 3_001.xsd

04

Depósito / Armazém

Protheus

PIMS

SOAP

WareHouse_ 1_000.xsd













Processos











05

Estoque

PIMS

Protheus

SOAP

stocklevel_3_004
06

Ordem de Produção

Protheus

PIMS

REST

PRODUCTIONORDER
07

Reporte/Estorno de Produção

Protheus

PIMS

REST

PRODUCTIONAPPOINTMENT
08VendasProtheusPIMSRESTSALESCONSOLIDATION


Principais Tabelas e campos (Bioenergia) envolvidas nas integrações:

Entidade

Informação

Tipo

Mensagem


Campo PIMS PI
TabelaNomeObrigatório ?Tipo de DadoTamanhoObservação

Espécie (Grupo de Insumo)

Código

SOAP

Family_2_002.xsd

PROGRUMATE

GRU_CODIGOSimVARCHAR5
DescriçãoGRU_DESCRISimVARCHAR50
ResumoGRU_RESUMOSimVARCHAR25
TipoGRU_TIPOSimNUMBER10=processo / 1= laboratório

Insumos

Código da Empresa

SOAP

Item_ 3_001.xsd

PROPRODUTOS

EMP_CODEMPSimCHAR3
CódigoPRO_CODIGOSimVARCHAR214
DescriçãoPRO_DESCRICAOSimVARCHAR250
Unidade de MedidaPRO_UNIDADESimVARCHAR215
EspécieGRU_CODIGOSimVARCHAR225
ÁreaARE_CODIGONãoCHAR3
VariávelVAR_CODIGONãoCHAR10
Último Valor CompraPRO_VALORNãoNUMBER10,4
ConversãoPRO_CONVERSAONãoVARCHAR22000
Controlado PFPRO_PFNãoVARCHAR210=sim / 1: não
ValidadePRO_VALIDADENãoDATE

NormaID_NORMANãoNUMBER12
NormaID_NORMAMNãoNUMBER23
CódigoPRO_CODCORPNãoVARCHAR220
Data InativaçãoDATA_INATIVACAONãoDATE

Status IntegraçãoFG_STATUS_EAINãoVARCHAR21
Código de retornoCD_INT_ERPNãoVARCHAR220

Depósito

ID Depósito

SOAP

WareHouse_ 1_000.xsd

PRODEPOSITOS

ID_DEPOSITOSimNUMBER10
CódigoDEPCODIGOSimVARCHAR23
DescriçãoDEPDESCRICAOSimVARCHAR235
ResumoDEPRESUMOSimVARCHAR215
TipoDEPTIPOSimVARCHAR21Físico=F / Virtual= V
Código da EmpresaEMP_CODEMPSimCHAR3
Código da RetornoCD_INT_ERPNãoVARCHAR220

Centro de Custo

Código Empresa

SOAP

CostCenter_2_000.xsd

PROCENCUSTO

EMP_CODEMPSimCHAR3
CódigoCEN_CODIGOSimVARCHAR220
DescriçãoCEN_DESCRICAOSimVARCHAR230
ResumoCEN_RESUMOSimVARCHAR215
Variável Ponderação 1VAR_CODIGONãoCHAR10
Unidade de Medida 1CEN_UNIDADENãoVARCHAR215
Variável de Ponderação 2VAR_CODIGO1NãoCHAR10
Unidade de Medida 2CEN_UNIDADE1NãoVARCHAR215
Local de AplicaçãoCEN_LOCAL_APLIC_INSUMONãoVARCHAR220
Código de RetornoCD_INT_ERPNãoVARCHAR220

Ordem de Produção com Entrada de Matéria-Prima e Biomassa

ID da Ordem de Produção

REST

PRODUCTIONORDER

PROORDPROD

ID_ORDPRODSimNUMBER12
Código da EmpresaEMP_CODEMPSimCHAR3
Número da Ordem de ProduçãoNUM_OPSimCHAR20
Código do ProdutoPRO_CODIGOSimVARCHAR215
Quantidade Planejada de ProdutoQT_ORDPRODSimNUMBER10,3
Unidade de MedidaPRO_UNIDADESimVARCHAR215
Data de Abertura da Ordem de ProduçãoDT_ORDPRODsimDATE

DepósitoDEP_CODIGOSimVARCHAR24
Data de Encerramento da Ordem de ProduçãoDT_FECHAOPNãoDATE
Enviar a data de encerramento quando a OP for fechada
ID da Matéria-Prima da Ordem de Produção

PROORDPRODMP

ID_ORDPRODMPSimNUMBER12
ID da Ordem de ProduçãoID_ORDPRODSimNUMBER12
Código do ProdutoPRO_CODIGOsimVARCHAR215
Código do DepósitoDEP_CODIGOsimVARCHAR24
Lote do ProdutoPRO_LOTENãoVARCHAR215
Unidade de MedidaQT_ORDPRODMPSimNUMBER10,3
Quantidade de Matéria-Prima da Ordem de ProduçãoPRO_UNIDADESimVARCHAR215
ID do Atributo da Matéria-Prima

PROORDATBMP

ID_ORDPRODATBSimNUMBER12
ID da Ordem de ProduçãoID_ORDPRODSimNUMBER12
ID da Matéria-Prima da Ordem de ProduçãoID_PRODCOMANLSimNUMBER12
Valor do AtributoATB_VALORNãoNUMBER10,3

ATB_TEXTONãoVARCHAR220
Texto do AtributoPRO_UNIDADENãoVARCHAR215
ID do Subproduto da Ordem de Produção

PROORDSP

ID_ORDPRODSPSimNUMBER12
ID da Ordem de ProduçãoID_ORDPRODSimNUMBER12
Código do ProdutoPRO_CODIGOSimVARCHAR215
DepósitoDEP_CODIGOSimVARCHAR24

Dados para Ordem de Produção

ID da tabela de reporte de produção

REST

PRODUCTIONAPPOINTMENT

PROREPORTE

ID_REPORTESimNUMBER12
ID da Ordem de ProduçãoID_ORDPRODSimNUMBER12
Data do Reporte de ProduçãoDT_REPORTSimDATE

Produto ProduzidoPRO_CODIGOSimVARCHAR215
Código do DepósitoDEP_CODIGOSimVARCHAR24
Quantidade de Produto ProduzidoQT_ORDPRODSimNUMBER10,3
Unidade de MedidaPRO_UNIDADESimVARCHAR215
Status da IntegraçãoFG_STATUS_EAINãoVARCHAR210-Criado 1-Enviado 2-Em Processamento 3-Erro 4-Integrado com Sucesso
Número da Movimentação no ERPDOC_ERPNãoVARCHAR215
Tipo Movimento - Reporte ou EstornoTP_TRANSACAOSimVARCHAR21R-Reporte E-Estorno
ID do log de reporte de produção

PROREPORTELOG

ID_REPORTELOGSimNUMBER12
ID da tabela de reporte de produçãoID_REPORTESimNUMBER12
Data e Hora da transaçãoDTHR_TRANSACAOSimDATE

Tipo de TransaçãoTP_TRANSACAOSimVARCHAR21R - Reporte / E = Estorno
Código do UsuárioLAN_USUARIOSimVARCHAR241
Mensagem de retorno da integraçãoINT_MENSAGEMNãoVARCHAR21000
ID do Reporte de Produção

PROREPPROD

ID_PROREPPRODSimNUMBER12
ID do Reporte de Produtos (MP ou SP)ID_REPORTESimNUMBER12
Código do ProdutoPRO_CODIGOSimVARCHAR215
Quantidade de Produto ProduzidoQT_ORDPRODSimNUMBER10,3
Unidade de MedidaPRO_UNIDADESimVARCHAR215
Código do DepósitoDEP_CODIGOSimVARCHAR24
Tipo de Produto (MP ou SP)TP_PRODUTOSimVARCHAR22MP = MATÉRIA-PRIMA / SP = SUBPRODUTO
ID do Reporte de Produção

PROREPINSUMO

ID_PROREPINSUMOSimNUMBER12
ID do Reporte de InsumoID_REPORTESimNUMBER12
Código do ProdutoPRO_CODIGOSimVARCHAR215
Quantidade de Produto ProduzidoQT_ORDPRODSimNUMBER10,3
Unidade de MedidaPRO_UNIDADESimVARCHAR215
Código do DepósitoDEP_CODIGOSimVARCHAR24

Vendas de Produtos Acabados/Subprodutos/Insumos

Consultar analista PROTHEUS

Código da Empresa

REST

SALESCONSOLIDATION

INTVENDAS

EMP_CODEMPSimCHAR3
ID da tabelaID_INTVENDASSimNUMBER12
Código do Produto de ComercializaçãoPRO_CODIGOSimVARCHAR215
DepósitoDEP_CODIGOSimVARCHAR24
Data de ReferênciaDT_REFERSimDATE

QuantidadeQT_INTVENDASSimNUMBER10
Unidade de MedidaPRO_UNIDADESimVARCHAR215

Estoque de Produtos Acabados/Subprodutos/Insumos por Empresa e Depósito

Consultar analista PROTHEUS

Código da Empresa

SOAP

stocklevel_3_004

INTESTOQUE

EMP_CODEMPSimCHAR3
ID da tabelaID_INTESTOQUESimNUMBER12
Código do Produto de ComercializaçãoPRO_CODIGOSimVARCHAR215
Código do DepósitoDEP_CODIGOSimVARCHAR24
Data de ReferênciaDT_REFERSimDATE


PRO_UNIDADESimVARCHAR215
QuantidadeQT_INTESTOQUESimNUMBER10


Informações para desenvolvimento de API

INTEGRAÇÃOTRANSAÇÃOINFORMAÇÕESCAMPOSTAGTIPO INTJSON PIMSOBSERVAÇÕESEstratégia de Integração

Ordem de Produção com Entrada de Matéria-Prima e Biomassa

PRODUCTIONORDER

Dados da Ordem de Produção

Código da EmpresaCompanyID

REST API

{ "Transaction" : "ProductionOrder" ,
"Event": "UPSERT",
"CompanyID": "01",
"BranchID": "010101",
"ProductionOrderNumber": "999999",
"ItemCode": "123456",
"Quantity": "999.99",
"UnitOfMeasureCode": "XX",
"StartOrderDateTime": "2024-11-07T10:00:00",
"WarehouseCode": "99",
"EndOrderDateTime": "2024-11-07T17:00:00",
"rawMaterial": [
{
"ItemCode": "1111111",
"WarehouseCode": "88",
"LotCode": "1234567890",
"Quantity": "9999.999",
"UnitOfMeasureCode": "ZZ",
"rawMaterialAnalysis": [
{
"AttributeCode": "545454",
"Value": "13.00",
"Text": "XXXXXXXXXXXXXXXXXXXX",
"UnitOfMeasureCode": "TT"
}
]
}
],
"subProduct": [
{
"ItemCode": "145487877",
"WarehouseCode": "77"
}
]
}

Event: UPSERT quando for uma inclusão ou alteração e DELETE quando for uma exclusão.
Os valores informados no JSON são meramente ilustrativos.
Para as mensagens processados com sucesso será devolvido o código "200" na chamada HTTP e quando houver algum erro será devolvido o código "500" e descrição do erro gerado pela aplicação.

Método: post

URL:
http://ip:porta/OrdemProducaoTOTVSPI/integrationService/receive/ProductionOrder

Autenticação de usuário (Basic 64) (Usuario cadastrado na opção usuário de serviços do PIMSConnector)

PROTHEUS--> PIMS PI

Código da FilialBranchID
Número da Ordem de ProduçãoProductionOrderNumber
Código do Produto a Ser ProduzidoItemCode
Quantidade Planejada de ProdutoQuantity
Unidade de MedidaUnitOfMeasureCode
Data de Abertura da Ordem de ProduçãoStartOrderDateTime
Depósito onde o produto acabado será armazenadoWarehouseCode
Data de Encerramento da Ordem de Produção **EndOrderDateTime

Matéria Prima da Ordem de Produção

Código do Produto (Matéria-Prima)ItemCode
Código do Depósito onde será dado baixa no estoque de Matéria-PrimaWarehouseCode
Lote do Produto (Matéria-Prima) se o controle for por loteLotCode
Quantidade de Matéria-Prima da Ordem de ProduçãoQuantity
Unidade de MedidaUnitOfMeasureCode

Atributos da Análise da Matéria-Prima

Código do Atributo da Matéria-Prima (análise)AttributeCode
Valor do Atributo (se numérico)Value
Texto do Atributo (se textual)Text
Unidade de MedidaUnitOfMeasureCode

Sub-Produtos da Ordem de Produção

Código do Subproduto da Ordem de ProduçãoItemCode
Código do Depósito onde o subproduto será armazenadoWarehouseCode

Dados para Ordem de Produção (Reporte e Estorno de Produção)

PRODUCTIONAPPOINTMENT

Dados do Reporte de Produção

Código da EmpresaCompanyID

REST API

{ "Transaction" : "ProductionAppointment" ,
"Event" : "UPSERT" ,
"CompanyID" : "01" ,
"BranchID" : "010101" ,
"ProductionOrderNumber" : "1234567890" ,
"StartReportDateTime" : "2023-11-07T00:00:00" ,
"ItemCode" :"123456" ,
"WarehouseCode" : "55" ,
"Quantity" : "9999.999" ,
"UnitOfMeasureCode" : "JJ" ,
"ActivityCode" : "123" ,
"ReportNumber" : "1234567890" ,
"ProductionList" : [{ "ItemCode" : "1245678" ,
"Quantity" : "9999.999" ,
"UnitOfMeasureCode" : "DD" ,
"WarehouseCode" : "44" ,
"ActivityCode" : "324" }]
}

Retorno JSON
{
"Transaction" : "ProductionAppointment" ,
"CompanyID" : "01" ,
"BranchID" : "010101" ,
"ProductionOrderNumber" : "1234567890" ,
"StartReportDateTime" : "2023-11-07T00:00:00" ,
"ReportNumber" : "1234567890"
}

* Código do tipo de movimento (Definido por parâmetro no PI
** Número do Movimento: ERP deverá informar o número do documento/movimento gerado quando for processado com sucesso ou texto quando houver algum tipo de erro de validação/processamento
Event:
UPSERT quando for uma inclusão e DELETE quando for um estorno.
Os valores informados no JSON são meramente ilustrativos.

Quando o EVENT for tipo UPSERT o ReportNumber não será informado, ele só vai preenchido quando for uma operação de estorno onde o evento vai preenchido como "DELETE"

No JSON de retorno quando for uma operação de "UPSERT" (Tag event), este campo será devolvido pelo PROTHEUS informando número/código do movimento gerado como campo identificador. Quando for uma operação do tipo "DELETE" não há necessidade de enviar informação.


Método: post

PIMS PI --> PROTHEUS

Código da FilialBranchID
Número da Ordem de ProduçãoProductionOrderNumber
Data do Reporte de ProduçãoStartReportDateTime
Código do Produto ProduzidoItemCode
Código do Depósito (entrada no ERP)WarehouseCode
Quantidade de Produto ProduzidoQuantity
Unidade de MedidaUnitOfMeasureCode
Código do Tipo de Movimento*ActivityCode
Número da Movimentação no ERP**ReportNumber

Dados dos produtos consumidos e sub-produtos produzidos

Código do Produto (Matéria-Prima, Insumo ou Subproduto)ItemCode
Quantidade de Produto ProduzidoQuantity
Unidade de MedidaUnitOfMeasureCode
Código do Depósito (Entrada ou Saída)WarehouseCode
Código do Tipo de Movimento*ActivityCode

Vendas de Produtos Acabados/Subprodutos/Insumos

SALESCONSOLIDATION

Dados dos Produtos Vendidos na Data

Código da EmpresaCompanyID

REST API


Método: Post

{ "Transaction" : "SalesConsolidation" ,
"Event" : "REQUEST" ,
"CompanyID" : "01" ,
"BranchID" : "01010" ,
"SalesDate" : "2023-11-07" ,
"listItems" : [{ "ItemCode" : "123456" }]
}


Retorno da mensagem

{ "Transaction" : "SalesConsolidation" ,
"Event" : "REQUEST" ,
"CompanyID" : "01" ,
"BranchID" : "010101" ,
"SalesDate" : "2023-11-07" .
"listItems" : [{ "ItemCode" : "1234456" ,
"UnitOfMeasureCode" : "XX" ,
"listWarehouse" : [{
"WarehouseCode" : "44" ,
"Quantity" : "9999.999" ,
}]
}]
{



Método: Post

PROTHEUS --> PIMS PI

Código da FilialBranchID
Código do ProdutoItemCode
Data do MovimentoSalesDate
Código do DepósitoWarehouseCode
Quantidade de Vendas Total do Produto na data do MovimentoQuantity
Unidade de MedidaUnitOfMeasureCode