Skip to content
HALOWERK

Zollwerk

shipment multicurrency invoice reconcile

Reconcile foreign-currency invoice cents using supplied exact decimal exchange rates.

POST https://zoll.halowerk.com/v1/shipment-multicurrency-invoice-reconcile

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
linesarrayYes
ratesarrayYes
declared_total_centsintegerYes
Show full input schema
{
  "type": "object",
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 64,
            "minLength": 1
          },
          "currency": {
            "type": "string",
            "pattern": "^[A-Za-z]{3}$"
          },
          "amount_cents": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000000000
          }
        },
        "required": [
          "id",
          "currency",
          "amount_cents"
        ],
        "additionalProperties": false
      },
      "maxItems": 100,
      "minItems": 1
    },
    "rates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "pattern": "^[A-Za-z]{3}$"
          },
          "rate": {
            "type": "string",
            "pattern": "^(?:0|[1-9][0-9]{0,8})(?:\\.[0-9]{1,6})?$"
          }
        },
        "required": [
          "currency",
          "rate"
        ],
        "additionalProperties": false
      },
      "maxItems": 30,
      "minItems": 1
    },
    "declared_total_cents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    }
  },
  "required": [
    "lines",
    "rates",
    "declared_total_cents"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "lines": [
    {
      "id": "line_01",
      "currency": "USD",
      "amount_cents": 1000
    },
    {
      "id": "line_02",
      "currency": "GBP",
      "amount_cents": 1000
    }
  ],
  "rates": [
    {
      "currency": "USD",
      "rate": "0.9"
    },
    {
      "currency": "GBP",
      "rate": "1.2"
    }
  ],
  "declared_total_cents": 2100
}

Result & documentation

Machine-readable documentation of this hub

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

More endpoints in this hub

All endpoints in this hub โ†’