Linha RM
A mensagem TraceabilityOrder é utilizada para retorno de informações geradas a partir Solicitações de Emissão de NF/Fatura. Estas solicitações são geradas pela Mensagem Order.
Após a solicitação ter sido gerada no RM, poderão ser solicitadas as seguintes informações pela mensagem TraceabilityOrder :
- Nota Fiscal de Remessa geradas a partir de uma Solicitação de Emissão de Nota Fiscal Remessa;
- Faturas de Locação geradas a partir de uma Solicitação de Emissão de Fatura;
- Nota Fiscal de NFSe a partir de uma solicitação de Emissão de NFSe;
- Nota Fiscal de NFe a partir de uma Solicitação de Emissão NFe;
- Notas Fiscais de Retorno de Equipamento geradas por de cópia referência da Nota Fiscal de Remessa.
Mapeamento de Campos da Mensagem Única TraceabilityOrder - RM
| Mensagem Única | RM | Observação | ||
|---|---|---|---|---|
| Elemento | Descrição | Tabela | Coluna | |
| BusinessContent.RequestItem (Rental) | Conteúdo de envio | |||
| OrderInternalId | Id de integração do Pedido | TMOV | CODCOLIGADA|IDMOV | Os dois parâmetros são obtidos a partir do internalId do produto. |
| TypeOrder | Tipo do Pedido | Utilizado para identificar qual tipo de Solicitação está sendo enviado:
| ||
| ShippingInvoiceNumber | Número da Remessa | TMOV | NUMEROMOV | Essa informação será enviada no caso de se desejar os dados do Retorno de um Equipamento. Essa informação deverá vir junto com TypeOrder igual a "002" |
| ShippingInvoiceSeries | Série da Remessa | TMOV | SERIE | Essa informação será enviada no caso de se desejar os dados do Retorno de um Equipamento. Essa informação deverá vir junto com TypeOrder igual a "002" |
| ShippingInvoiceItem | Item da Remessa | TITMMOV | NSEQITMMOV | Essa informação será enviada no caso de se desejar os dados do Retorno de um Equipamento. Essa informação deverá vir junto com TypeOrder igual a "002". O preenchimento desta informação é opcional. Caso preenchido, será retornado os dados do Retorno de Equipamento do item informado (NSEQITMMOV). Caso não preenchido será retornado os dados de Retorno de Equipamento de todos os itens. |
| ReturnContent.ReturnItem (RM) | Conteúdo de retorno | |||
| Elemento | Descrição | Tabela | Coluna | |
| CompanyId | Coligada | TMOV | CODCOLIGADA | |
| BranchId | Filial | TMOV | CODFILIAL | |
| CompanyInternalId | Coligada|Filial | TMOV | CODCOLIGADA | CODFILIAL | |
| Number | Número do Movimento | TMOV | NUMEROMOV | |
| CustomerVendorInternalId | Id de integração do Cliente/Fornecedor no Movimento | TMOV | CODCOLCFO|CODCFO | |
| PaymentConditionInternalId | Id de integração da condição de pagamento no movimento | TMOV | CODCOLIGADA |CODCPG | |
| RegisterDateTime | Data de Emissão da Nota Fiscal | TMOV | DATAEMISSAO | |
| InvoiceDocumentSerie | Serie da Nota Fiscal | TMOV | SERIE | |
| GrossValue | Valor Bruto da Nota Fiscal | TMOV | VALORBRUTO | |
| NetValue | Valor Líquido da Nota Fiscal (Valor Bruto + Frete + Seguro - Desconto) | TMOV | VALORLIQUIDO | |
| ListOftItem.Item (RM) | ||||
| Elemento | Descrição | Tabela | Coluna | |
| CompanyId | Coligada | TITMMOV | CODCOLIGADA | |
| BranchId | Filial | TITMMOV | CODFILIAL | |
| CompanyInternalId | Coligada|Filial | TITMMOV | CODCOLIGADA | CODFILIAL | |
| InternalId | InternalId do Item | TITMMOV | CODCOLIGADA | IDMOV|NSEQITMMOV | |
| Number | Número Sequencial do Item | TITMMOV | NUMEROSEQUENCIAL | |
| ItemInternalId | InternalId do Produto | TITMMOV | CODCOLIGADA | IDPRD | |
| Quantity | Quantidade | TITMMOV | QUANTIDADE | |
| UnitOfMeasureInternalId | Id de integração da Unidade de Medida | TITMMOV | CODUND | |
| UnitPrice | Preço Unitário | TITMMOV | PRECOUNITARIO | |
| TotalPrice | Preço Total do Item | TITMMOV | VALORLIQUIDO | |
| OperationCode | Natureza de operação | DCFOP | CODNAT | O RM irá enviar como padrão X.XXX (Ex: 5.929) |
| WarehouseInternalId | Id de integração do Local de Estoque(Armazem) | TITMMOV | CODCOLIGADA | CODFILIAL|CODLOC | |
| OrderItemInternalId | Id de integração do Item do Pedido de Venda | TITMMOV | CODCOLIGADA | IDMOV|NSEQITMMOV | Tag para informar vínculo entre o item da Nota fiscal e o item do Pedido de Venda do Rental. Esta tag será preenchida com o internalId de integração do item do pedido de venda (valor RM ou Global Id). |
| ReturnContent.ReturnItem.ReturnMessage | Mensagem de retorno | Caso não sejam encontradas informações para retornar, este campo será preenchido com uma mensagem informativa. | ||
Exemplos:
Exemplo Envio do Rental para o RM - formato JSON
{
"Header": {
"UUID": "ad986d6c-2068-41c6-a74e-65a1130f08cb",
"Type": "BusinessMessage",
"SubType": "request",
"Event": "upsert",
"Transaction": "TRACEABILITYORDER",
"Version": "1.000",
"SourceApplication": "PROT",
"ProductName": "RENTAL",
"ProductVersion": "12",
"CompanyId": "99",
"BranchId": "01",
"GeneratedOn": "2021-07-23T17:24:07.748Z",
"DeliveryType": "sync"
},
"Content": {
"RequestItem": {
"OrderInternalId": "99|01|0005",
"OrderItemInternalId": "99|0005|00.1",
"TypeOrder": "005",
"ShippingInvoiceSeries": "P",
"ShippingInvoiceNumber": "000310",
"ShippingInvoiceItem": "1"
}
}
}
Exemplo Resposta do RM quando não encontrado Notas - formato JSON
{
"Header": {
"UUID": "40fa72a6-ebe0-4323-ac1f-8807e057ec30",
"Type": "Response",
"SubType": "request",
"Transaction": "TRACEABILITYORDER",
"Version": "1.000",
"StandardVersion": "1.000",
"SourceApplication": "RM",
"ProductName": "RM",
"ProductVersion": "12.1.33.0",
"CompanyId": "1",
"BranchId": "1",
"GeneratedOn": "2021-07-23T14:24:08.3005366-03:00",
"DeliveryType": "Sync",
"CompanySharingMode": null,
"BusinessUnitySharingMode": null,
"BranchSharingMode": null,
"Event": "upsert"
},
"Content": {
"ReceivedMessage": {
"UUID": "ad986d6c-2068-41c6-a74e-65a1130f08cb",
"SentBy": "RENTAL",
"Event": "Upsert"
},
"ProcessingInformation": {
"ProcessedOn": "2021-07-23T17:24:08",
"Status": "Ok",
"Details": []
},
"ReturnContent": {
"ReturnItem": null,
"ReturnMessage": "Nenhuma Nota Fiscal autorizada foi encontrada para os registros solicitados",
"ListOfInternalId": null
}
}
}
Exemplo Resposta do RM quando encontrado Nota - formato JSON
{
"Header": {
"UUID": "368ee54a-ae76-4eaa-a1a4-261ab29401c6",
"Type": "Response",
"SubType": "request",
"Transaction": "TRACEABILITYORDER",
"Version": "1.000",
"StandardVersion": "1.000",
"SourceApplication": "RM",
"ProductName": "RM",
"ProductVersion": "12.1.33.0",
"CompanyId": "1",
"BranchId": "1",
"GeneratedOn": "2021-07-23T14:16:54.4758257-03:00",
"DeliveryType": "Sync",
"CompanySharingMode": null,
"BusinessUnitySharingMode": null,
"BranchSharingMode": null,
"Event": "upsert"
},
"Content": {
"ReceivedMessage": {
"UUID": "3eccfe39-58ef-443d-a230-de01790ab2fd",
"SentBy": "RENTAL",
"Event": "Upsert"
},
"ProcessingInformation": {
"ProcessedOn": "2021-07-23T17:16:54",
"Status": "Ok",
"Details": []
},
"ReturnContent": {
"ReturnItem": [
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"Number": "040189",
"CustomerVendorInternalId": "ED2CCEEE-E942-41E1-8AA0-6BC72F5513E9",
"PaymentConditionInternalId": "AA53110C-9A5C-4BEA-8E40-9DE247AFD10F ",
"RegisterDateTime": "2021-07-21T00:00:00",
"InvoiceDocumentSerie": "U",
"GrossValue": 150.0,
"NetValue": 150.0,
"ListOftItem": {
"Item": [
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"InternalId": "1|2576|1",
"Number": "1",
"ItemInternalId": "84E9EA92-890E-4716-B631-6CAACED67523",
"Quantity": 3.0,
"UnitOfMeasureInternalId": "955B930B-91BD-476C-8B7D-9D524A8A882E",
"UnitPrice": 50.0,
"TotalPrice": 0.0,
"OperationCode": "6.101",
"WarehouseInternalId": "CFEC7711-79F5-4C70-8EBA-F249A2A79738",
"OrderItemInternalId": "D257EF6F-FB9B-4093-9E63-9068B8620C13"
}
]
}
}
],
"ReturnMessage": "",
"ListOfInternalId": null
}
}
}
Exemplo envio do Rental para o RM sem o preenchimento da tag "ShippingInvoiceItem" OU sem tal tag - formato JSON
{
"Header": {
"UUID": "{{$guid}}",
"Type":"BusinessMessage",
"SubType":"request",
"Event":"upsert",
"Transaction":"TRACEABILITYORDER",
"Version":"1.000",
"ProductName":"PROTHEUS",
"SourceApplication":"PROT",
"ProductVersion":"12",
"CompanyId":"01",
"BranchId":"01",
"GeneratedOn": "{{$isoTimestamp}}",
"DeliveryType":"sync"
},
"Content": {
"RequestItem" : {
"OrderInternalId":"01||0005",
"TypeOrder":"002",
"ShippingInvoiceSeries":"0",
"ShippingInvoiceNumber": "000016",
"ShippingInvoiceItem": ""
}
}
}
OU
{
"Header": {
"UUID": "{{$guid}}",
"Type":"BusinessMessage",
"SubType":"request",
"Event":"upsert",
"Transaction":"TRACEABILITYORDER",
"Version":"1.000",
"ProductName":"PROTHEUS",
"SourceApplication":"PROT",
"ProductVersion":"12",
"CompanyId":"01",
"BranchId":"01",
"GeneratedOn": "{{$isoTimestamp}}",
"DeliveryType":"sync"
},
"Content": {
"RequestItem" : {
"OrderInternalId":"01||0005",
"TypeOrder":"002",
"ShippingInvoiceSeries":"0",
"ShippingInvoiceNumber": "000016"
}
}
}
Exemplo Resposta do RM quando tag "ShippingInvoiceItem" está ausente ou não preenchida - formato JSON
{
"Header": {
"UUID": "265b0430-7d99-4ae6-baa6-1c647f47ba5c",
"Type": "Response",
"SubType": "request",
"Transaction": "TRACEABILITYORDER",
"Version": "1.000",
"StandardVersion": "1.000",
"SourceApplication": "RM",
"ProductName": "RM",
"ProductVersion": "12.1.33.0",
"CompanyId": "-1",
"BranchId": "-1",
"GeneratedOn": "2021-08-05T17:17:10.471711-03:00",
"DeliveryType": "Sync",
"CompanySharingMode": null,
"BusinessUnitySharingMode": null,
"BranchSharingMode": null,
"Event": "upsert"
},
"Content": {
"ReceivedMessage": {
"UUID": "f8d57616-1ce4-4189-b270-0d4766f36e88",
"SentBy": "PROTHEUS",
"Event": "Upsert"
},
"ProcessingInformation": {
"ProcessedOn": "2021-08-05T20:17:10",
"Status": "Ok",
"Details": []
},
"ReturnContent": {
"ReturnItem": [
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"Number": "777703",
"CustomerVendorInternalId": "1|C00011",
"PaymentConditionInternalId": "1|005",
"RegisterDateTime": "2021-08-05T00:00:00",
"InvoiceDocumentSerie": "U",
"GrossValue": 1962.5000,
"NetValue": 2123.2500,
"ListOftItem": {
"Item": [
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"InternalId": "1|2455|1",
"Number": "1",
"ItemInternalId": "1|68",
"Quantity": 4.0000,
"UnitOfMeasureInternalId": "UN",
"UnitPrice": 50.0000000000,
"TotalPrice": 200.0000000000,
"OperationCode": "1.101",
"WarehouseInternalId": "1|1|01"
"OrderItemInternalId": "1|2451|1"
},
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"InternalId": "1|2455|2",
"Number": "2",
"ItemInternalId": "1|71",
"Quantity": 1.5000,
"UnitOfMeasureInternalId": "UN",
"UnitPrice": 125.0000000000,
"TotalPrice": 187.5000000000,
"OperationCode": "1.101",
"WarehouseInternalId": "1|1|01",
"OrderItemInternalId": "1|2451|2"
},
{
"CompanyId": "1",
"BranchId": "1",
"CompanyInternalId": "1|1",
"InternalId": "1|2455|3",
"Number": "3",
"ItemInternalId": "1|64",
"Quantity": 0.5000,
"UnitOfMeasureInternalId": "UN",
"UnitPrice": 3150.0000000000,
"TotalPrice": 1575.0000000000,
"OperationCode": "1.101",
"WarehouseInternalId": "1|1|01",
"OrderItemInternalId": "1|2451|3"
}
]
}
}
],
"ReturnMessage": "",
"ListOfInternalId": null
}
}
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas