Do status de um pagamento ao lançamento no seu ERP: uma proposta.
Esta página é uma proposta conceitual, não um recurso do produto. A CodeSpar não escreve em ERPs: Omie e Tiny não são conectores para os quais ela roteia, e o Bling é roteado só para emitir NFS-e. O que existe para construir em cima: o codespar_pay lê o status de cada pagamento pelo id, e o codespar_wallet lista os lançamentos da carteira. Mapear cada evento de dinheiro para o ERP, a entidade e a conta certos, e escrevê-lo, é a sua integração.
Do status de um pagamento ao lançamento no seu ERP.
Um esboço ilustrativo: o agente lê o status do pagamento na CodeSpar e a sua integração escreve o lançamento no ERP. A CodeSpar não escreve no ERP.
- A CodeSpar devolve o status do pagamento e o extrato da carteira
- Escrever no ERP é a sua integração
- O Bling é roteado só para emitir NFS-e
A conversa é a parte fácil.
Cada transação é digitada no ERP à mão e depois conciliada no fim do mês entre países e entidades.
Digitar cada transação no ERP
A sua integração escreve o lançamento a partir do status do pagamento
Conferir no portal do banco o que liquidou
O codespar_pay action=status lê cada pagamento
Remontar as movimentações da carteira para o contador
O codespar_wallet action=statement lista as movimentações
Anexar o documento fiscal à mão
O codespar_invoice emite (NFe.io, só em projetos live); anexar é a sua integração
Uma proposta, sobre os registros que existem.
A sua integração lê o que a CodeSpar registra: o status de um pagamento pelo id (codespar_pay, action=status) e os lançamentos da carteira (codespar_wallet, action=statement). Ela mapeia cada lançamento para a entidade, a conta e a moeda do ERP certo e o escreve lá. A CodeSpar não tem conector de ERP que escreva lançamentos: Omie e Tiny não são roteados, e o Bling é roteado só para NFS-e.
codespar_payStatus do pagamento pelo id
CodeSparcodespar_walletOs lançamentos da carteira
CodeSparEntidade, conta, moeda
O lançamento no ERP
O documento fiscal, se houver
Um esboço, não um fluxo do produto. O codespar_pay com action=status devolve o status de um pagamento no provedor pelo id; o codespar_wallet com action=statement devolve os lançamentos da carteira. A sua integração transforma cada lançamento liquidado num lançamento de ERP da entidade certa e o escreve pela API do próprio ERP. Nenhum conector da CodeSpar escreve em Omie, Bling ou Tiny.
O código, e o que ele pressupõe.
// Prerequisites: CODESPAR_API_KEY set to a test key (csk_test_…) and a payment // made through codespar_pay. Writing to the ERP is your code: CodeSpar does not // write to Omie, Bling or Tiny. import { CodeSpar } from "@codespar/sdk"; const session = await new CodeSpar().create("user_0000", { preset: "brazilian" }); // what CodeSpar can tell your integration const status = await session.execute("codespar_pay", { action: "status", payment_id: "<payment id>" }); const statement = await session.execute("codespar_wallet", { action: "statement", consumer_id: "user_0000", limit: 20 }); // your integration: map each settled entry to the ERP of the right entity console.log(status.data, statement.data);
Exemplo com o SDK publicado (@codespar/sdk 0.16.11). Os pré-requisitos estão nos comentários. Compilar não prova a integração: rode primeiro em modo de teste.
codespar_payA action=status lê o status de um pagamento pelo id.
codespar_walletA action=statement lista os lançamentos da carteira.
Comece com uma chave de teste.
Chaves de teste são gratuitas. Abra o sandbox, conecte os provedores que o seu projeto usa e veja quais ferramentas ele pode chamar antes de construir.