Árvore de páginas

Versões comparadas

Chave

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

...

Bloco de código
languagejava
titleBody da requisição de inclusão
collapsetrue
	{
    "specversion": "1.0",
    "type": "TITreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "I",
			"E1_NUM":   "10",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": "A",
			"E1_TIPO": "NF",
			"E1_NATUREZ": "REC001",
		    "E1_EMISSAO":  "19/07/2023",
			"E1_VENCTO": "20/08/2023",
			"E1_MOEDA": 1,
			"E1_TXMOEDTXMOEDA": 0,
			"E1_CLIENTE": "000001",
			"E1_LOJA": "01",
            "E1_VALOR": 10500.50,
            "E1_HIST": "CAMPO LIVRE", 
            "ID": "ID001",
            "SYSCODE": "ID001" 
         },          
		 {
            "CompanyId": "T1",
            "BranchId": "D MG 02",
            "OperationType" : "P",			
			"OperationAction" : "I",
			"E1E2_NUM": "20",
			"E2_PREFIXO": "GES",
			"E2_PARCELA": "",
			"E2_TIPO": "NF",
			"E2_NATUREZ": "PAG001",
		    "E2_EMISSAO":  "19/07/2023",
			"E2_VENCTO": "20/08/2023",
			"E2_MOEDA": "2",
			"E2_TXMOEDTXMOEDA": 4.5,
			"E2_FORNECE": "000001",
			"E2_LOJA": "01",
            "E2_VALOR": 1000,
            "E2_HIST": "TITULO PAGAR MOEDA 2 - TAXA 4.5", 
            "ID": "ID002",
            "SYSCODE": "ID002" 
         }
     ]
}
Bloco de código
languagejava
titleBody da requisição de exclusão
collapsetrue
	{
    "specversion": "1.0",
    "type": "TITreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "E",
			"E1_NUM":   "10",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": "A",
			"E1_TIPO": "NF",
            "ID": "ID001",
            "SYSCODE": "ID001" 
         },          
		 {
            "CompanyId": "T1",
            "BranchId": "D MG 02",
            "OperationType" : "P",			
			"OperationAction" : "E",
			"E2_NUM": "20",
			"E2_PREFIXO": "GES",
			"E2_PARCELA": "",
			"E2_TIPO": "NF",
			"E2_FORNECE": "000001",
			"E2_LOJA": "01",
            "ID": "ID002",
            "SYSCODE": "ID002" 
         }
     ]
}

...

a. Principais Campos e Parâmetros

CampoDescriçãoTipoTamanho(MAX)ObrigatórioObservação
CompanyIdCódigo
da empresa
do Grupo de EmpresasCaractere2x

Grupo de Empresa do Protheus.

Todos os movimentos da mensagem devem pertencer ao mesmo Grupo de Empresa. Caso existam movimentos de Grupos de Empresa diferentes, deverão ser enviados em mensagens separadas.

BranchIdCódigo da FilialCaractere8x

Filial do Protheus.

Identificação da filial do sistema onde ocorrerá a operação. Em ambientes com Gestão de Empresas o BranchId é composto pela Empresa + Unidade de Negócio + Filial

OperationType

Operação a ser realizada

"P" ou "R"

Caractere1x

"P" = Título a Pagar

"R" = Título a Receber

OperationAction

Ação de integração a ser realizada

Caractere1x

"I" = Inclusão

"E" = Exclusão

DocumentNumber

E1_NUM (para OperationType="R")

E2_NUM (para OperationType="P")

Número do documentoCaractere9xSerá complementado com "0" (zeros) a esquerda, quando o conteúdo passado for inferior ao tamanho do campo na base de dados.

E1_PREFIXO (para OperationType="R")

E2_PREFIXO (para OperationType="P")

DocumentPrefix

Prefixo de identificação do títuloCaractere3xN/A
DocumentParcel

E1_PARCELA (para OperationType="R")

E2_PARCELA (para OperationType="P")

Parcela do títuloCaractere1xPode ser enviado conteúdo vazio. 
DocumentTypeCode

E1_TIPO (para OperationType="R")

E2_TIPO (para OperationType="P")

Tipo 

Caractere3xConforme tabela SX5 - NF, BOL,  FT,  etc.
FinancialNatureID

E1_NATUREZ (para OperationType="R")

E2_NATUREZ (para OperationType="P")

Natureza financeiraCaractere10
x
Somente para OperationAction igual a "I"N/A
IssueDate

E1_EMISSAO (para OperationType="R")

E2_EMISSAO (para OperationType="P")

Emissão do títuloCaractere10
xN/ADueDateVencimento do títuloCaractere10xIntegração irá calcular o vencimento Real conforme a data informada.Currency
Somente para OperationAction igual a "I"A data deverá ser informada no formato "DD/MM/AAAA".

E2_VENCTO (para OperationType="R")

E2_VENCTO (para OperationType="P")

Vencimento do títuloCaractere10Somente para OperationAction igual a "I"

A data deverá ser informada no formato "DD/MM/AAAA".

Integração irá calcular o vencimento Real conforme a data informada.

E1_MOEDA (para OperationType="R")

E2_MOEDA (para OperationType="P")

MoedaNumérico1
x

N/A
CurrencyRate

E1_TXMOEDA (para OperationType="R")

E2_TXMOEDA (para OperationType="P")

Taxa da moedaNumérico5
x

Para moeda 1-Real, indicar
taxa 0EntityId
taxa 0

E1_CLIENTE (para OperationType="R")

E2_FORNECE (para OperationType="P")

Código do Cliente ou Código de FornecedorCaractere6xIndicar código válido de cliente ou fornecedor, conforme operação especificada no OperationType
EntityBranch

E1_LOJA (para OperationType="R")

E2_LOJA (para OperationType="P")

Loja do Cliente ou  FornecedorCaractere2x
Conforme operação especificada no OperationTypeValue
Conforme operação especificada no OperationType

E1_VALOR (para OperationType="R")

E2_VALOR (para OperationType="P")

Valor do títuloNumérico16
xN/AHistory
Somente para OperationAction igual a "I"

O valor dos decimais deverá ser separado por "." (ponto).

Ex: 1234.56

E1_HIST (para OperationType="R")

E2_HIST (para OperationType="P")

HistóricoCaractere40
x

Pode ser enviado conteúdo vazio.
ID

Código de Controle Gesplan

Caractere
xN/A
SYSCODEChave identificadora GesplanCaractere
xN/A
EspecíficoCampo específico do ERPVariável

Ver mais detalhes da utilização de campos específicos no "item b" abaixo.

b. Campo específico/customizado

Existe a possibilidade de enviar qualquer outro campo existente no dicionário de dados da tabela SE1 (Contas a Receber) para OperationType do tipo "R" ou SE2 (Contas a Pagar) para OperationType do tipo "P" do ambiente onde está sendo processada a mensagem.

Esse campo pode ser um campo padrão (não exemplificado na tabela acima) ou um campo customizado (criado especificamente para o ambiente Protheus em que a integração está ativa). Nesse caso, basta que seja inserida uma nova linha no conteúdo da mensagem, com o mesmo formato Chave/Valor, conforme exemplo abaixo, onde inserimos os campos

...

E1_CCUSTO (campo padrão do produto) e E1_XDTCLI (campo específico do ERP do cliente) no movimento com OperationType do tipo "R" e E2_CCUSTO (campo padrão do produto) e

...

E2_XDTCLI (campo específico

...

do ERP do cliente) no movimento com OperationType do tipo "P".

Bloco de código
languagejava
titleBody da requisição de inclusão com campo específico
collapsetrue
	{
    "specversion": "1.0",
    "type": "TITreadXGsp",
    "tenantId": "c6486a57-3447-461d-bcdf-d66b94226f69",
    "time": "2023-07-19T15:18:08.367574Z",
    "data": [
        {
            "CompanyId": "T1",
            "BranchId": "D MG 01",
            "OperationType" : "R",
			"OperationAction" : "I",
			"E1_NUM":   "10",
			"E1_PREFIXO": "GES",
			"E1_PARCELA": "A",
			"E1_TIPO": "NF",
			"E1_NATUREZ": "REC001",
		    "E1_EMISSAO":  "19/07/2023",
			"E1_VENCTO": "20/08/2023",
			"E1_MOEDA": 1,
			"E1_TXMOEDTXMOEDA": 0,
			"E1_CLIENTE": "000001",
				"E1_LOJA": "01",
            "E1_VALOR": 10500.50,
            "E1_LOJAHIST": "01CAMPO LIVRE",
                       "E1_VALORCCUSTO": 10500.50"CC001",
            "E1_HISTXDTCLI": "CAMPO LIVRE01/07/2023",
 
            "ID": "ID001",
            "SYSCODE": "ID001" 
         },          
		 {
            "CompanyId": "T1",
            "BranchId": "D MG 02",
            "OperationType" : "P",			
			"OperationAction" : "I",
			"E1_NUM": "20",
			"E2_PREFIXO": "GES",
			"E2_PARCELA": "",
			"E2_TIPO": "NF",
			"E2_NATUREZ": "PAG001",
		    "E2_EMISSAO":  "19/07/2023",
			"E2_VENCTO": "20/08/2023",
			"E2_MOEDA": "2",
			"E2_TXMOEDTXMOEDA": 4.55,
			"E2_FORNECE": "000001",
			"E2_FORNECELOJA": "01",
            "000001",
			E2_VALOR": 1000,
            "E2_LOJAHIST": "01TITULO PAGAR MOEDA 2 - TAXA 4.5",
                  "E2_VALORCCUSTO": 1000"CC001",
            "E2_HISTXDTCLI": "TITULO PAGAR MOEDA 2 - TAXA 4.5", 
01/07/2023",
             "ID": "ID002",
            "SYSCODE": "ID002" 
         }
     ]
}

...

  • SE1- Títulos a Receber
  • SE2- Títulos a Pagar

05. DEMAIS INFORMAÇÕES

Ponto de Entrada FiTitGsp para permitir a inclusão de campo/conteúdo específicoalteração do conteúdo do execauto do FINA040/FINA050