{ "openapi": "3.0.1", "info": { "title": "Supplier Returns & Credit Note Reconciliation", "description": "Find missing, partial and unapplied supplier credits from structured exports. Exact amounts, document evidence, cut-off dates and completeness checks.", "version": "1.0", "x-build-id": "ymdgZrJbvQcTPBpTc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/prixodik~supplier-credit-reconciliation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-prixodik-supplier-credit-reconciliation", "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/prixodik~supplier-credit-reconciliation/runs": { "post": { "operationId": "runs-sync-prixodik-supplier-credit-reconciliation", "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/prixodik~supplier-credit-reconciliation/run-sync": { "post": { "operationId": "run-sync-prixodik-supplier-credit-reconciliation", "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": [ "scope", "cutoffDate", "completeness", "returns", "credits", "applications" ], "properties": { "scope": { "title": "Accounting scope", "type": "string", "description": "Stable pseudonymous book or company scope. Do not mix different accounting books.", "default": "synthetic-book-01" }, "cutoffDate": { "title": "Cut-off date", "type": "string", "description": "Inclusive ISO date YYYY-MM-DD. Due dates are overdue only after the specified date.", "default": "2026-10-11" }, "completeness": { "title": "Export completeness", "type": "object", "description": "Explicit boolean flags for returns, credits and applications. Unknown or partial exports must use false.", "default": { "returns": true, "credits": true, "applications": true } }, "returns": { "title": "Approved returns", "type": "array", "description": "Approved monetary returns with exact returnId, supplierId, currency, approvedAmount, approvedAt and creditDueDate.", "items": { "type": "object" }, "default": [ { "returnId": "R-DEMO-001", "supplierId": "S-DEMO-001", "currency": "EUR", "approvedAmount": "1000.00", "approvedAt": "2026-09-01", "creditDueDate": "2026-09-20" } ] }, "credits": { "title": "Credit notes", "type": "array", "description": "Positive credit amounts and explicit allocations. Sum of allocations must equal the credit amount.", "items": { "type": "object" }, "default": [ { "creditId": "CN-DEMO-001", "supplierId": "S-DEMO-001", "currency": "EUR", "amount": "800.00", "issuedAt": "2026-09-10", "applicationDueDate": "2026-09-30", "allocations": [ { "returnId": "R-DEMO-001", "amount": "800.00" } ] } ] }, "applications": { "title": "Credit applications", "type": "array", "description": "Positive applied amounts with exact applicationId, creditId, supplierId, currency and appliedAt.", "items": { "type": "object" }, "default": [ { "applicationId": "AP-DEMO-001", "supplierId": "S-DEMO-001", "currency": "EUR", "creditId": "CN-DEMO-001", "amount": "500.00", "appliedAt": "2026-09-12" } ] }, "mode": { "title": "Report mode", "enum": [ "snapshot", "changes" ], "type": "string", "description": "Return a complete report, optionally with a separate list of differences from the previous supplied export.", "default": "snapshot" }, "stateStoreId": { "title": "State store name or ID", "type": "string", "description": "Required for changes mode. Serialize runs sharing a store and scope. Inputs and results remain subject to Apify storage settings.", "default": "" } } }, "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 } } } } } } } } } }