{"openapi":"3.0.0","paths":{"/status":{"get":{"description":"Gets the status of the API","operationId":"AppController_getStatus","parameters":[],"responses":{"200":{"description":"The API is up and running.","content":{"text/plain":{"schema":{"type":"string","example":"The API is up and running."}}}}},"summary":"","tags":["App"]}},"/documents/{documentUlid}/confirm":{"post":{"description":"Confirms that the document has been successfully processed on the client side. Once confirmed, all related files of the document will be removed on our end. If the document is still being processed in the Dokapi flow, this request will result in a Bad Request (400) response.","operationId":"DocumentController_confirmDocument","parameters":[{"name":"documentUlid","required":true,"in":"path","description":"The ULID of the document to confirm.","schema":{"type":"string"}}],"responses":{"200":{"description":"Document with ulid: 01JD2V1X3XK1M7FQZB6J8VK8R4 was confirmed"},"400":{"description":"The document cannot be confirmed because it has not yet finished processing."},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"404":{"description":"No Document found with ulid: 01JD2V1X3XK1M7FQZB6J8VK8R4"}},"summary":"Confirm that a document has been processed","tags":["documents"]}},"/documents/search/by-external-reference":{"get":{"description":"Returns a list of documents for the external Reference.","operationId":"DocumentController_getDocumentsByExternalReference","parameters":[{"name":"externalReference","required":true,"in":"query","description":"The external reference to search for.","schema":{"example":"my-external-ref-123","type":"string"}}],"responses":{"200":{"description":"the documents for the external Reference with their document Executions.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDto"}}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Get documents by external reference","tags":["documents"]}},"/documents/unconfirmed":{"get":{"description":"Returns a paginated list of unconfirmed documents. ","operationId":"DocumentController_getUnconfirmedDocuments","parameters":[{"name":"limit","required":false,"in":"query","description":"The page size (number of items to retrieve per page). Optional. Default 15. Max is 50.","schema":{"minimum":0,"maximum":50,"default":15,"example":"15","type":"number"}},{"name":"lastEvaluatedKey","required":false,"in":"query","description":"The pagination key from previous page to get the next page. Optional. Leave empty to start from beginning.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of unconfirmed documents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentPageDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Get all unconfirmed documents, from oldest to newest","tags":["documents"]}},"/documents/{documentUlid}":{"get":{"description":"Returns a document for the given ulid.","operationId":"DocumentController_getDocumentByUlid","parameters":[{"name":"documentUlid","required":true,"in":"path","description":"The ulid of the document.","schema":{"type":"string"}}],"responses":{"200":{"description":"The document with its document Executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"404":{"description":"No Document found with the given ulid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Get document by its ulid","tags":["documents"]}},"/folders/{folderUlid}/filed-events":{"get":{"description":"Returns list of filed events for a given organization and folder ulid. ","operationId":"FolderController_getFiledEventsForFolder","parameters":[{"name":"toDate","required":true,"in":"query","description":"The to date for the filed events, cannot be more than 7 days ago.","schema":{"example":"2025-01-02","type":"string"}},{"name":"fromDate","required":true,"in":"query","description":"The from date for the filed events, cannot be more than 7 days ago.","schema":{"example":"2025-01-01","type":"string"}},{"name":"folderUlid","required":true,"in":"path","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"The page size (number of items to retrieve per page). Optional. Default 15. Max is 50.","schema":{"minimum":0,"maximum":50,"default":15,"example":"15","type":"number"}},{"name":"lastEvaluatedKey","required":false,"in":"query","description":"The pagination key from previous page to get the next page. Optional. Leave empty to start from beginning.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of filed events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FiledEventPageDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Get filed events for a given folder","tags":["folders"]}},"/file-uploads":{"post":{"description":"\n## Step 1: Create a file upload\nTo create a file upload, you need to call the `POST /file-uploads` endpoint. This will return a pre-signed URL that you can use to upload your file.\n\nYou can add optional metadata to the file upload that will be stored alongside the file.\n## Step 2: Upload your file to the presigned URL\nUse the pre-signed URL to upload your file. After a successful upload the processing is started.  A PUT call should be made with the JSON file as binary body. This pre-signed URL can be used only <b>once</b>.\n\nThe file must be a valid JSON file that conforms to one of the following structures. A more detailed overview of the full schema's can be found in the conversion api documentation.\n<details>\n<summary>Example of supported invoice file structure:</summary>\n \n```\n{\n  \"invoiceID\": \"INV-123456\",\n  \"issueDate\": \"2025-03-01\",\n  \"dueDate\": \"2025-03-15\",\n  \"invoiceTypeCode\": \"380\",\n  \"currency\": \"EUR\",\n  \"alternateTaxCurrency\": {\n    \"currencyCode\": \"USD\",\n    \"exchangeRate\": 1.16\n  },\n  \"accountingCost\": \"4217:2323:2323\",\n  \"orderReference\": \"PO-789012\",\n  \"buyerReference\": \"a-buyer-reference\",\n  \"invoicePeriod\": {\n    \"startDate\": \"2025-01-31\",\n    \"endDate\": \"2025-12-31\",\n    \"descriptionCode\": \"35\"\n  },\n  \"note\": \"A textual note that gives unstructured information that is relevant to the invoice as a whole\",\n  \"supplier\": {\n    \"endpointID\": \"0123456789\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Main Street 1\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"additionalStreetName\": \"Box 123\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0123456789\",\n    \"name\": \"SUPPLIER COMPANY\",\n    \"email\": \"supplier@dokapi.io\",\n    \"telephone\": \"09 123 45 67\",\n    \"legalEntity\": {\n      \"registrationName\": \"SUPPLIER BV\",\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\",\n      \"companyLegalForm\": \"Share capital\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"customer\": {\n    \"endpointID\": \"0987654321\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Customer Road 5\",\n      \"cityName\": \"Antwerp\",\n      \"postalZone\": \"2000\",\n      \"additionalStreetName\": \"Po Box 987\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0987654321\",\n    \"name\": \"CUSTOMER COMPANY\",\n    \"email\": \"customer@dokapi.io\",\n    \"telephone\": \"+32 499 12 34 56\",\n    \"legalEntity\": {\n      \"registrationName\": \"CUSTOMER\",\n      \"companyID\": \"0987654321\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0987654321\"\n      }\n    ]\n  },\n  \"billingLines\": [\n    {\n      \"invoicedQuantity\": 10,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"accountingCost\": \"my-invoice-line-accounting-cost\",\n      \"item\": {\n        \"name\": \"Product A\",\n        \"taxCategory\": {\n          \"taxCategoryID\": \"S\",\n          \"taxPercentage\": 21\n        },\n        \"commodityClassifications\": [\n          {\n            \"itemClassificationCode\": \"9873242\",\n            \"itemTypeIdentificationCode\": \"STI\"\n          }\n        ]\n      },\n      \"allowanceCharges\": [\n        {\n          \"chargeIndicator\": true,\n          \"amount\": 15,\n          \"allowanceChargeReasonCode\": \"DL\"\n        },\n        {\n          \"chargeIndicator\": false,\n          \"amount\": 10,\n          \"allowanceChargeReason\": \"discount\"\n        }\n      ]\n    },\n    {\n      \"invoicedQuantity\": 5,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"item\": {\n        \"name\": \"Product B\",\n        \"taxCategory\": {\n          \"taxPercentage\": 21,\n          \"taxCategoryID\": \"S\"\n        }\n      },\n      \"note\": \"item note\",\n      \"orderLineReference\": \"orderLineReference\"\n    },\n    {\n      \"invoicedQuantity\": 15,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 15,\n      \"item\": {\n        \"name\": \"Product no tax\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        }\n      }\n    },\n    {\n      \"invoicedQuantity\": 1,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 1,\n      \"item\": {\n        \"name\": \"Product addition info\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        },\n        \"additionalItemProperties\": [\n          {\n            \"name\": \"additional-property\",\n            \"value\": \"value\"\n          }\n        ],\n        \"standardItemIdentification\": {\n          \"scheme\": \"0160\",\n          \"identification\": \"item-identification\"\n        }\n      }\n    }\n  ],\n  \"monetaryTotal\": {\n    \"prepaidAmount\": 20,\n    \"payableAmount\": 2000\n  },\n  \"paymentMeans\": [\n    {\n      \"paymentMeansCode\": \"58\",\n      \"paymentID\": \"PM-12345\",\n      \"financialAccount\": {\n        \"id\": \"BE99999999999999\",\n        \"financialInstitutionBranch\": {\n          \"id\": \"XXXXXXXX\"\n        }\n      }\n    }\n  ],\n  \"paymentTerms\": {\n    \"note\": \"Net within 30 days\"\n  },\n  \"allowanceCharges\": [\n    {\n      \"chargeIndicator\": true,\n      \"amount\": 200,\n      \"allowanceChargeReasonCode\": \"DL\",\n      \"taxCategory\": {\n        \"taxPercentage\": 25,\n        \"taxCategoryID\": \"S\"\n      }\n    },\n    {\n      \"chargeIndicator\": false,\n      \"amount\": 100,\n      \"allowanceChargeReason\": \"discount\",\n      \"taxCategory\": {\n        \"taxPercentage\": 10,\n        \"taxCategoryID\": \"S\"\n      }\n    }\n  ],\n  \"taxSubtotals\": [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"custom tax exemption reason\",\n      \"taxExemptionReasonCode\": \"custom tax exemption reason code for AE\"\n    }\n  ],\n  \"delivery\": {\n    \"actualDeliveryDate\": \"2025-03-31\",\n    \"deliveryLocation\": {\n      \"id\": \"location-id\",\n      \"postalAddress\": {\n        \"streetName\": \"Customer Road 5\",\n        \"cityName\": \"Antwerp\",\n        \"postalZone\": \"2000\",\n        \"countryIdentificationCode\": \"BE\"\n      }\n    },\n    \"deliveryParty\": {\n      \"name\": \"delivery party name\"\n    }\n  },\n  \"additionalDocuments\": [\n    {\n      \"id\": \"doc-001\",\n      \"filename\": \"invoice-attachment.pdf\",\n      \"mimeCode\": \"application/pdf\",\n      \"documentDescription\": \"Signed invoice note PDF\",\n      \"content\": \"RW5jb2RlZCBjb250ZW50IGV4YW1wbGUgZm9yIERva2FwaSBDb252ZXJzaW9uCg==\"\n    },\n    {\n      \"id\": \"external-document\",\n      \"documentDescription\": \"A reference to a document not added to the ubl\"\n    }\n  ]\n}\n```\n</details>\n\n\n<details>\n<summary>Example of supported credit note file structure:</summary>\n \n```\n{\n  \"creditNoteID\": \"CRD-123456\",\n  \"issueDate\": \"2025-03-01\",\n  \"creditNoteTypeCode\": \"381\",\n  \"currency\": \"EUR\",\n  \"alternateTaxCurrency\": {\n    \"currencyCode\": \"USD\",\n    \"exchangeRate\": 1.16\n  },\n  \"accountingCost\": \"4217:2323:2323\",\n  \"orderReference\": \"PO-789012\",\n  \"buyerReference\": \"my-buyer-reference\",\n  \"invoicePeriod\": {\n    \"startDate\": \"2025-01-31\",\n    \"endDate\": \"2025-12-31\",\n    \"descriptionCode\": \"35\"\n  },\n  \"note\": \"A textual note that gives unstructured information that is relevant to the invoice as a whole\",\n  \"supplier\": {\n    \"endpointID\": \"0123456789\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Main Street 1\",\n      \"cityName\": \"Brussels\",\n      \"postalZone\": \"1000\",\n      \"additionalStreetName\": \"Box 123\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0123456789\",\n    \"name\": \"SUPPLIER COMPANY\",\n    \"email\": \"supplier@dokapi.io\",\n    \"telephone\": \"09 123 45 67\",\n    \"legalEntity\": {\n      \"registrationName\": \"SUPPLIER BV\",\n      \"companyID\": \"0123456789\",\n      \"companySchemeID\": \"0208\",\n      \"companyLegalForm\": \"Share capital\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0123456789\"\n      }\n    ]\n  },\n  \"customer\": {\n    \"endpointID\": \"0987654321\",\n    \"endpointSchemeID\": \"0208\",\n    \"postalAddress\": {\n      \"streetName\": \"Customer Road 5\",\n      \"cityName\": \"Antwerp\",\n      \"postalZone\": \"2000\",\n      \"additionalStreetName\": \"Po Box 987\",\n      \"countryIdentificationCode\": \"BE\"\n    },\n    \"vatNumber\": \"BE0987654321\",\n    \"name\": \"CUSTOMER COMPANY\",\n    \"email\": \"customer@dokapi.io\",\n    \"telephone\": \"+32 499 12 34 56\",\n    \"legalEntity\": {\n      \"registrationName\": \"CUSTOMER\",\n      \"companyID\": \"0987654321\",\n      \"companySchemeID\": \"0208\"\n    },\n    \"partyIdentificationList\": [\n      {\n        \"schemeID\": \"0208\",\n        \"id\": \"0987654321\"\n      }\n    ]\n  },\n  \"billingLines\": [\n    {\n      \"invoicedQuantity\": 10,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"accountingCost\": \"my-invoice-line-accounting-cost\",\n      \"item\": {\n        \"name\": \"Product A\",\n        \"taxCategory\": {\n          \"taxCategoryID\": \"S\",\n          \"taxPercentage\": 21\n        },\n        \"commodityClassifications\": [\n          {\n            \"itemClassificationCode\": \"9873242\",\n            \"itemTypeIdentificationCode\": \"STI\"\n          }\n        ]\n      },\n      \"allowanceCharges\": [\n        {\n          \"chargeIndicator\": true,\n          \"amount\": 15,\n          \"allowanceChargeReasonCode\": \"DL\"\n        },\n        {\n          \"chargeIndicator\": false,\n          \"amount\": 10,\n          \"allowanceChargeReason\": \"discount\"\n        }\n      ]\n    },\n    {\n      \"invoicedQuantity\": 5,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 10,\n      \"item\": {\n        \"name\": \"Product B\",\n        \"taxCategory\": {\n          \"taxPercentage\": 21,\n          \"taxCategoryID\": \"S\"\n        }\n      },\n      \"note\": \"item note\",\n      \"orderLineReference\": \"orderLineReference\"\n    },\n    {\n      \"invoicedQuantity\": 15,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 15,\n      \"item\": {\n        \"name\": \"Product exempt from tax\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"E\"\n        }\n      }\n    },\n    {\n      \"invoicedQuantity\": 1,\n      \"unitCode\": \"C62\",\n      \"priceAmount\": 1,\n      \"item\": {\n        \"name\": \"Product addition info\",\n        \"taxCategory\": {\n          \"taxPercentage\": 0,\n          \"taxCategoryID\": \"AE\"\n        },\n        \"additionalItemProperties\": [\n          {\n            \"name\": \"additional-property\",\n            \"value\": \"value\"\n          }\n        ],\n        \"standardItemIdentification\": {\n          \"scheme\": \"0160\",\n          \"identification\": \"item-identification\"\n        }\n      }\n    }\n  ],\n  \"monetaryTotal\": {\n    \"prepaidAmount\": 20,\n    \"payableAmount\": 2000\n  },\n  \"paymentMeans\": [\n    {\n      \"paymentMeansCode\": \"58\",\n      \"paymentID\": \"PM-12345\",\n      \"financialAccount\": {\n        \"id\": \"BE99999999999999\",\n        \"financialInstitutionBranch\": {\n          \"id\": \"XXXXXXXX\"\n        }\n      }\n    }\n  ],\n  \"paymentTerms\": {\n    \"note\": \"Net within 30 days\"\n  },\n  \"allowanceCharges\": [\n    {\n      \"chargeIndicator\": true,\n      \"amount\": 200,\n      \"allowanceChargeReasonCode\": \"DL\",\n      \"taxCategory\": {\n        \"taxPercentage\": 25,\n        \"taxCategoryID\": \"S\"\n      }\n    },\n    {\n      \"chargeIndicator\": false,\n      \"amount\": 100,\n      \"allowanceChargeReason\": \"discount\",\n      \"taxCategory\": {\n        \"taxPercentage\": 10,\n        \"taxCategoryID\": \"S\"\n      }\n    }\n  ],\n  \"taxSubtotals\": [\n    {\n      \"taxCategory\": {\n        \"taxPercentage\": 0,\n        \"taxCategoryID\": \"AE\"\n      },\n      \"taxExemptionReason\": \"custom tax exemption reason\",\n      \"taxExemptionReasonCode\": \"custom tax exemption reason code for AE\"\n    }\n  ],\n  \"delivery\": {\n    \"actualDeliveryDate\": \"2025-03-31\",\n    \"deliveryLocation\": {\n      \"id\": \"location-id\",\n      \"postalAddress\": {\n        \"streetName\": \"Customer Road 5\",\n        \"cityName\": \"Antwerp\",\n        \"postalZone\": \"2000\",\n        \"countryIdentificationCode\": \"BE\"\n      }\n    },\n    \"deliveryParty\": {\n      \"name\": \"delivery party name\"\n    }\n  },\n  \"additionalDocuments\": [\n    {\n      \"id\": \"doc-001\",\n      \"filename\": \"credit-note-attachment.pdf\",\n      \"mimeCode\": \"application/pdf\",\n      \"documentDescription\": \"Signed credit note PDF\",\n      \"content\": \"RW5jb2RlZCBjb250ZW50IGV4YW1wbGUgZm9yIERva2FwaSBDb252ZXJzaW9uCg==\"\n    },\n    {\n      \"id\": \"external-document\",\n      \"documentDescription\": \"A reference to a document not added to the ubl\"\n    }\n  ]\n}\n```\n</details>\n\n","operationId":"FileUploadController_createFileUpload","parameters":[],"requestBody":{"required":true,"description":"File upload request details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFileUploadRequestDto"}}}},"responses":{"201":{"description":"File upload details with presigned URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFileUploadResponseDto"}}}},"400":{"description":"The provided request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}},"415":{"description":"The provided Content-Type is not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailDto"}}}}},"summary":"Create a file upload presigned URL","tags":["file-uploads"]}}},"info":{"title":"Portal API","description":"Dokapi Portal API","version":"0.0.102","contact":{}},"tags":[],"servers":[{"url":"https://portal-api.dokapi.io/v1"}],"components":{"schemas":{"ProblemDetailDto":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type.","format":"uri","example":"https://httpstatuses.com/500"},"title":{"type":"string","description":"A short, human-readable summary of the problem.","example":"Service Unavailable"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","example":"The service is currently unable to handle the request."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem.","example":"/errors/12345"},"status":{"type":"number","description":"The HTTP status code for this occurrence of the problem.","example":500},"uuid":{"type":"string","description":"A UUID that uniquely identifies this specific error occurrence.","example":"550e8400-e29b-41d4-a716-446655440000"}},"required":["title","detail"]},"FileDto":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file"},"presignedUrl":{"type":"string","description":"Presigned url that can be used to download the file"}},"required":["fileName","presignedUrl"]},"DocumentExecutionDto":{"type":"object","properties":{"origin":{"type":"string","description":"The origin of the document execution","enum":["WEBHOOK","WEBHOOK_INCOMING_PEPPOL_DOCUMENT","FILE_UPLOAD","ACTION_SEND_VIA_PEPPOL","ACTION_SEND_TO_CONVERSION","ACTION_SEND_VIA_MAIL","ACTION_SEND_TO_API"]},"files":{"description":"The files associated with the document execution. Returns an empty list for confirmed documents.","type":"array","items":{"$ref":"#/components/schemas/FileDto"}}},"required":["origin","files"]},"DocumentDto":{"type":"object","properties":{"ulid":{"type":"string","description":"The ulid of the document"},"organizationUlid":{"type":"string","description":"The ulid of the organization to which this document belongs"},"status":{"type":"string","description":"The status of the document","enum":["NEW","PROCESSED","FAILED"],"example":"PROCESSED"},"creationTimestamp":{"type":"string","description":"The timestamp indicating when this document was created, in ISO 8601 format.","example":"2025-01-31T15:34:18.242Z"},"lastModifiedTimestamp":{"type":"string","description":"The timestamp indicating the last time this document was modified, in ISO 8601 format","example":"2025-01-31T15:34:18.242Z"},"documentExecutions":{"description":"The document executions associated with this document","type":"array","items":{"$ref":"#/components/schemas/DocumentExecutionDto"}}},"required":["ulid","organizationUlid","status","creationTimestamp","lastModifiedTimestamp","documentExecutions"]},"DocumentPageDto":{"type":"object","properties":{"count":{"type":"number","description":"Number of items in the current page"},"lastEvaluatedKey":{"type":"string","description":"The last pagination key. Pass this in the next call to get the next page."},"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDto"}}},"required":["count","items"]},"FiledEventDto":{"type":"object","properties":{"folderUlid":{"type":"string","description":"The ulid of the folder to which this filed event belongs"},"folderName":{"type":"string","description":"The name of the folder to which this filed event belongs"},"documentUlid":{"type":"string","description":"The ulid of the parent document"},"documentExecutionUlid":{"type":"string","description":"The ulid of the document execution to which this filed event belongs"},"creationTimestamp":{"type":"string","description":"The timestamp indicating when this filed event was created, in ISO 8601 format.","example":"2025-01-31T15:34:18.242Z"},"lastModifiedTimestamp":{"type":"string","description":"The timestamp indicating the last time this filed event was modified, in ISO 8601 format","example":"2025-01-31T15:34:18.242Z"},"files":{"description":"An array of files linked to the filed event. A `context.json` file is always included, while additional files vary depending on the details specified in context.json. Returns an empty list for confirmed documents","type":"array","items":{"$ref":"#/components/schemas/FileDto"}},"status":{"type":"string","description":"The status of the filed event","enum":["NEW","PROCESSED","FAILED"],"example":"PROCESSED"},"externalReference":{"type":"string","description":"An external reference provided by the client."},"filterExpressions":{"description":"filterExpressions used to file the event","type":"array","items":{"type":"string"}}},"required":["folderUlid","folderName","documentUlid","documentExecutionUlid","creationTimestamp","lastModifiedTimestamp","files","status","filterExpressions"]},"FiledEventPageDto":{"type":"object","properties":{"count":{"type":"number","description":"Number of items in the current page"},"lastEvaluatedKey":{"type":"string","description":"The last pagination key. Pass this in the next call to get the next page."},"items":{"type":"array","items":{"$ref":"#/components/schemas/FiledEventDto"}}},"required":["count","items"]},"CreateFileUploadRequestDto":{"type":"object","properties":{"externalReference":{"type":"string","description":"External reference for tracking the document upload","example":"DOC-12345"},"contentType":{"type":"string","description":"Content type of the file to be uploaded","example":"application/json","enum":["application/json","application/xml"]},"metadata":{"type":"object","description":"Metadata about the file upload.","example":{"type":"invoice"}}},"required":["contentType"]},"FileUploadResponseDto":{"type":"object","properties":{"ulid":{"type":"string","example":"01HSZZ39TECCTQ0G9DC9ZEDSV7"},"status":{"type":"string","example":"NEW"},"externalReference":{"type":"string","example":"DOC-12345"},"organizationUlid":{"type":"string","example":"01HG4K8V9Y7J2ZQ8W3X5T1B6M4"},"creationTimestamp":{"type":"string","example":"2023-10-05T14:48:00.000Z"},"lastModifiedTimestamp":{"type":"string","example":"2023-10-05T14:48:00.000Z"},"metadata":{"type":"object","description":"Metadata about the file upload.","example":{"key":"value"}}},"required":["ulid","status","organizationUlid","creationTimestamp","lastModifiedTimestamp"]},"CreateFileUploadResponseDto":{"type":"object","properties":{"message":{"type":"string","example":"FileUpload created successfully"},"fileUpload":{"$ref":"#/components/schemas/FileUploadResponseDto"},"preSignedUploadUrl":{"type":"string","description":"Presigned URL for uploading the document","example":"https://s3.eu-central-1.amazonaws.com/.../upload.json?signature=..."}},"required":["message","fileUpload","preSignedUploadUrl"]}},"securitySchemes":{"oauth2-cc":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://dev-portal.dokapi.io/api/oauth2/token","scopes":{}}},"description":"This API uses OAuth2 Client Credentials. Client credentials can be retrieved from the subscription details.<br/><br/>The endpoints to which you have access depend on your subscription. If an endpoint does not appear to be available, it might not be included in your current subscription.","x-receive-token-in":"request-body","x-client-id":"","x-client-secret":""}}},"security":[{"oauth2-cc":[]}]}