Equals icon

Equals

Integração com a plataforma Equals — Venda Interna, Retorno, Plataforma e Webhooks

Retorno → Gerar Remessa

AI-generated

Summary

Request the generation of a reconciliation report (remessa) from the Equals platform for a specified report type and date range, optionally filtering by establishments and acquirers.

Inputs

  • ID do Relatório (idMovFinanCfg) (required) — The report type code indicating which configuration to use; obtained from the Listar Configurações operation.
  • Data Inicial da Movimentação (required) — Start date of the transaction movement period in dd/MM/yyyy format.
  • Data Final da Movimentação (required) — End date of the transaction movement period in dd/MM/yyyy format.
  • Filtro Estabelecimentos (JSON) — JSON array of Equals establishment IDs to filter by; leave empty array to include all.
  • Filtro Adquirentes (JSON) — JSON array of Equals acquirer IDs to filter by; leave empty array to include all.

Output shape

An object representing the generation request response from the Equals API, often including details about the processing status or identifier of the generated remessa.

If filter arrays for establishments or acquirers are empty, they are omitted in the API request, meaning no filtering on those fields. The date fields must be formatted as dd/MM/yyyy. Errors during API calls throw exceptions unless 'Continue On Fail' workflow option is set.

Links

Discussion