Adicionar, editar e excluir pagamentos no Finmap via API

ㅤ Hora de ler o material – 8 minutos
ㅤFinmap
ㅤ

Adicionando pagamentos via API ➕

ㅤ
Através da API é possível adicionar os seguintes pagamentos:

Custos
Renda
Transferências

ㅤ
ㅤ
Para adicionar um pagamento através da API, você deve:

ㅤ

1. Acesse a documentação da API https://api.finmap.online/

2. Faça login com uma chave API

3. Selecione o tipo de pagamento que deseja adicionar. Esses tipos incluem:

operations/income
operations/expense
operations/transfer

ㅤ

4. Clique no parâmetro POST

5. Insira os dados necessários antes do pagamento

6. Clique para concluir a solicitação

ㅤ
ㅤ✅ Como resultado, um novo pagamento será adicionado ao serviço Finmap
ㅤ

Parâmetros que podem estar contidos na operação:
ㅤ

“date” – Data de realização do pagamento
“amount” – Quantia do pagamento
“comment” – Comentário
“amountInCompanyCurrency” – Quantia na moeda da empresa (este parâmetro é útil se você realizar uma operação em uma conta cuja moeda é diferente da moeda da empresa)
“exchangeRate” – Taxa de câmbio
“transactionSum” – Quantia do pagamento
“transactionCurrency” – Moeda de realização do pagamento
“transactionCurrencyRate” – Taxa de câmbio da moeda
“dateOfPayment” – Data de contabilização do pagamento
“startDate” – Início do período de contabilização do pagamento
“endDate” – Fim do período de contabilização do pagamento
“accountToId” – ID da conta
“categoryId” – ID da categoria
“counterpartyId” – ID do contratante
“projectId” – ID do projeto
“tagIds” – IDs de tags (é possível adicionar vários IDs de tags de uma só vez)
“externalId” – ID da operação (definido manualmente para que posteriormente você possa editar ou excluir o pagamento usando este ID)

ㅤㅤ
ㅤ
ㅤ❗ Não é necessário utilizar todos os parâmetros para adicionar um pagamento.

ㅤ❗❗ Importante: Nosso serviço funciona no fuso horário UTC 0, se você precisar especificar um fuso horário diferente, o parâmetro offset ajudará.
Observe que o parâmetro date deve ser especificado no formato UNIX (milissegundos).
Exemplo de “data”: 1717158515050

ㅤ

ㅤ
ㅤ

Editando pagamentos via API ⚙️

ㅤ
Através da API é possível editar os seguintes pagamentos:

Custos
Renda
Transferências

ㅤ
Para editar um pagamento através da API, você deve:
ㅤㅤ

1. Acesse a documentação da API https://api.finmap.online/

2. Faça login com uma chave API

3. Selecione o tipo de pagamento que deseja adicionar. Esses tipos incluem:

operations/income
operations/expense
operations/transfer

ㅤ

4. Clique no parâmetro PATCH

5. Escolha qual tipo de pagamento você editará por OperationID ou externalID

ㅤ

6. Insira o ID necessário

7. Especifique as alterações que deseja fazer

8. Conclua a solicitação

ㅤ

✅ Como resultado, os dados da operação serão alterados. Você não pode alterar todos os parâmetros, mas apenas aqueles necessários, por exemplo, você pode alterar apenas a data (na maioria das vezes, a alteração da data é usada quando você precisa confirmar um pagamento futuro)
ㅤ
ㅤ

Removendo pagamentos via API 🗑️

ㅤ
Para remover um pagamento por meio da API, você deve:
ㅤ

1. Acesse a documentação da API https://api.finmap.online/

2. Faça login com uma chave API

3. Selecione o tipo de pagamento que deseja adicionar. Esses tipos incluem: