Skip to content
HALOWERK

Finopswerk

foreign cashflow exchange reconciliation

Reconciles one foreign-currency cash account from the opening balance and prior closing rate, four ordered signed cash flows with their flow-date rates and caller classifications (0 operating, 1 investing, 2 financing) and the reported closing foreign balance. Returns 18 exact fractions including translated flows, category totals, closing cash and the modeled exchange effect. A reported-minus-expected foreign cash gap is a separate diagnostic, never an FX gain.

POST https://finops.halowerk.com/v1/foreign-cashflow-exchange-reconciliation

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
opening_cash_unitsintegerYes
opening_rateintegerYes
eventsarrayYes
reported_closing_cash_unitsintegerYes
closing_rate_domainarrayYes
reportobjectYes
Show full input schema
{
  "type": "object",
  "properties": {
    "opening_cash_units": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "opening_rate": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    },
    "events": {
      "type": "array",
      "minItems": 4,
      "maxItems": 4,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "category",
          "flow_units",
          "rate"
        ],
        "properties": {
          "category": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2
          },
          "flow_units": {
            "type": "integer",
            "minimum": -1000000,
            "maximum": 1000000
          },
          "rate": {
            "type": "integer",
            "minimum": 1,
            "maximum": 1000000
          }
        }
      }
    },
    "reported_closing_cash_units": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "closing_rate_domain": {
      "type": "array",
      "minItems": 1,
      "maxItems": 2,
      "uniqueItems": true,
      "items": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000000
      }
    },
    "report": {
      "type": "object",
      "minProperties": 18,
      "maxProperties": 18,
      "propertyNames": {
        "enum": [
          "foreign_flow_sum",
          "expected_closing_foreign",
          "reported_closing_foreign",
          "foreign_cash_gap",
          "opening_translated_cash",
          "translated_flow_0",
          "translated_flow_1",
          "translated_flow_2",
          "translated_flow_3",
          "operating_cashflows",
          "investing_cashflows",
          "financing_cashflows",
          "net_translated_flows",
          "expected_closing_translated",
          "reported_closing_translated",
          "modeled_exchange_effect",
          "unexplained_at_closing_rate",
          "reconciliation_gap"
        ]
      },
      "additionalProperties": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "n",
          "d"
        ],
        "properties": {
          "n": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          },
          "d": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 64
          }
        }
      }
    }
  },
  "required": [
    "opening_cash_units",
    "opening_rate",
    "events",
    "reported_closing_cash_units",
    "closing_rate_domain",
    "report"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "opening_cash_units": 1,
  "opening_rate": 3,
  "events": [
    {
      "category": 0,
      "flow_units": 1,
      "rate": 7
    },
    {
      "category": 1,
      "flow_units": -1,
      "rate": 11
    },
    {
      "category": 2,
      "flow_units": 1,
      "rate": 13
    },
    {
      "category": 0,
      "flow_units": -1,
      "rate": 17
    }
  ],
  "reported_closing_cash_units": 1,
  "closing_rate_domain": [
    19
  ],
  "report": {
    "foreign_flow_sum": {
      "n": "0",
      "d": "1"
    },
    "expected_closing_foreign": {
      "n": "1",
      "d": "1"
    },
    "reported_closing_foreign": {
      "n": "1",
      "d": "1"
    },
    "foreign_cash_gap": {
      "n": "0",
      "d": "1"
    },
    "opening_translated_cash": {
      "n": "3",
      "d": "10000"
    },
    "translated_flow_0": {
      "n": "7",
      "d": "10000"
    },
    "translated_flow_1": {
      "n": "-11",
      "d": "10000"
    },
    "translated_flow_2": {
      "n": "13",
      "d": "10000"
    },
    "translated_flow_3": {
      "n": "-17",
      "d": "10000"
    },
    "operating_cashflows": {
      "n": "-1",
      "d": "1000"
    },
    "investing_cashflows": {
      "n": "-11",
      "d": "10000"
    },
    "financing_cashflows": {
      "n": "13",
      "d": "10000"
    },
    "net_translated_flows": {
      "n": "-1",
      "d": "1250"
    },
    "expected_closing_translated": {
      "n": "19",
      "d": "10000"
    },
    "reported_closing_translated": {
      "n": "19",
      "d": "10000"
    },
    "modeled_exchange_effect": {
      "n": "3",
      "d": "1250"
    },
    "unexplained_at_closing_rate": {
      "n": "0",
      "d": "1"
    },
    "reconciliation_gap": {
      "n": "0",
      "d": "1"
    }
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’