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:

ㅤ

ㅤ

ㅤ
ㅤ✅ 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:
ㅤㅤ

ㅤ

ㅤ

ㅤ

✅ 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:
ㅤ

ㅤ

ㅤ

ㅤ
ㅤㅤ

Como obter o ID da operação 👀

ㅤ
Você pode encontrar o ID da operação da seguinte maneira:
ㅤ

1. Usando Webhook

ㅤ
2. Usando ferramentas de desenvolvedor

ㅤ2.1 Para fazer isso, você precisa abrir as ferramentas do desenvolvedor no navegador

ㅤ2.2 Vá para a guia Network
ㅤ

ㅤ
ㅤ2.3 Selecione log (esta opção contém dados de todos os pagamentos que você possui na página Finmap)

ㅤ2.4 Clique na aba Preview
ㅤ

ㅤ
ㅤ2.5 Abrimos todos os pagamentos nesta guia
ㅤ

ㅤ
ㅤ2.6 Selecione o pagamento desejado

ㅤ2.7 Mas encontramos seu id (geralmente está no final das informações de pagamento)
ㅤ

ㅤ

ㅤ

Se você tiver alguma dúvida

Se você tiver alguma dúvida sobre a documentação da API ou um exemplo de solicitação técnica que gostaria de resolver, envie um e-mail para support-team@finmap.online.

A carta deve descrever o seguinte: “A solicitação … não funciona (esta resposta aparece) quando você envia os parâmetros ….” Nosso especialista técnico analisará sua solicitação (as solicitações são processadas em até 24 horas) e fornecerá uma resposta qualificada.

ㅤ

ㅤ