- Criado por Matheus Monteiro da Silva em 12 mar, 2024
CONTEÚDO
- Visão Geral
- Serviços Disponíveis
- Exemplo de utilização
- GET
- Assuntos Relacionados
01. VISÃO GERAL
Para clientes que possuem rotinas ou aplicativos customizados e precisam consultar as informações na rotina FINM030(Movimentação Bancaria Manual), foram disponibilizados métodos Web Service REST.
02. SERVIÇOS DISPONÍVEIS
| GET Consulta | POST | PUT Alteração | DELETE Exclusão |
 |  | | |
03. EXEMPLO DE UTILIZAÇÃ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
Retorno - Modelo Estrutura GET Expandir origem
{
"id": "FINM030",
"operation": 1,
"pk": "ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg",
"models": [
{
"id": "MASTER",
"modeltype": "FIELDS",
"fields": [],
"models": [
{
"id": "FKADETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FKA_FILIAL",
"order": 1
},
{
"id": "FKA_IDFKA",
"order": 2
},
{
"id": "FKA_IDPROC",
"order": 3
},
{
"id": "FKA_IDORIG",
"order": 4
},
{
"id": "FKA_TABORI",
"order": 5
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FKA_FILIAL",
"value": "D MG 01"
},
{
"id": "FKA_IDFKA",
"value": "b4d63761a95040008F89176ed85a41c8"
},
{
"id": "FKA_IDPROC",
"value": "00000000000000075375"
},
{
"id": "FKA_IDORIG",
"value": "0690414ea498400084500c086cf445cf"
},
{
"id": "FKA_TABORI",
"value": "FK5"
}
],
"models": [
{
"id": "FK5DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK5_FILIAL",
"order": 1
},
{
"id": "FK5_IDMOV",
"order": 2
},
{
"id": "FK5_DATA",
"order": 3
},
{
"id": "FK5_VALOR",
"order": 4
},
{
"id": "FK5_MOEDA",
"order": 5
},
{
"id": "FK5_NATURE",
"order": 6
},
{
"id": "FK5_RECPAG",
"order": 7
},
{
"id": "FK5_TPDOC",
"order": 8
},
{
"id": "FK5_FILORI",
"order": 9
},
{
"id": "FK5_ORIGEM",
"order": 10
},
{
"id": "FK5_BANCO",
"order": 11
},
{
"id": "FK5_AGENCI",
"order": 12
},
{
"id": "FK5_CONTA",
"order": 13
},
{
"id": "FK5_NUMCH",
"order": 14
},
{
"id": "FK5_DOC",
"order": 15
},
{
"id": "FK5_HISTOR",
"order": 16
},
{
"id": "FK5_VLMOE2",
"order": 17
},
{
"id": "FK5_DTCONC",
"order": 18
},
{
"id": "FK5_DTDISP",
"order": 19
},
{
"id": "FK5_MODSPB",
"order": 20
},
{
"id": "FK5_SEQCON",
"order": 21
},
{
"id": "FK5_TERCEI",
"order": 22
},
{
"id": "FK5_TPMOV",
"order": 23
},
{
"id": "FK5_OK",
"order": 24
},
{
"id": "FK5_STATUS",
"order": 25
},
{
"id": "FK5_RATEIO",
"order": 26
},
{
"id": "FK5_SEQ",
"order": 27
},
{
"id": "FK5_PROTRA",
"order": 28
},
{
"id": "FK5_CCUSTO",
"order": 29
},
{
"id": "FK5_NUMBOR",
"order": 30
},
{
"id": "FK5_LA",
"order": 31
},
{
"id": "FK5_TXMOED",
"order": 32
},
{
"id": "FK5_ORDREC",
"order": 33
},
{
"id": "FK5_LOTE",
"order": 34
},
{
"id": "FK5_IDDOC",
"order": 35
},
{
"id": "FK5_IDFK7",
"order": 36
},
{
"id": "FK5_CODBAR",
"order": 37
},
{
"id": "FK5_CODPIX",
"order": 38
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FK5_FILIAL",
"value": "D MG 01"
},
{
"id": "FK5_IDMOV",
"value": "0690414ea498400084500c086cf445cf"
},
{
"id": "FK5_DATA",
"value": "20210705"
},
{
"id": "FK5_VALOR",
"value": "5000.00"
},
{
"id": "FK5_MOEDA",
"value": "01"
},
{
"id": "FK5_NATURE",
"value": "PAGTO.EMPR"
},
{
"id": "FK5_RECPAG",
"value": "R"
},
{
"id": "FK5_TPDOC",
"value": "PE"
},
{
"id": "FK5_FILORI",
"value": "D MG 01"
},
{
"id": "FK5_ORIGEM",
"value": "FINA181"
},
{
"id": "FK5_BANCO",
"value": "FIN"
},
{
"id": "FK5_AGENCI",
"value": "200"
},
{
"id": "FK5_CONTA",
"value": "200002"
},
{
"id": "FK5_DOC",
"value": "FIN0200109"
},
{
"id": "FK5_HISTOR",
"value": "Est.Pagto Emprestimo EMP"
},
{
"id": "FK5_VLMOE2",
"value": "5000.00"
},
{
"id": "FK5_DTDISP",
"value": "20210705"
},
{
"id": "FK5_TERCEI",
"value": "2"
},
{
"id": "FK5_TPMOV",
"value": "1"
},
{
"id": "FK5_STATUS",
"value": "1"
},
{
"id": "FK5_RATEIO",
"value": "2"
},
{
"id": "FK5_LA",
"value": "S"
}
],
"models": [
{
"id": "FK8DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK8_FILIAL",
"order": 1
},
{
"id": "FK8_IDMOV",
"order": 2
},
{
"id": "FK8_TPLAN",
"order": 3
},
{
"id": "FK8_DEBITO",
"order": 4
},
{
"id": "FK8_CREDIT",
"order": 5
},
{
"id": "FK8_CCD",
"order": 6
},
{
"id": "FK8_CCC",
"order": 7
},
{
"id": "FK8_ARQRAT",
"order": 8
},
{
"id": "FK8_ITEMD",
"order": 9
},
{
"id": "FK8_ITEMC",
"order": 10
},
{
"id": "FK8_CLVLDB",
"order": 11
},
{
"id": "FK8_CLVLCR",
"order": 12
},
{
"id": "FK8_DIACTB",
"order": 13
},
{
"id": "FK8_NODIA",
"order": 14
},
{
"id": "FK8_EC05DB",
"order": 15
},
{
"id": "FK8_EC05CR",
"order": 16
},
{
"id": "FK8_EC06DB",
"order": 17
},
{
"id": "FK8_EC06CR",
"order": 18
},
{
"id": "FK8_EC07DB",
"order": 19
},
{
"id": "FK8_EC07CR",
"order": 20
},
{
"id": "FK8_EC08DB",
"order": 21
},
{
"id": "FK8_EC08CR",
"order": 22
},
{
"id": "FK8_EC09DB",
"order": 23
},
{
"id": "FK8_EC09CR",
"order": 24
}
]
},
{
"id": "FK9DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK9_FILIAL",
"order": 1
},
{
"id": "FK9_IDMOV",
"order": 2
},
{
"id": "FK9_SITUA",
"order": 3
},
{
"id": "FK9_PRJPMS",
"order": 4
},
{
"id": "FK9_EDTPMS",
"order": 5
},
{
"id": "FK9_TASPMS",
"order": 6
},
{
"id": "FK9_OPERAD",
"order": 7
},
{
"id": "FK9_NUMMOV",
"order": 8
},
{
"id": "FK9_FLDMED",
"order": 9
},
{
"id": "FK9_FORMPG",
"order": 10
}
]
},
{
"id": "FK3DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK3_FILIAL",
"order": 1
},
{
"id": "FK3_IDFK3",
"order": 2
},
{
"id": "FK3_DATA",
"order": 3
},
{
"id": "FK3_VALOR",
"order": 4
},
{
"id": "FK3_MOEDA",
"order": 5
},
{
"id": "FK3_NATURE",
"order": 6
},
{
"id": "FK3_RECPAG",
"order": 7
},
{
"id": "FK3_IDRET",
"order": 8
},
{
"id": "FK3_IMPOS",
"order": 9
},
{
"id": "FK3_FILORI",
"order": 10
},
{
"id": "FK3_BASIMP",
"order": 11
},
{
"id": "FK3_ORIGEM",
"order": 12
},
{
"id": "FK3_VLMOE2",
"order": 13
},
{
"id": "FK3_IDORIG",
"order": 14
},
{
"id": "FK3_TABORI",
"order": 15
},
{
"id": "FK3_STATUS",
"order": 16
},
{
"id": "FK3_CLIFOR",
"order": 17
},
{
"id": "FK3_LOJA",
"order": 18
},
{
"id": "FK3_CGC",
"order": 19
},
{
"id": "FK3_RAICGC",
"order": 20
},
{
"id": "FK3_CODFKM",
"order": 21
},
{
"id": "FK3_CODRET",
"order": 22
}
]
},
{
"id": "FK6DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK6_FILIAL",
"order": 1
},
{
"id": "FK6_IDFK6",
"order": 2
},
{
"id": "FK6_VALCAL",
"order": 3
},
{
"id": "FK6_VALMOV",
"order": 4
},
{
"id": "FK6_TPDESC",
"order": 5
},
{
"id": "FK6_RECPAG",
"order": 6
},
{
"id": "FK6_TPDOC",
"order": 7
},
{
"id": "FK6_IDORIG",
"order": 8
},
{
"id": "FK6_TABORI",
"order": 9
},
{
"id": "FK6_HISTOR",
"order": 10
},
{
"id": "FK6_CODVAL",
"order": 11
},
{
"id": "FK6_ACAO",
"order": 12
},
{
"id": "FK6_IDFKD",
"order": 13
},
{
"id": "FK6_DATA",
"order": 14
},
{
"id": "FK6_MOEDA",
"order": 15
},
{
"id": "FK6_VLMOE2",
"order": 16
},
{
"id": "FK6_TXMOED",
"order": 17
},
{
"id": "FK6_LA",
"order": 18
},
{
"id": "FK6_ORIGEM",
"order": 19
}
]
}
]
}
]
}
]
},
{
"id": 2,
"deleted": 0,
"fields": [
{
"id": "FKA_FILIAL",
"value": "D MG 01"
},
{
"id": "FKA_IDFKA",
"value": "17b0d936bcba4000817Baf1067428850"
},
{
"id": "FKA_IDPROC",
"value": "00000000000000075375"
},
{
"id": "FKA_IDORIG",
"value": "6290620ca89e4000933Fbc3e282e9522"
},
{
"id": "FKA_TABORI",
"value": "FK5"
}
],
"models": [
{
"id": "FK5DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK5_FILIAL",
"order": 1
},
{
"id": "FK5_IDMOV",
"order": 2
},
{
"id": "FK5_DATA",
"order": 3
},
{
"id": "FK5_VALOR",
"order": 4
},
{
"id": "FK5_MOEDA",
"order": 5
},
{
"id": "FK5_NATURE",
"order": 6
},
{
"id": "FK5_RECPAG",
"order": 7
},
{
"id": "FK5_TPDOC",
"order": 8
},
{
"id": "FK5_FILORI",
"order": 9
},
{
"id": "FK5_ORIGEM",
"order": 10
},
{
"id": "FK5_BANCO",
"order": 11
},
{
"id": "FK5_AGENCI",
"order": 12
},
{
"id": "FK5_CONTA",
"order": 13
},
{
"id": "FK5_NUMCH",
"order": 14
},
{
"id": "FK5_DOC",
"order": 15
},
{
"id": "FK5_HISTOR",
"order": 16
},
{
"id": "FK5_VLMOE2",
"order": 17
},
{
"id": "FK5_DTCONC",
"order": 18
},
{
"id": "FK5_DTDISP",
"order": 19
},
{
"id": "FK5_MODSPB",
"order": 20
},
{
"id": "FK5_SEQCON",
"order": 21
},
{
"id": "FK5_TERCEI",
"order": 22
},
{
"id": "FK5_TPMOV",
"order": 23
},
{
"id": "FK5_OK",
"order": 24
},
{
"id": "FK5_STATUS",
"order": 25
},
{
"id": "FK5_RATEIO",
"order": 26
},
{
"id": "FK5_SEQ",
"order": 27
},
{
"id": "FK5_PROTRA",
"order": 28
},
{
"id": "FK5_CCUSTO",
"order": 29
},
{
"id": "FK5_NUMBOR",
"order": 30
},
{
"id": "FK5_LA",
"order": 31
},
{
"id": "FK5_TXMOED",
"order": 32
},
{
"id": "FK5_ORDREC",
"order": 33
},
{
"id": "FK5_LOTE",
"order": 34
},
{
"id": "FK5_IDDOC",
"order": 35
},
{
"id": "FK5_IDFK7",
"order": 36
},
{
"id": "FK5_CODBAR",
"order": 37
},
{
"id": "FK5_CODPIX",
"order": 38
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "FK5_FILIAL",
"value": "D MG 01"
},
{
"id": "FK5_IDMOV",
"value": "6290620ca89e4000933Fbc3e282e9522"
},
{
"id": "FK5_DATA",
"value": "20210705"
},
{
"id": "FK5_VALOR",
"value": "5000.00"
},
{
"id": "FK5_MOEDA",
"value": "01"
},
{
"id": "FK5_NATURE",
"value": "PAGTO.EMPR"
},
{
"id": "FK5_RECPAG",
"value": "R"
},
{
"id": "FK5_TPDOC",
"value": "PE"
},
{
"id": "FK5_FILORI",
"value": "D MG 01"
},
{
"id": "FK5_ORIGEM",
"value": "FINA181"
},
{
"id": "FK5_BANCO",
"value": "FIN"
},
{
"id": "FK5_AGENCI",
"value": "200"
},
{
"id": "FK5_CONTA",
"value": "200002"
},
{
"id": "FK5_DOC",
"value": "FIN0200113"
},
{
"id": "FK5_HISTOR",
"value": "Est.Pagto Emprestimo EMP"
},
{
"id": "FK5_VLMOE2",
"value": "5000.00"
},
{
"id": "FK5_DTDISP",
"value": "20210705"
},
{
"id": "FK5_TERCEI",
"value": "2"
},
{
"id": "FK5_TPMOV",
"value": "1"
},
{
"id": "FK5_STATUS",
"value": "1"
},
{
"id": "FK5_RATEIO",
"value": "2"
},
{
"id": "FK5_LA",
"value": "S"
}
],
"models": [
{
"id": "FK8DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK8_FILIAL",
"order": 1
},
{
"id": "FK8_IDMOV",
"order": 2
},
{
"id": "FK8_TPLAN",
"order": 3
},
{
"id": "FK8_DEBITO",
"order": 4
},
{
"id": "FK8_CREDIT",
"order": 5
},
{
"id": "FK8_CCD",
"order": 6
},
{
"id": "FK8_CCC",
"order": 7
},
{
"id": "FK8_ARQRAT",
"order": 8
},
{
"id": "FK8_ITEMD",
"order": 9
},
{
"id": "FK8_ITEMC",
"order": 10
},
{
"id": "FK8_CLVLDB",
"order": 11
},
{
"id": "FK8_CLVLCR",
"order": 12
},
{
"id": "FK8_DIACTB",
"order": 13
},
{
"id": "FK8_NODIA",
"order": 14
},
{
"id": "FK8_EC05DB",
"order": 15
},
{
"id": "FK8_EC05CR",
"order": 16
},
{
"id": "FK8_EC06DB",
"order": 17
},
{
"id": "FK8_EC06CR",
"order": 18
},
{
"id": "FK8_EC07DB",
"order": 19
},
{
"id": "FK8_EC07CR",
"order": 20
},
{
"id": "FK8_EC08DB",
"order": 21
},
{
"id": "FK8_EC08CR",
"order": 22
},
{
"id": "FK8_EC09DB",
"order": 23
},
{
"id": "FK8_EC09CR",
"order": 24
}
]
},
{
"id": "FK9DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK9_FILIAL",
"order": 1
},
{
"id": "FK9_IDMOV",
"order": 2
},
{
"id": "FK9_SITUA",
"order": 3
},
{
"id": "FK9_PRJPMS",
"order": 4
},
{
"id": "FK9_EDTPMS",
"order": 5
},
{
"id": "FK9_TASPMS",
"order": 6
},
{
"id": "FK9_OPERAD",
"order": 7
},
{
"id": "FK9_NUMMOV",
"order": 8
},
{
"id": "FK9_FLDMED",
"order": 9
},
{
"id": "FK9_FORMPG",
"order": 10
}
]
},
{
"id": "FK3DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK3_FILIAL",
"order": 1
},
{
"id": "FK3_IDFK3",
"order": 2
},
{
"id": "FK3_DATA",
"order": 3
},
{
"id": "FK3_VALOR",
"order": 4
},
{
"id": "FK3_MOEDA",
"order": 5
},
{
"id": "FK3_NATURE",
"order": 6
},
{
"id": "FK3_RECPAG",
"order": 7
},
{
"id": "FK3_IDRET",
"order": 8
},
{
"id": "FK3_IMPOS",
"order": 9
},
{
"id": "FK3_FILORI",
"order": 10
},
{
"id": "FK3_BASIMP",
"order": 11
},
{
"id": "FK3_ORIGEM",
"order": 12
},
{
"id": "FK3_VLMOE2",
"order": 13
},
{
"id": "FK3_IDORIG",
"order": 14
},
{
"id": "FK3_TABORI",
"order": 15
},
{
"id": "FK3_STATUS",
"order": 16
},
{
"id": "FK3_CLIFOR",
"order": 17
},
{
"id": "FK3_LOJA",
"order": 18
},
{
"id": "FK3_CGC",
"order": 19
},
{
"id": "FK3_RAICGC",
"order": 20
},
{
"id": "FK3_CODFKM",
"order": 21
},
{
"id": "FK3_CODRET",
"order": 22
}
]
},
{
"id": "FK6DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK6_FILIAL",
"order": 1
},
{
"id": "FK6_IDFK6",
"order": 2
},
{
"id": "FK6_VALCAL",
"order": 3
},
{
"id": "FK6_VALMOV",
"order": 4
},
{
"id": "FK6_TPDESC",
"order": 5
},
{
"id": "FK6_RECPAG",
"order": 6
},
{
"id": "FK6_TPDOC",
"order": 7
},
{
"id": "FK6_IDORIG",
"order": 8
},
{
"id": "FK6_TABORI",
"order": 9
},
{
"id": "FK6_HISTOR",
"order": 10
},
{
"id": "FK6_CODVAL",
"order": 11
},
{
"id": "FK6_ACAO",
"order": 12
},
{
"id": "FK6_IDFKD",
"order": 13
},
{
"id": "FK6_DATA",
"order": 14
},
{
"id": "FK6_MOEDA",
"order": 15
},
{
"id": "FK6_VLMOE2",
"order": 16
},
{
"id": "FK6_TXMOED",
"order": 17
},
{
"id": "FK6_LA",
"order": 18
},
{
"id": "FK6_ORIGEM",
"order": 19
}
]
}
]
}
]
}
]
},
{
"id": 3,
"deleted": 0,
"fields": [
{
"id": "FKA_FILIAL",
"value": "D MG 01"
},
{
"id": "FKA_IDFKA",
"value": "11b7eaf5026a40009000b456ca0a74bb"
},
{
"id": "FKA_IDPROC",
"value": "00000000000000075375"
},
{
"id": "FKA_IDORIG",
"value": "d87ddd3c6b99400082F700c8adb0cd43"
},
{
"id": "FKA_TABORI",
"value": "FK1"
}
],
"models": [
{
"id": "FK5DETAIL",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "FK5_FILIAL",
"order": 1
},
{
"id": "FK5_IDMOV",
"order": 2
},
{
"id": "FK5_DATA",
"order": 3
},
{
"id": "FK5_VALOR",
"order": 4
},
{
"id": "FK5_MOEDA",
"order": 5
},
{
"id": "FK5_NATURE",
"order": 6
},
{
"id": "FK5_RECPAG",
"order": 7
},
{
"id": "FK5_TPDOC",
"order": 8
},
{
"id": "FK5_FILORI",
"order": 9
},
{
"id": "FK5_ORIGEM",
"order": 10
},
{
"id": "FK5_BANCO",
"order": 11
},
{
"id": "FK5_AGENCI",
"order": 12
},
{
"id": "FK5_CONTA",
"order": 13
},
{
"id": "FK5_NUMCH",
"order": 14
},
{
"id": "FK5_DOC",
"order": 15
},
{
"id": "FK5_HISTOR",
"order": 16
},
{
"id": "FK5_VLMOE2",
"order": 17
},
{
"id": "FK5_DTCONC",
"order": 18
},
{
"id": "FK5_DTDISP",
"order": 19
},
{
"id": "FK5_MODSPB",
"order": 20
},
{
"id": "FK5_SEQCON",
"order": 21
},
{
"id": "FK5_TERCEI",
"order": 22
},
{
"id": "FK5_TPMOV",
"order": 23
},
{
"id": "FK5_OK",
"order": 24
},
{
"id": "FK5_STATUS",
"order": 25
},
{
"id": "FK5_RATEIO",
"order": 26
},
{
"id": "FK5_SEQ",
"order": 27
},
{
"id": "FK5_PROTRA",
"order": 28
},
{
"id": "FK5_CCUSTO",
"order": 29
},
{
"id": "FK5_NUMBOR",
"order": 30
},
{
"id": "FK5_LA",
"order": 31
},
{
"id": "FK5_TXMOED",
"order": 32
},
{
"id": "FK5_ORDREC",
"order": 33
},
{
"id": "FK5_LOTE",
"order": 34
},
{
"id": "FK5_IDDOC",
"order": 35
},
{
"id": "FK5_IDFK7",
"order": 36
},
{
"id": "FK5_CODBAR",
"order": 37
},
{
"id": "FK5_CODPIX",
"order": 38
}
]
}
]
}
]
}
]
}
]
}
04. ASSUNTOS RELACIONADOS
FWRestModel - API RESTful dos modelos de dados do Protheus
Integração do Easy Import Control via API REST
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas