Skip to content
HALOWERK

Finopswerk

consignment sellthrough remittance ledger

Reconstructs consignor goods ownership, sell-through and net consignee remittance for one fully dispatched uniform-cost batch over two ordered retail sales periods. Dispatch alone recognizes zero revenue; each sale is recorded as gross revenue, unit-book COGS and commission expense at the agreed rate. Returns 8 fields per period plus 8 totals. Dealer receivable=cumulative sales*(price-fee)-cumulative remittance; unsold goods create no payment obligation.

POST https://finops.halowerk.com/v1/consignment-sellthrough-remittance-ledger

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
consigned_unitsintegerYes
unit_price_nintegerYes
unit_cost_nintegerYes
commission_bpsintegerYes
sold_unitsarrayYes
remittances_narrayYes
amount_denominatorintegerYes
reportobjectYes
Show full input schema
{
  "type": "object",
  "required": [
    "consigned_units",
    "unit_price_n",
    "unit_cost_n",
    "commission_bps",
    "sold_units",
    "remittances_n",
    "amount_denominator",
    "report"
  ],
  "properties": {
    "consigned_units": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "unit_price_n": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000000
    },
    "unit_cost_n": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "commission_bps": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    },
    "sold_units": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 1000
      }
    },
    "remittances_n": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 1000000000
      }
    },
    "amount_denominator": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    },
    "report": {
      "type": "object",
      "minProperties": 24,
      "maxProperties": 24,
      "propertyNames": {
        "enum": [
          "revenue_1",
          "cogs_1",
          "commission_1",
          "profit_1",
          "remittance_1",
          "remaining_units_1",
          "inventory_1",
          "receivable_1",
          "revenue_2",
          "cogs_2",
          "commission_2",
          "profit_2",
          "remittance_2",
          "remaining_units_2",
          "inventory_2",
          "receivable_2",
          "initial_inventory",
          "total_revenue",
          "total_commission",
          "total_profit",
          "total_remitted",
          "cash_receivable_inventory_net",
          "net_asset_gain",
          "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
          }
        }
      }
    }
  },
  "additionalProperties": false
}

Open original schema

Published input example

{
  "consigned_units": 10,
  "unit_price_n": 100,
  "unit_cost_n": 40,
  "commission_bps": 1000,
  "sold_units": [
    3,
    4
  ],
  "remittances_n": [
    200,
    300
  ],
  "amount_denominator": 1,
  "report": {
    "revenue_1": {
      "n": "300",
      "d": "1"
    },
    "cogs_1": {
      "n": "120",
      "d": "1"
    },
    "commission_1": {
      "n": "30",
      "d": "1"
    },
    "profit_1": {
      "n": "150",
      "d": "1"
    },
    "remittance_1": {
      "n": "200",
      "d": "1"
    },
    "remaining_units_1": {
      "n": "7",
      "d": "1"
    },
    "inventory_1": {
      "n": "280",
      "d": "1"
    },
    "receivable_1": {
      "n": "70",
      "d": "1"
    },
    "revenue_2": {
      "n": "400",
      "d": "1"
    },
    "cogs_2": {
      "n": "160",
      "d": "1"
    },
    "commission_2": {
      "n": "40",
      "d": "1"
    },
    "profit_2": {
      "n": "200",
      "d": "1"
    },
    "remittance_2": {
      "n": "300",
      "d": "1"
    },
    "remaining_units_2": {
      "n": "3",
      "d": "1"
    },
    "inventory_2": {
      "n": "120",
      "d": "1"
    },
    "receivable_2": {
      "n": "130",
      "d": "1"
    },
    "initial_inventory": {
      "n": "400",
      "d": "1"
    },
    "total_revenue": {
      "n": "700",
      "d": "1"
    },
    "total_commission": {
      "n": "70",
      "d": "1"
    },
    "total_profit": {
      "n": "350",
      "d": "1"
    },
    "total_remitted": {
      "n": "500",
      "d": "1"
    },
    "cash_receivable_inventory_net": {
      "n": "750",
      "d": "1"
    },
    "net_asset_gain": {
      "n": "350",
      "d": "1"
    },
    "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 โ†’