Á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_TXMOED": 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",
			"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_TXMOED": 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" 
         }
     ]
}

03. Outras Informações

a. Principais Campos e Parâmetros

CampoDescriçãoTipoTamanho(MAX)ObrigatórioObservação
CompanyIdCódigo da empresaCaractere2x

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.

N/A

BranchIdCódigo da FilialCaractere8xN/AFilial do Protheus
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

DocumentNumberNúmero do documentoCaractere9xSerá complementado com "0" (zeros) a esquerda, quando o conteúdo passado for inferior ao tamanho do campo na base de dados.
DocumentPrefixPrefixo de identificação do títuloCaractere3xN/A
DocumentParcelParcela do títuloCaractere1xPode ser enviado conteúdo vazio. 
DocumentTypeCode

Tipo 

Caractere3xConforme tabela SX5 - NF, BOL,  FT,  etc.
FinancialNatureIDNatureza financeiraCaractere10xN/A
IssueDateEmissão do títuloCaractere10xN/A
DueDateVencimento do títuloCaractere10xIntegração irá calcular o vencimento Real conforme a data informada.
CurrencyMoedaNumérico1xN/A
CurrencyRateTaxa da moedaNumérico5xPara moeda 1-Real, indicar taxa 0
EntityIdCódigo do Cliente ou Código de FornecedorCaractere6xIndicar código válido de cliente ou fornecedor, conforme operação especificada no OperationType
EntityBranchLoja do Cliente ou  FornecedorCaractere2xConforme operação especificada no OperationType
ValueValor do títuloNumérico16xN/A
HistoryHistóricoCaractere40xPode 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 E5_DEBITO (campo padrão do produto) e E5_XDTCLI (campo específico do ERP do cliente). 

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_TXMOED": 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",
			"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_TXMOED": 4.5,
			"E2_FORNECE": "000001",
			"E2_LOJA": "01",
            "E2_VALOR": 1000,
            "E2_HIST": "TITULO PAGAR MOEDA 2 - TAXA 4.5", 
            "ID": "ID002"
            "SYSCODE": "ID002" 
         }
     ]
}

Card documentos
InformacaoOs campos SysCode e ID não serão gravados no ERP, eles são somente informações de controle da Gesplan, que chegará na requisição e serão enviados na resposta do processamento, indicando sucesso ou falha da inclusão desse título. Além dos índices de pesquisas disponíveis, é possível listar os registros gerados através do campo origem, com conteúdo FINITITG.
TituloIMPORTANTE!

...