API REST para dados contábeis

Como todo documento da REDA Financials é um objeto personalizado do Salesforce, a API REST padrão é a porta de entrada para a sua integração: crie faturas a partir do seu CRM ou sistema de faturamento, consulte saldos para um data warehouse, contabilize documentos a partir de middleware — tudo com os endpoints que a sua equipe já conhece.

O padrão canônico: criar um rascunho e depois contabilizar

Os endpoints, em resumo

Nada aqui é específico da REDA — são os endpoints REST padrão do Salesforce, mostrados em relação aos objetos refin__ (o pacote é criado na API v65.0; qualquer versão atual funciona):

Contabilizando um rascunho, na prática

A chamada de contabilização é deliberadamente anticlimática — um único campo:

PATCH /services/data/v65.0/sobjects/refin__Sales_Invoice__c/a0X8d000001AbCdEAV

{
  "refin__Status__c": "Posted"
}

O sucesso é um HTTP 204 No Content — com um documento totalmente contabilizado por trás dele. Uma recusa retorna como o array de erro padrão, carregando a mensagem legível do pacote; por exemplo, um usuário de integração sem uma licença REDA vê:

[
  {
    "message": "Você deve ser um usuário licenciado do REDA Financials para criar, editar ou excluir Transações contábeis. Contate o administrador.",
    "errorCode": "FIELD_CUSTOM_VALIDATION_EXCEPTION",
    "fields": []
  }
]

Consultar de volta o que você criou é SOQL simples:

GET /services/data/v65.0/query
    ?q=SELECT Id, Name, refin__Status__c
       FROM refin__Sales_Invoice__c
       WHERE refin__Status__c = 'Draft'

Para os corpos de inserção em si, obtenha a lista de campos no endpoint describe ou no Gerenciador de Objetos, em vez deste artigo — os conjuntos de campos e campos obrigatórios da sua organização são a verdade, e os campos de dimensão extras que o seu administrador adicionou fazem parte dela.

O que a plataforma preenche automaticamente para você

Lendo dados

• SOQL pelo endpoint de consulta — faturas em aberto, recebimentos não aplicados, campos de aging (são campos de fórmula nos registros), o que quer que o seu painel precise.
• O próprio livro razão — refin__Accounting_Transaction__c é a verdade da contabilização; some débitos e créditos por conta contábil e você reconstruiu qualquer saldo externamente.
• Os totalizadores são campos — o saldo devedor de uma fatura, o valor não aplicado de um recebimento, o valor comprometido de uma linha de orçamento: tudo consultável diretamente, sem cálculo do seu lado.

Regras do caminho

• Não existe atalho: documentos contabilizados ficam bloqueados a edições via API exatamente como para os usuários; correções passam pelos fluxos de descontabilização/cancelamento, programaticamente as mesmas transições de status.
• Aplicações também são registros — criar um refin__Cash_Receipt_Application__c aplica um recebimento (todas as validações de correspondência são executadas); excluí-lo desfaz a aplicação.
• Respeite as datas de fechamento — gravações em livros fechados são recusadas; sua integração deve datar documentos em períodos abertos, como qualquer contador faria.
• A idempotência é sua responsabilidade — a chave natural é a referência do seu sistema de origem (coloque-a no campo Referência e verifique antes de inserir; a validação de duplicidade de referência do fornecedor ajuda no lado de contas a pagar).

Erros comuns a evitar

O que vem a seguir

1. Bulk API — o mesmo padrão em escala de migração.
2. Visão geral da API — todo o panorama.
3. Saldos de abertura e migração de dados — o projeto clássico de REST/Bulk.

Perguntas frequentes