Consulta
POST
Inclusão
Alteração
Exclusão
Para clientes que possuem rotinas ou aplicativos customizados e precisam consultar as informações na rotina FINA460A(Cadastro de Simulação de liquidação a receber), foram disponibilizados métodos Web Service REST.
| GET Consulta | POST | PUT Alteração | DELETE Exclusão |
| | | |
Para realizar testes, pode ser utilizado qualquer programa de sua preferência, que teste API Web Service REST.
Como exemplos de programas, podemos citar o SoapUI ou Postman . Ambos são excelentes aplicativos.
Os exemplo a seguir serão demonstrados utilizando programa Postman, executando o método GET.
Para inclusão ou alteração do registro, pode utilizar a mesma estrutura (body), os campos podem ser adicionados dentro da tag FIELDS.
Maiores detalhes referente a montagem da estrutura, verificar modelo abaixo.
Onde:
id: é id da API
operation: é o código da operação, valor padrão: 1,
pk: é a chave primária do alias do modelo de dados encodado em base64,
models: são os modelos de negócios de cada API, ou seja, modelo de dados do MVC, que é definido por:
id: é o modelo de dados definido no MVC
modeltype: é tipo de modelo de dados, "FIELDS" ou "GRID"
fields: é um vetor com os campos, definido por:
id: é nome do campo
order: ordem do campo na tabela SBE
value: é o valor do campo
Importante Por padrão, para realizar consulta, alteração ou deleção de um determinado dado do servidor através dos métodos GET, PUT ou DELETE, é necessário informar a PK (Primary Key), valor da chave primaria do alias do modelo, encodado em base64, caso contrário não informado, serão retornado os registros conforme sua paginação. |
a. GET
{
"id": "FINA460A",
"operation": 1,
"pk": "RCBNRyAwMSBEIE1HIDAxIDAwMDAwMDAwMDAwMDMyMTAwMDE=",
"models": [
{
"id": "MASTERFO0",
"modeltype": "FIELDS",
"fields": [
{
"id": "FO0_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "FO0_PROCES",
"order": 2,
"value": "000000000000321"
},
{
"id": "FO0_VERSAO",
"order": 3,
"value": "0001"
},
{
"id": "FO0_NUMLIQ",
"order": 4,
"value": "000208"
},
{
"id": "FO0_DATA",
"order": 5,
"value": "20240306"
},
{
"id": "FO0_DTVALI",
"order": 6,
"value": "20240306"
},
{
"id": "FO0_CLIENT",
"order": 11,
"value": "000001"
},
{
"id": "FO0_LOJA",
"order": 12,
"value": "01"
},
{
"id": "FO0_NATURE",
"order": 13,
"value": "001"
},
{
"id": "FO0_STATUS",
"order": 14,
"value": "4"
},
{
"id": "FO0_MOEDA",
"order": 15,
"value": "1"
},
{
"id": "FO0_BKPSTT",
"order": 16,
"value": "1"
},
{
"id": "FO0_ORIGEM",
"order": 17,
"value": "FINA460A"
},
{
"id": "FO0_VLRNEG",
"order": 24,
"value": "1000.00"
}
],
"models": [
{
"id": "TITSELFO1",
"modeltype": "GRID",
"struct": [
{
"id": "FO1_FILIAL",
"order": 1
},
{
"id": "FO1_PROCES",
"order": 2
},
{
"id": "FO1_VERSAO",
"order": 3
},
{
"id": "FO1_IDDOC",
"order": 4
},
{
"id": "FO1_SALDO",
"order": 5
},
{
"id": "FO1_TXJUR",
"order": 6
},
{
"id": "FO1_VLJUR",
"order": 7
},
{
"id": "FO1_TXMUL",
"order": 8
},
{
"id": "FO1_VLMUL",
"order": 9
},
{
"id": "FO1_DESCON",
"order": 10
},
{
"id": "FO1_ACRESC",
"order": 11
},
{
"id": "FO1_DECRES",
"order": 12
},
{
"id": "FO1_VLABT",
"order": 13
},
{
"id": "FO1_TOTAL",
"order": 14
},
{
"id": "FO1_MOEDA",
"order": 15
},
{
"id": "FO1_TXMOED",
"order": 16
},
{
"id": "FO1_FILORI",
"order": 17
},
{
"id": "FO1_VLDIA",
"order": 18
},
{
"id": "FO1_DESJUR",
"order": 19
},
{
"id": "FO1_VACESS",
"order": 20
},
{
"id": "FO1_VLADIC",
"order": 21
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FO1_FILIAL",
"value": "D MG 01"
},
{
"id": "FO1_PROCES",
"value": "000000000000321"
},
{
"id": "FO1_VERSAO",
"value": "0001"
},
{
"id": "FO1_IDDOC",
"value": "FA75DBDD09DC4E118E3DAC5AFCAD9E8A"
},
{
"id": "FO1_SALDO",
"value": "1000.00"
},
{
"id": "FO1_TOTAL",
"value": "1000.00"
},
{
"id": "FO1_MOEDA",
"value": "1"
},
{
"id": "FO1_TXMOED",
"value": "1.0000"
},
{
"id": "FO1_FILORI",
"value": "D MG 01"
}
]
}
]
},
{
"id": "TITGERFO2",
"modeltype": "GRID",
"struct": [
{
"id": "FO2_FILIAL",
"order": 1
},
{
"id": "FO2_PROCES",
"order": 2
},
{
"id": "FO2_VERSAO",
"order": 3
},
{
"id": "FO2_IDSIM",
"order": 4
},
{
"id": "FO2_PREFIX",
"order": 5
},
{
"id": "FO2_NUM",
"order": 6
},
{
"id": "FO2_PARCEL",
"order": 7
},
{
"id": "FO2_VENCTO",
"order": 8
},
{
"id": "FO2_VALOR",
"order": 9
},
{
"id": "FO2_TXJUR",
"order": 10
},
{
"id": "FO2_VLJUR",
"order": 11
},
{
"id": "FO2_ACRESC",
"order": 12
},
{
"id": "FO2_DECRES",
"order": 13
},
{
"id": "FO2_TOTAL",
"order": 14
},
{
"id": "FO2_BANCO",
"order": 15
},
{
"id": "FO2_AGENCI",
"order": 16
},
{
"id": "FO2_CONTA",
"order": 17
},
{
"id": "FO2_NUMCH",
"order": 18
},
{
"id": "FO2_EMITEN",
"order": 19
},
{
"id": "FO2_TIPO",
"order": 20
},
{
"id": "FO2_TXCALC",
"order": 21
},
{
"id": "FO2_VLRJUR",
"order": 22
},
{
"id": "FO2_VLPARC",
"order": 23
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FO2_FILIAL",
"value": "D MG 01"
},
{
"id": "FO2_PROCES",
"value": "000000000000321"
},
{
"id": "FO2_VERSAO",
"value": "0001"
},
{
"id": "FO2_IDSIM",
"value": "0656D1730ADC4E118E3DAC5AFCAD9E8A"
},
{
"id": "FO2_PREFIX",
"value": "LIQ"
},
{
"id": "FO2_NUM",
"value": "REST06"
},
{
"id": "FO2_PARCEL",
"value": "A"
},
{
"id": "FO2_VENCTO",
"value": "20240406"
},
{
"id": "FO2_VALOR",
"value": "1000.00"
},
{
"id": "FO2_TOTAL",
"value": "1000.00"
},
{
"id": "FO2_TIPO",
"value": "NF"
},
{
"id": "FO2_VLPARC",
"value": "1000.00"
}
]
}
]
}
]
}
]
} |
FWRestModel - API RESTful dos modelos de dados do Protheus
Integração do Easy Import Control via API REST