---
updatedAt: 2026-05-27T12:36:19.000Z
agentTools:
projectIndex: https://developer.candis.io/llms.txt
---
# Create an Export
Create an Export and return basic details. Initial status of the Export will be "EXPORTING".
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"paths": {
"/v1/organizations/{organizationId}/exports": {
"post": {
"description": "Create an Export and return basic details. Initial status of the Export will be \"EXPORTING\".",
"operationId": "createExport",
"parameters": [
{
"name": "organizationId",
"required": true,
"in": "path",
"description": "The organization ID.",
"schema": {
"format": "slug",
"example": "alpha-organization",
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"description": "Posting Type for which you need to create an Export for.",
"example": "DOCUMENT",
"default": "DOCUMENT",
"enum": [
"DOCUMENT",
"REIMBURSEMENT_ITEM",
"CARD_TRANSACTION"
],
"nullable": true
}
}
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the export.",
"example": "86e29aff-ba75-492d-85f6-80d802c4fe69"
},
"postingsCount": {
"type": "number",
"description": "The number of postings in the export.",
"example": 10
},
"status": {
"type": "string",
"description": "Current status of the export.
EXPORTING: The export is in progress.",
"example": "EXPORTING",
"enum": [
"EXPORTING"
]
},
"createdAt": {
"format": "date-time",
"type": "string",
"description": "The date and time when the export was initiated.",
"example": "2021-08-31T12:00:00Z"
}
},
"required": [
"id",
"postingsCount",
"status",
"createdAt"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "The Error Code assigned to the issue encountered",
"enum": [
"UNAUTHORIZED",
"FORBIDDEN",
"BAD_REQUEST",
"SERVICE_UNAVAILABLE",
"INTERNAL_SERVER_ERROR",
"MISSING_REQUESTER_ID",
"BAD_INPUT",
"NOT_FOUND",
"EXPORTABLE_POSTINGS_NOT_FOUND",
"TOO_MANY_REQUEST",
"FAILED_TO_FETCH_DOWNLOAD_URL",
"FILE_NOT_FOUND"
]
},
"message": {
"type": "string",
"description": "Description about the issue encountered"
},
"requestId": {
"type": "string",
"description": "This is the unique identifier for the request."
},
"errors": {
"description": "This is an optional output that can provide more details about the input parameters that may have caused an issue.",
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "string",
"description": "This identifies the index of the payload that has an issue."
},
"property": {
"type": "string",
"description": "This identifies the parameter that has an issue."
},
"messages": {
"description": "This provides more details about the parameter that has an issue.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"property",
"messages"
]
}
}
},
"required": [
"errorCode",
"message"
]
}
}
}
},
"429": {
"description": "The request limit for this organization, or for its holding, has been exceeded.\n\nSee the [Rate Limiting Policy](https://developer.candis.io/docs/rate-limiting-policy) for the limits, response headers and retry guidance.",
"headers": {
"Retry-After": {
"description": "Whole seconds to wait before retrying. See the Rate Limiting Policy for how the value is derived.",
"schema": {
"type": "integer",
"example": 42
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "The Error Code assigned to the issue encountered",
"enum": [
"UNAUTHORIZED",
"FORBIDDEN",
"BAD_REQUEST",
"SERVICE_UNAVAILABLE",
"INTERNAL_SERVER_ERROR",
"MISSING_REQUESTER_ID",
"BAD_INPUT",
"NOT_FOUND",
"EXPORTABLE_POSTINGS_NOT_FOUND",
"TOO_MANY_REQUEST",
"FAILED_TO_FETCH_DOWNLOAD_URL",
"FILE_NOT_FOUND"
]
},
"message": {
"type": "string",
"description": "Description about the issue encountered"
},
"requestId": {
"type": "string",
"description": "This is the unique identifier for the request."
},
"limit": {
"type": "string",
"description": "Which limit rejected the request: the request limit, which counts requests, or the record limit, which meters the records in the request body.",
"enum": [
"request",
"record"
]
},
"scope": {
"type": "string",
"description": "Whose allowance was exhausted: the organization’s own, or the shared allowance of the holding it belongs to.",
"enum": [
"organization",
"holding"
]
}
},
"required": [
"errorCode",
"message"
]
}
}
}
},
"503": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "The Error Code assigned to the issue encountered",
"enum": [
"UNAUTHORIZED",
"FORBIDDEN",
"BAD_REQUEST",
"SERVICE_UNAVAILABLE",
"INTERNAL_SERVER_ERROR",
"MISSING_REQUESTER_ID",
"BAD_INPUT",
"NOT_FOUND",
"EXPORTABLE_POSTINGS_NOT_FOUND",
"TOO_MANY_REQUEST",
"FAILED_TO_FETCH_DOWNLOAD_URL",
"FILE_NOT_FOUND"
]
},
"message": {
"type": "string",
"description": "Description about the issue encountered"
},
"requestId": {
"type": "string",
"description": "This is the unique identifier for the request."
}
},
"required": [
"errorCode",
"message"
]
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "Create an Export",
"tags": [
"Exports"
]
}
}
},
"info": {
"title": "Candis API",
"version": "1.0",
"description": "",
"contact": {},
"x-logo": {
"url": "https://www.candis.io/img/candis-logo-black.svg",
"altText": "Candis GmbH"
}
},
"servers": [
{
"url": "https://api.candis.io"
},
{
"description": "Candis API Authorization Server.",
"url": "https://id.my.candis.io/auth/realms/candis/protocol/openid-connect"
}
],
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"bearerFormat": "JWT",
"type": "http"
}
}
}
}
```