Reconcile and diagnose discrepancies between two CSV exports API

Upload two CSV exports that should agree, and name the column that links them and the column holding the amount. It sorts every row into four buckets (agrees

Input

Send these Fields as input. A Field not listed here is refused.

what_are_you_reconciling

What are you reconciling

  • Type: string
  • Required: yes
  • Length in characters: 1 to 30000

key_column

Column that links the two files

  • Type: string
  • Required: yes
  • Length in characters: 1 to 30000

amount_column

Column holding the amount

  • Type: string
  • Required: yes
  • Length in characters: 1 to 30000

file_a

File A - the source of truth

An https URL or an upload id.

  • Type: string
  • Required: yes
  • Length in characters: at least 1

file_b

File B - your records

An https URL or an upload id.

  • Type: string
  • Required: yes
  • Length in characters: at least 1

Run it

One call presses the Widget and answers the run once its status is succeeded or failed, however long it takes. The key is read from ABYSS_API_KEY. Install the library with npm install abysshub or pip install abysshub; cURL sends the Fields as a form.

JavaScript

// index.mjs
import Abyss, { file } from "abysshub";

const abyss = new Abyss();

const run = await abyss.run("widget_380", {
  what_are_you_reconciling: "Payment processor payouts against our invoice ledger",
  key_column: "Reference",
  amount_column: "Amount",
  file_a: file("processor_payouts.csv"),
  file_b: file("invoice_ledger.csv"),
});

console.log(run.result);
for (const path of await run.save("output")) {
  console.log(path);
}

Python

from abysshub import Abyss, file

abyss = Abyss()

run = abyss.run("widget_380", {
    "what_are_you_reconciling": "Payment processor payouts against our invoice ledger",
    "key_column": "Reference",
    "amount_column": "Amount",
    "file_a": file("processor_payouts.csv"),
    "file_b": file("invoice_ledger.csv"),
})

print(run.result)
for path in run.save("output"):
    print(path)

cURL

curl https://api.abysshub.com/v1/widgets/widget_380/runs \
  -H "Authorization: Bearer $ABYSS_API_KEY" \
  -F 'what_are_you_reconciling=Payment processor payouts against our invoice ledger' \
  -F key_column=Reference \
  -F amount_column=Amount \
  -F file_a=@processor_payouts.csv \
  -F file_b=@invoice_ledger.csv

A succeeded run carries its result and its output_files. Their URLs are signed for each read: re-read the run, never store a URL. A run still queued or running in the answer (after an hour, or when the API is busy) is read again at its Location with ?wait=true.

What it answers

The Example Run's result, the JSON the Widget wrote to output/output.json:

{
  "balanced": false,
  "title": "Do not close the period yet",
  "message": "The 2,456 net gap is almost entirely three unmatched processor payouts (PO-24112 to PO-24114), probably a timing difference in when the two exports were taken. Materiality is material: do not close the period until the cut-off is confirmed.\n\n4 row(s) need attention out of 15 compared, a net gap of 2456.\n\nThe workbook opens with the likely causes ranked by how much of the gap each explains, and the single quickest check for each - then every differing row underneath. Your download should start automatically.",
  "workbook": "reconciliation.xlsx"
}

More

Keys, files, errors and limits: API access.