Histórico da Página
- Created and last modified by Alessandro Figueiredo on Nov 26,2015
Esta entidade realiza movimentação bancária e suporta as seguintes operações: POST, GET, PUT, DELETE
Campos do retorno
Nome
Descrição
Tipo
Tamanho do campo
Mais detalhes
Id
Id
C
14
accountReceivableId
Contas a Receber
C
Variável
accountPayableId
Contas a Pagar
C
Variável
code
Numero do Titulo
C
9
installment
Parcela
C
2
Type
Tipo
C
1
personId
Codigo da Pessoa
C
6
series
Serie da Nota
C
3
branchOrigin
Filial de Origem
C
4
date
Data da Movimentacao
D
8
category
Categoria
C
10
historic
Historico
C
120
value
Valor
N
17,2
bankId
Id
C
Variável
bankCode
Codigo do Banco
C
3
...
agency
Agencia do banco
C
5
...
account
Conta Corrente no banco
C
10
document
Numero do cheque
C
15
creditDate
Data Crédito
D
8
documentClearing
Documento
C
25
operationType
Recebimento ou Pagamento
C
1
Exemplo de inclusão de registros
Para adicionar um novo registro deve-se usar o método de POST, e no campo de requisição informar os campos necessários para inclusão.
first/api/v1/BankTransac
Body:
{
"operationType": "R",
"date": "
...
20151224",
"category": "010101",
"historic": "TESTE",
"value": 100,
"bankId": "
...
MDAxLDE2MzcsNDkzNDg=",
"
...
branchOrigin": "01",
"releaseCode": "",
"creditMoveDate": "
...
20151224"
}
Retorno:
{
"url": "/first/api/v1/banktransac/
...
00000000021924",
"id": "
...
00000000021924"
}
Exemplo de obtenção de informações para todos registros
first/api/v1/BankTransac
{
"total":
...
20880,
"hasNext": true,
"syncing": false,
"lines": [
{
"id": "00000000000001",
"accountReceivableId": null,
"accountPayableId": "U04sLDMsMDAwMTYxLA==",
"code": "SN",
"installment": "",
"type": "3",
"personId": "000161",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "010301",
...
"historic": "DEPÓSITO COMPE",
"value": 251.32,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "R"
},
{
"id": "00000000000002",
"accountReceivableId": null,
"accountPayableId": "",
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "0101",
"historic": "COBRANÇA",
"value": 4187.95,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "R"
},
{
"id": "00000000000003",
"accountReceivableId": "ODUwMDQ2LCw3LDAwMDAwMyw=",
"accountPayableId": null,
"code": "850046",
"installment": "",
"type": "7",
"personId": "000003",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "020201",
"historic": "CHEQUE PAGO OUTRA AGÊNCIA",
"value": 2908.96,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000004",
"accountReceivableId": "",
"accountPayableId": null,
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "020602",
"historic": "IMPOSTOS",
"value": 1033.62,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000005",
"accountReceivableId": "",
"accountPayableId": null,
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "020305",
"historic": "DÉBITO SERVIÇO COBRANÇA",
"value": 15,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000006",
"accountReceivableId": "",
"accountPayableId": null,
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120906",
"category": "020305",
"historic": "DÉBITO SERVIÇO COBRANÇA",
"value": 11.25,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000007",
"accountReceivableId": "",
"accountPayableId": null,
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120906",
...
"category": "020107",
"historic": "CHEQUE COMPENSADO",
"value": 2790,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120906",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000008",
"accountReceivableId": "ODUwMDQ4LCw3LDAwMDAwNCw=",
"accountPayableId": null,
"code": "850048",
"installment": "",
"type": "7",
"personId": "000004",
"series": "",
"branchOrigin": "01",
"date": "20120910",
"category": "020201",
"historic": "CHEQUE PAGO OUTRA AGÊNCIA",
"value": 1929.6,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120910",
"documentClearing": "",
"operationType": "P"
},
{
"id": "00000000000009",
"accountReceivableId": null,
"accountPayableId": "",
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120910",
...
"category": "010101",
"historic": "COBRANÇA",
"value": 7460.27,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120910",
"documentClearing": "",
"operationType": "R"
},
{
"id": "00000000000010",
"accountReceivableId": "",
"accountPayableId": null,
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "20120910",
"category": "020705",
"historic": "SAQUE NO TAA",
"value": 60,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "20120910",
"documentClearing": "",
"operationType": "P"
}
]
}
Exemplo de obtenção de informações específicas sobre um registro usando ID como chave
localhost:8085/first/api/v1/BankTransac/
...
00000000021925
{
"id": "
...
00000000021925",
"accountReceivableId": null,
"accountPayableId": "",
"code": "",
"installment": "",
"type": "",
"personId": "",
"series": "",
"branchOrigin": "01",
"date": "
...
20151224",
"category": "010101",
"historic": "TESTE
...
",
"value": 100,
"bankId": "MDAxLDE2MzcsNDkzNDg=",
"bankCode": "001",
"
...
agency": "1637",
"
...
account": "49348",
"document": "",
"creditDate": "
...
20151224",
"documentClearing": "",
"operationType": "R"
}
Exemplo de alteração de registros
Para a alteração basta mudar o método para PUT e então realizar o procedimento abaixo
localhost:8085/first/api/v1/BankTransac/
...
/00000000021925
Body:
{
"historic": "teste UPDATE"
}
Retorno:
{
"url": "/first/api/v1/banktransac/
...
00000000021925",
"id": "
...
00000000021925"
}
Exemplo de exclusão de registros
Para excluir um registro deve-se usar o método de DELETE, e informar o registro que deve ser excluído, via URL
localhost:8085/first/api/v1/BankTransac/
...
00000000021925
Retorno:
{
"url": "/first/api/v1/banktransac/
...
00000000021925",
"id": "
...
00000000021925"
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas