{ "openapi": "3.0.1", "info": { "title": "Freight Invoice & Surcharge Auditor", "description": "Review freight invoice CSV/XLSX against your own contract tariffs with Decimal calculations, fuel and dimensional weight evidence. No OCR or carrier login.", "version": "1.0", "x-build-id": "R8ELYIMSag2v4Vtwk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/afkdigital~newapi75-freight-invoice-surcharge-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-afkdigital-newapi75-freight-invoice-surcharge-auditor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/afkdigital~newapi75-freight-invoice-surcharge-auditor/runs": { "post": { "operationId": "runs-sync-afkdigital-newapi75-freight-invoice-surcharge-auditor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/afkdigital~newapi75-freight-invoice-surcharge-auditor/run-sync": { "post": { "operationId": "run-sync-afkdigital-newapi75-freight-invoice-surcharge-auditor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "invoiceFile", "rateCardFile" ], "properties": { "invoiceFile": { "title": "Invoice CSV / XLSX", "type": "object", "description": "File descriptor: {format:csv,text:...}, {format:xlsx,base64:...} or {format:csv|xlsx,url:HTTPS Apify KVS record URL}. No query string. XLSX sheet optional, required for multiple sheets. UTF-8 CSV, kg/cm, ISO dates. Formulas/macros rejected. See README columns." }, "rateCardFile": { "title": "Contract rate card CSV / XLSX", "type": "object", "description": "Same file descriptors as invoiceFile. Explicit tariff rows required; no external rates or zones are inferred." }, "surchargeRules": { "title": "Customer surcharge rules", "type": "array", "description": "Explicit rule objects. See README for date, zone, service, kind, value, fuel_eligible and applies_when fields.", "default": [] }, "columnMapping": { "title": "Column mapping", "type": "object", "description": "{invoice:{canonical:source_header},rateCard:{canonical:source_header}}. Identity columns must be text in XLSX.", "default": {} }, "currency": { "title": "Fallback invoice currency", "type": "string", "description": "ISO currency only when missing from invoice rows. Never overrides an existing currency. No FX conversion.", "default": "USD" }, "tolerance": { "title": "Absolute difference tolerance", "type": "string", "description": "Nonnegative decimal in each shipment currency, e.g. 0.01. At most 1000.", "default": "0.01" }, "maxShipments": { "title": "Maximum unique shipment IDs", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Input above this limit fails before charging. Extra charge lines/packages share the shipment event.", "default": 1000 }, "fileStores": { "title": "Read access for uploaded files", "maxItems": 2, "type": "array", "description": "When using record URLs, select the key-value stores containing your invoice and rate card. Not needed for embedded CSV/base64." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }