{ "openapi": "3.0.1", "info": { "title": "Document Generator: invoices, receipts and quotes to PDF", "description": "Turns JSON rows into PDF invoices, receipts, quotes and packing slips, or into any document from your own HTML template. Computes line totals, discounts, tax by rate, shipping and balance due. Returns a download link for each PDF.", "version": "0.1", "x-build-id": "UwGJTKyE4c5LvhC6l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~document-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-document-generator", "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/examsens.ai~document-generator/runs": { "post": { "operationId": "runs-sync-examsens.ai-document-generator", "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/examsens.ai~document-generator/run-sync": { "post": { "operationId": "run-sync-examsens.ai-document-generator", "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", "properties": { "template": { "title": "Template", "enum": [ "invoice", "receipt", "quote", "packing-slip", "custom" ], "type": "string", "description": "Built in invoice, receipt, quote or packing slip, or your own HTML template.", "default": "invoice" }, "documents": { "title": "Documents", "type": "array", "description": "One JSON object per document. Common fields: documentNumber, date, dueDate, validUntil, orderNumber, currency, buyer, shipTo, items (description, sku, quantity, unit, unitPrice, discountPercent, taxRate, details), taxRate, discountPercent, discountAmount, shipping, amountPaid, paymentMethod, paymentInstructions, notes, terms. See the README for the full list." }, "defaults": { "title": "Shared values", "type": "object", "description": "Values merged under every document, such as the seller, currency, accent color, payment instructions and terms. A document's own value wins." }, "dataUrl": { "title": "Documents from URL", "type": "string", "description": "Optional URL of a JSON list of documents, added after the ones above." }, "customTemplate": { "title": "Custom HTML template", "type": "string", "description": "Jinja2 HTML used when the template is custom. Every document field is available by name. When the document has items, the computed items (amountText, unitPriceText) and totals (subtotalText, taxText, totalText and the numbers) are added." }, "pageSize": { "title": "Page size", "enum": [ "Letter", "A4", "Legal", "A5" ], "type": "string", "description": "Paper size of the PDF.", "default": "Letter" }, "margin": { "title": "Margin", "type": "string", "description": "Page margin on every side, in CSS units such as 15mm or 0.6in.", "default": "15mm" }, "pageNumbers": { "title": "Page numbers", "type": "boolean", "description": "Print page X / Y at the foot of every page.", "default": true }, "fileNameField": { "title": "File name field", "type": "string", "description": "Document field used to name each PDF.", "default": "documentNumber" }, "saveHtml": { "title": "Also save HTML", "type": "boolean", "description": "Save the HTML of each document next to its PDF.", "default": false } } }, "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 } } } } } } } } } }