API de Pagamentos - Método GET
- URL:
http://localhost:8080/rest/fwmodel/TAFA535/ - Método:
GET - Descrição: Este endpoint retorna uma lista dos Pagamentos.
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do GET
{
"total": 1,
"count": 1,
"startindex": 1,
"resources": [
{
"id": "TAFA535",
"operation": 1,
"pk": "RCBNRyAwMSBEIE1HIDAxIFBHVE80MDIwMDEgICAgIDEyMyAgODczODg5M2UtMjM3NS0wZDI1LWQxZTItOGUxOTQ5NTlhNzhhMjAyMzA0MDEwICAgMjAyMzA0MDEwMSA=",
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_ID",
"order": 2,
"value": "d91034e5-0b16-cea6-918e-6403326b9457"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTO402001"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_IDPART",
"order": 7,
"value": "8738893e-2375-0d25-d1e2-8e194959a78a"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
]
}
]
}
]
}
API de Pagamentos - GET [pk]
- URL:
http://localhost:8080/rest/fwmodel/TAFA535/RCBNRyAwMSBQR1RPNDAyMDAxICAgICAxMjMgIDg3Mzg4OTNlLTIzNzUtMGQyNS1kMWUyLThlMTk0OTU5YTc4YTIwMjMwNDAxMCAgIDIwMjMwNDAxMDEg - Método:
GET[id] - Descrição: Este endpoint retorna um pagamento filtrado pela PK.
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do GET por PK
{
"id": "TAFA535",
"operation": 1,
"pk": "RCBNRyAwMSBQR1RPNDAyMDAxICAgICAxMjMgIDg3Mzg4OTNlLTIzNzUtMGQyNS1kMWUyLThlMTk0OTU5YTc4YTIwMjMwNDAxMCAgIDIwMjMwNDAxMDEg",
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_ID",
"order": 2,
"value": "d91034e5-0b16-cea6-918e-6403326b9457"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTO402001"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_IDPART",
"order": 7,
"value": "8738893e-2375-0d25-d1e2-8e194959a78a"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
],
"models": [
{
"id": "MODEL_V3V",
"modeltype": "GRID",
"struct": [
{
"id": "V3V_FILIAL",
"order": 1
},
{
"id": "V3V_ID",
"order": 2
},
{
"id": "V3V_CNATRE",
"order": 4
},
{
"id": "V3V_VALOR",
"order": 5
},
{
"id": "V3V_DECTER",
"order": 6
},
{
"id": "V3V_IDPROC",
"order": 10
},
{
"id": "V3V_IFCISC",
"order": 12
},
{
"id": "V3V_COMPFP",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "V3V_FILIAL",
"value": "D MG 01"
},
{
"id": "V3V_ID",
"value": "d91034e5-0b16-cea6-918e-6403326b9457"
},
{
"id": "V3V_CNATRE",
"value": "000016"
},
{
"id": "V3V_VALOR",
"value": "10000.00"
},
{
"id": "V3V_DECTER",
"value": "2"
}
],
"models": [
{
"id": "MODEL_V46",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V46_FILIAL",
"order": 1
},
{
"id": "V46_ID",
"order": 2
},
{
"id": "V46_IDNAT",
"order": 3
},
{
"id": "V46_IDTRIB",
"order": 4
},
{
"id": "V46_BASE",
"order": 6
},
{
"id": "V46_VALOR",
"order": 7
},
{
"id": "V46_ALIQ",
"order": 8
}
]
},
{
"id": "MODEL_V4H",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V4H_FILIAL",
"order": 1
},
{
"id": "V4H_ID",
"order": 2
},
{
"id": "V4H_IDPROC",
"order": 3
},
{
"id": "V4H_IDSUSP",
"order": 6
},
{
"id": "V4H_IDTRIB",
"order": 7
},
{
"id": "V4H_VALSUS",
"order": 9
},
{
"id": "V4H_VBASSU",
"order": 10
},
{
"id": "V4H_VLRANO",
"order": 11
},
{
"id": "V4H_VLRANA",
"order": 12
}
]
}
]
}
]
}
]
}
]
}
API de Cadastro de Pagamentos - Metodo POST
- URL:
http://localhost:8080/rest/fwmodel/TAFA535/ - Método:
POST - Descrição: Este endpoint inclui um pagamento no sistema.
Observação
Para o POST de um pagamento, seguiremos a mesma abordagem dos métodos das API's anteriores.
Removendo a PK do body e tratando os campos de controle interno do TAF (id).
Exemplo de Envio Esperado
JSON - Exemplo de envio do POST
{
"id": "TAFA535",
"operation": 1,
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTOTESTE2"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
],
"models": [
{
"id": "MODEL_V3V",
"modeltype": "GRID",
"struct": [
{
"id": "V3V_FILIAL",
"order": 1
},
{
"id": "V3V_ID",
"order": 2
},
{
"id": "V3V_CNATRE",
"order": 4
},
{
"id": "V3V_VALOR",
"order": 5
},
{
"id": "V3V_DECTER",
"order": 6
},
{
"id": "V3V_IDPROC",
"order": 10
},
{
"id": "V3V_IFCISC",
"order": 12
},
{
"id": "V3V_COMPFP",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "V3V_FILIAL",
"value": "D MG 01"
},
{
"id": "V3V_CNATRE",
"value": "000016"
},
{
"id": "V3V_VALOR",
"value": "10000.00"
},
{
"id": "V3V_DECTER",
"value": "2"
}
],
"models": [
{
"id": "MODEL_V46",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V46_FILIAL",
"order": 1
},
{
"id": "V46_ID",
"order": 2
},
{
"id": "V46_IDNAT",
"order": 3
},
{
"id": "V46_IDTRIB",
"order": 4
},
{
"id": "V46_BASE",
"order": 6
},
{
"id": "V46_VALOR",
"order": 7
},
{
"id": "V46_ALIQ",
"order": 8
}
]
},
{
"id": "MODEL_V4H",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V4H_FILIAL",
"order": 1
},
{
"id": "V4H_ID",
"order": 2
},
{
"id": "V4H_IDPROC",
"order": 3
},
{
"id": "V4H_IDSUSP",
"order": 6
},
{
"id": "V4H_IDTRIB",
"order": 7
},
{
"id": "V4H_VALSUS",
"order": 9
},
{
"id": "V4H_VBASSU",
"order": 10
},
{
"id": "V4H_VLRANO",
"order": 11
},
{
"id": "V4H_VLRANA",
"order": 12
}
]
}
]
}
]
}
]
}
]
}
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do POST
{
"id": "TAFA535",
"operation": 1,
"pk": "RCBNRyAwMSBEIE1HIDAxIFBHVE9URVNURTIgICAgIDEyMyAgODczODg5M2UtMjM3NS0wZDI1LWQxZTItOGUxOTQ5NTlhNzhhMjAyMzA0MDEwICAgMjAyMzA0MDEwMSA=",
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_ID",
"order": 2,
"value": "695d6002-7f12-1016-cfab-551d46ce3539"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTOTESTE2"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_IDPART",
"order": 7,
"value": "8738893e-2375-0d25-d1e2-8e194959a78a"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
],
"models": [
{
"id": "MODEL_V3V",
"modeltype": "GRID",
"struct": [
{
"id": "V3V_FILIAL",
"order": 1
},
{
"id": "V3V_ID",
"order": 2
},
{
"id": "V3V_CNATRE",
"order": 4
},
{
"id": "V3V_VALOR",
"order": 5
},
{
"id": "V3V_DECTER",
"order": 6
},
{
"id": "V3V_IDPROC",
"order": 10
},
{
"id": "V3V_IFCISC",
"order": 12
},
{
"id": "V3V_COMPFP",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "V3V_FILIAL",
"value": "D MG 01"
},
{
"id": "V3V_ID",
"value": "695d6002-7f12-1016-cfab-551d46ce3539"
},
{
"id": "V3V_CNATRE",
"value": "000001"
},
{
"id": "V3V_VALOR",
"value": "10000.00"
},
{
"id": "V3V_DECTER",
"value": "2"
}
],
"models": [
{
"id": "MODEL_V46",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V46_FILIAL",
"order": 1
},
{
"id": "V46_ID",
"order": 2
},
{
"id": "V46_IDNAT",
"order": 3
},
{
"id": "V46_IDTRIB",
"order": 4
},
{
"id": "V46_BASE",
"order": 6
},
{
"id": "V46_VALOR",
"order": 7
},
{
"id": "V46_ALIQ",
"order": 8
}
]
},
{
"id": "MODEL_V4H",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V4H_FILIAL",
"order": 1
},
{
"id": "V4H_ID",
"order": 2
},
{
"id": "V4H_IDPROC",
"order": 3
},
{
"id": "V4H_IDSUSP",
"order": 6
},
{
"id": "V4H_IDTRIB",
"order": 7
},
{
"id": "V4H_VALSUS",
"order": 9
},
{
"id": "V4H_VBASSU",
"order": 10
},
{
"id": "V4H_VLRANO",
"order": 11
},
{
"id": "V4H_VLRANA",
"order": 12
}
]
}
]
}
]
}
]
}
]
}
API de Cadastro de Pagamentos
- URL:
http://localhost:8080/rest/fwmodel/TAFA535/RCBNRyAwMSBQR1RPLVBVVCAgICAgICAxMjMgIDg3Mzg4OTNlLTIzNzUtMGQyNS1kMWUyLThlMTk0OTU5YTc4YTIwMjMwNDAxMCAgIDIwMjMwNDAxMDEg - Método:
PUT[id] - Descrição: Este endpoint Altera um pagamento.
JSON - Exemplo de envio do PUT
{
"id": "TAFA535",
"operation": 1,
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTO-PUT"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
],
"models": [
{
"id": "MODEL_V3V",
"modeltype": "GRID",
"struct": [
{
"id": "V3V_FILIAL",
"order": 1
},
{
"id": "V3V_ID",
"order": 2
},
{
"id": "V3V_CNATRE",
"order": 4
},
{
"id": "V3V_VALOR",
"order": 5
},
{
"id": "V3V_DECTER",
"order": 6
},
{
"id": "V3V_IDPROC",
"order": 10
},
{
"id": "V3V_IFCISC",
"order": 12
},
{
"id": "V3V_COMPFP",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "V3V_FILIAL",
"value": "D MG 01"
},
{
"id": "V3V_CNATRE",
"value": "000016"
},
{
"id": "V3V_VALOR",
"value": "10000.00"
},
{
"id": "V3V_DECTER",
"value": "2"
}
],
"models": [
{
"id": "MODEL_V46",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V46_FILIAL",
"order": 1
},
{
"id": "V46_ID",
"order": 2
},
{
"id": "V46_IDNAT",
"order": 3
},
{
"id": "V46_IDTRIB",
"order": 4
},
{
"id": "V46_BASE",
"order": 6
},
{
"id": "V46_VALOR",
"order": 7
},
{
"id": "V46_ALIQ",
"order": 8
}
]
},
{
"id": "MODEL_V4H",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V4H_FILIAL",
"order": 1
},
{
"id": "V4H_ID",
"order": 2
},
{
"id": "V4H_IDPROC",
"order": 3
},
{
"id": "V4H_IDSUSP",
"order": 6
},
{
"id": "V4H_IDTRIB",
"order": 7
},
{
"id": "V4H_VALSUS",
"order": 9
},
{
"id": "V4H_VBASSU",
"order": 10
},
{
"id": "V4H_VLRANO",
"order": 11
},
{
"id": "V4H_VLRANA",
"order": 12
}
]
}
]
}
]
}
]
}
]
}
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do PUT
{
"id": "TAFA535",
"operation": 1,
"models": [
{
"id": "MODEL_V3U",
"modeltype": "FIELDS",
"fields": [
{
"id": "V3U_FILIAL",
"order": 1,
"value": "D MG 01"
},
{
"id": "V3U_NUMERO",
"order": 3,
"value": "PGTO-PUT"
},
{
"id": "V3U_SERIE",
"order": 4,
"value": "123"
},
{
"id": "V3U_CODPAR",
"order": 5,
"value": "FF4020101"
},
{
"id": "V3U_DTEMIS",
"order": 8,
"value": "20230401"
},
{
"id": "V3U_NATTIT",
"order": 9,
"value": "0"
},
{
"id": "V3U_DTPAGT",
"order": 11,
"value": "20230401"
},
{
"id": "V3U_SEQUEN",
"order": 12,
"value": "01"
}
],
"models": [
{
"id": "MODEL_V3V",
"modeltype": "GRID",
"struct": [
{
"id": "V3V_FILIAL",
"order": 1
},
{
"id": "V3V_ID",
"order": 2
},
{
"id": "V3V_CNATRE",
"order": 4
},
{
"id": "V3V_VALOR",
"order": 5
},
{
"id": "V3V_DECTER",
"order": 6
},
{
"id": "V3V_IDPROC",
"order": 10
},
{
"id": "V3V_IFCISC",
"order": 12
},
{
"id": "V3V_COMPFP",
"order": 13
}
],
"items": [
{
"id": 1,
"deleted": 0,
"fields": [
{
"id": "V3V_FILIAL",
"value": "D MG 01"
},
{
"id": "V3V_CNATRE",
"value": "000016"
},
{
"id": "V3V_VALOR",
"value": "10000.00"
},
{
"id": "V3V_DECTER",
"value": "2"
}
],
"models": [
{
"id": "MODEL_V46",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V46_FILIAL",
"order": 1
},
{
"id": "V46_ID",
"order": 2
},
{
"id": "V46_IDNAT",
"order": 3
},
{
"id": "V46_IDTRIB",
"order": 4
},
{
"id": "V46_BASE",
"order": 6
},
{
"id": "V46_VALOR",
"order": 7
},
{
"id": "V46_ALIQ",
"order": 8
}
]
},
{
"id": "MODEL_V4H",
"modeltype": "GRID",
"optional": 1,
"struct": [
{
"id": "V4H_FILIAL",
"order": 1
},
{
"id": "V4H_ID",
"order": 2
},
{
"id": "V4H_IDPROC",
"order": 3
},
{
"id": "V4H_IDSUSP",
"order": 6
},
{
"id": "V4H_IDTRIB",
"order": 7
},
{
"id": "V4H_VALSUS",
"order": 9
},
{
"id": "V4H_VBASSU",
"order": 10
},
{
"id": "V4H_VLRANO",
"order": 11
},
{
"id": "V4H_VLRANA",
"order": 12
}
]
}
]
}
]
}
]
}
]
}
API de Pagamentos - Método DELETE
- URL:
http://localhost:8080/rest/fwmodel/TAFA535/RCBNRyAwMSBQR1RPLVBVVCAgICAgICAxMjMgIDg3Mzg4OTNlLTIzNzUtMGQyNS1kMWUyLThlMTk0OTU5YTc4YTIwMjMwNDAxMCAgIDIwMjMwNDAxMDEg - Método:
DELETE - Descrição: Este endpoint deleta um pagamento
Exemplo de Resposta em Caso de Sucesso
JSON - Exemplo de resposta do DELETE
true
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas