FOS Export Job

FOS Export Job - Get

HTTP Request

GET /api/v1/exports/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific financial entity’s organizational structure and hierarchy using the provided identifier.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Update

HTTP Request

PUT /api/v1/exports/{id}

Interactive Demo

📋 Description: Updates the financial organization structure for a specified entity, allowing users to modify the hierarchy and relationships within the organization.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	FosExportJobDto	true	Request body containing the updated financial organization structure data, including hierarchy details and attributes for the specified financial entity.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "batchSize": 1000,
  "totalObjectCount": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "fileStorageId": "string",
  "generatingExportFile": true,
  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "readOnly": true,
  "docStoreId": 0,
  "erpSystemId": 0,
  "category": "NON_ERP",
  "items": [
    "INTERNAL_ASSET_CLASS"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Create Or Update Bulk

HTTP Request

PUT /api/v1/exports/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple financial entities within the organizational structure, allowing for efficient management of hierarchy and relationships in a bulk operation.

Parameters

Name	In	Type	Required	Description
body	body	FosExportJobDto	true	Request body containing bulk data for creating or updating financial organization structures, including details on hierarchy and associated financial entities.

Body Parameters

[
  {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "fileStorageId": "string",
      "generatingExportFile": true,
      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
      "version": 0,
      "readOnly": true,
      "docStoreId": 0,
      "erpSystemId": 0,
      "category": "NON_ERP",
      "items": [
        "INTERNAL_ASSET_CLASS"
      ]
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Create Or Update

HTTP Request

PUT /api/v1/exports/createOrUpdate

Interactive Demo

📋 Description: Creates or updates the financial organization structure by submitting a comprehensive hierarchy of financial entities, ensuring accurate representation and alignment within the organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	FosExportJobDto	true	Request body containing the financial organization structure data, including details on the hierarchy and attributes of the financial entities to be created or updated.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "batchSize": 1000,
  "totalObjectCount": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "fileStorageId": "string",
  "generatingExportFile": true,
  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "readOnly": true,
  "docStoreId": 0,
  "erpSystemId": 0,
  "category": "NON_ERP",
  "items": [
    "INTERNAL_ASSET_CLASS"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Bulk Update

HTTP Request

PUT /api/v1/exports/bulk

Interactive Demo

📋 Description: Updates the financial organization structure in bulk, allowing for the efficient modification of hierarchies and relationships among financial entities.

Parameters

Name	In	Type	Required	Description
body	body	FosExportJobDto	true	Request body containing the hierarchical structure data of financial entities for bulk export, including organization details and associated metadata.

Body Parameters

[
  {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "fileStorageId": "string",
      "generatingExportFile": true,
      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
      "version": 0,
      "readOnly": true,
      "docStoreId": 0,
      "erpSystemId": 0,
      "category": "NON_ERP",
      "items": [
        "INTERNAL_ASSET_CLASS"
      ]
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - List Export Types

HTTP Request

POST /api/v1/exports/types

Interactive Demo

📋 Description: Creates a new export type for the financial organization structure, enabling the definition and management of hierarchical relationships within financial entities.

Parameters

Name	In	Type	Required	Description
body	body	FosExportJobDto	true	Request body containing the financial organization structure data, including details on hierarchy and entity classifications.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "batchSize": 1000,
  "totalObjectCount": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "fileStorageId": "string",
  "generatingExportFile": true,
  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "readOnly": true,
  "docStoreId": 0,
  "erpSystemId": 0,
  "category": "NON_ERP",
  "items": [
    "INTERNAL_ASSET_CLASS"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "INTERNAL_ASSET_CLASS"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Search Tasks

HTTP Request

POST /api/v1/exports/tasks/search

Interactive Demo

📋 Description: Submits a request to search for financial entity tasks within the organizational structure, allowing users to efficiently navigate and manage hierarchical relationships.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing search criteria for financial organization tasks, including parameters to filter by organizational structure and hierarchy.
» filter	body	FosExportTaskDtoFilter	false	Data transfer object representing a filter for export tasks within the financial organization structure, enabling users to refine and manage hierarchical data related to financial entities.
»» idIn	body	[integer]	false	Filter by multiple values of id
»» idEqual	body	integer(int64)	false	Filter by exact match of id
»» idLike	body	string	false	Filter by partial match of id
»» createdAtGreaterThanOrEqual	body	string(date-time)	false	Filter where created at is greater than or equal to specified value
»» createdAtLessThanOrEqual	body	string(date-time)	false	Filter where created at is less than or equal to specified value
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» modifiedAtGreaterThanOrEqual	body	string(date-time)	false	Filter where modified at is greater than or equal to specified value
»» modifiedAtLessThanOrEqual	body	string(date-time)	false	Filter where modified at is less than or equal to specified value
»» modifiedByLike	body	string	false	Filter by partial match of modified by
»» modifiedByEqual	body	string	false	Filter by exact match of modified by
»» queueTimeGreaterThanOrEqual	body	string(date-time)	false	Filter where queue time is greater than or equal to specified value
»» queueTimeLessThanOrEqual	body	string(date-time)	false	Filter where queue time is less than or equal to specified value
»» startTimeGreaterThanOrEqual	body	string(date-time)	false	Filter where start time is greater than or equal to specified value
»» startTimeLessThanOrEqual	body	string(date-time)	false	Filter where start time is less than or equal to specified value
»» endTimeGreaterThanOrEqual	body	string(date-time)	false	Filter where end time is greater than or equal to specified value
»» endTimeLessThanOrEqual	body	string(date-time)	false	Filter where end time is less than or equal to specified value
»» statusIn	body	[string]	false	Filter by multiple values of status
»» statusEqual	body	string	false	Filter by exact match of status
»» jobIdEqual	body	integer(int64)	false	Filter by exact match of job id
»» itemsExcelItemTypeIn	body	[string]	false	Filter by multiple values of items excel item type
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of financial entities within an organization’s hierarchical structure, facilitating efficient retrieval and management of organizational data.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Enumerated Values

Attribute	Value
»» itemsExcelItemTypeIn	ACCOUNTING_STANDARD, ACCOUNTING_STANDARD_DETERMINATION, AGREEMENT_GROUP, ALTERNATE_EXCHANGE_RATE, ASSET, ASSET_CLASS, ASSET_CLASS_DETERMINATION, ASSET_TRANSACTION_TYPE_DETERMINATION, BUSINESS_AREA, BUSINESS_UNIT, BUSINESS_UNIT_TO_COMPANY, CHART_OF_ACCOUNT, CHART_OF_DEPRECIATION, COMPANY, COMPANY_FINANCIAL_SETTING, COMPANY_TO_ACCOUNTING_STANDARD, COMPANY_TO_CONSUMER_PRICE_INDEX_CATEGORY, COMPANY_TO_COST_CENTER, COMPANY_TO_DEPARTMENT, COMPANY_TO_GENERAL_LEDGER_ACCOUNT, COMPANY_TO_PARTNER, COMPANY_TO_PROJECT, COMPANY_TO_TRANSFER_VARIANT, CONSUMER_PRICE_INDEX_CATEGORY, CONSUMER_PRICE_INDEX_VALUE, CONTACT_ROLE, CONTRACT_CATEGORY_GROUP, CONTRACT_GROUP_1, CONTRACT_GROUP_2, CONTROLLING_AREA, COST_CENTER, COST_CENTER_TO_PROFIT_CENTER, COUNTRY, CURRENCY, DEPARTMENT, DEPARTMENT_TO_LEASE_GROUP, DEPRECIATION_AREA, DEPRECIATION_AREA_DETERMINATION, DOCUMENT_TYPE, DOCUMENT_TYPE_DETERMINATION, END_OF_TERM_DETERMINATION, END_OF_TERM_MAPPING, ERP_SYSTEM, EXCHANGE_RATE, EXCHANGE_RATE_TYPE, EXPENSE_ACCOUNT_DETERMINATION, EXPENSE_CATEGORY, FISCAL_PERIOD, FISCAL_VARIANT, FUNCTIONAL_AREA, GENERAL_LEDGER_ACCOUNT, GENERAL_SETTING, INCREMENTAL_BORROWING_RATE, INTERNAL_ASSET_CLASS, INTERNAL_ORDER, INTERNAL_ORDER_TYPE, INVOICE_REJECTION_REASON, LEASE_AREA, LEASE_AREA_TO_BUSINESS_UNIT, LEASE_GROUP, LESSEE_ACCOUNT_DETERMINATION, LESSEE_ACCOUNT_MAPPING, LESSEE_ASSET_TRANSACTION_TYPE_MAPPING, LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LESSOR_ACCOUNT_DETERMINATION, LESSOR_ACCOUNT_MAPPING, LESSOR_ASSET_TRANSACTION_TYPE_MAPPING, LESSOR_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LOCATION, MODULE_MANAGEMENT, NAKISA_COMPANY, NETWORK, NON_LEASE_DOCUMENT_TYPE_DETERMINATION, NON_LEASE_LESSEE_ACCOUNT_DETERMINATION, NON_LEASE_LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, NON_LEASE_LESSEE_GL_ACCOUNT_MAPPING, NON_LEASE_LESSOR_ACCOUNT_DETERMINATION, NON_LEASE_LESSOR_ACCOUNT_MAPPING, NUMBER_RANGE_CONFIG, PARTNER, PARTNER_CONTACT, PARTNER_CONTACT_TO_CONTACT_ROLE, PARTNER_ROLE, PARTNER_TO_PARTNER_CONTACT, PARTNER_TO_PARTNER_ROLE, PAYMENT_BLOCK, PAYMENT_METHOD, PAYMENT_TERM, PLANT, POSTING_PERIOD_CONTROL, POSTING_PERIOD_VARIANT, PROFILE, PROFIT_CENTER, PROJECT, PURCHASE_ORDER, PURCHASING_ORGANIZATION, REGION, REVERSAL_REASON, SEGMENT, SYSTEM_FINANCIAL_SETTING, TAX_CODE, TAX_CODE_DETERMINATION, TAX_CODE_EXPENSE_CATEGORY_MAPPING, TAX_JURISDICTION, TAX_RATE_DETERMINATION, TAX_RATE_MAPPING, TRADING_PARTNER, TRANSACTION_TYPE, TRANSFER_VARIANT, UNIT_OF_MEASURE, USER_PROFILE, VENDOR_GENERAL_LEDGER_DETERMINATION, VENDOR_GENERAL_LEDGER_EXPENSE_CATEGORY_ACCOUNT_MAPPING, VENDOR_SECURITY_PROFILE, WORK_BREAKDOWN_STRUCTURE
»» statusEqual	CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED
»» statusIn	CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedByLike": "string",
    "modifiedByEqual": "string",
    "queueTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "queueTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
    "startTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "startTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
    "endTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "endTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
    "statusIn": [
      "CREATED"
    ],
    "statusEqual": "CREATED",
    "jobIdEqual": 0,
    "itemsExcelItemTypeIn": [
      "INTERNAL_ASSET_CLASS"
    ]
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFosExportTaskDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "interruptedAt": "2019-08-24T14:15:22Z",
      "recoveredAt": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "recover": true,
      "interrupted": true,
      "interruptionMessage": "string",
      "errorMessage": "string",
      "totalObjectCount": 0,
      "jobId": 0,
      "erpSystemId": 0,
      "items": [
        {
          "id": 0,
          "exportTaskId": 0,
          "excelItemType": "INTERNAL_ASSET_CLASS",
          "startedAt": "2019-08-24T14:15:22Z",
          "finishedAt": "2019-08-24T14:15:22Z",
          "doneItemCount": 0,
          "failedItemCount": 0,
          "cancelledItemCount": 0,
          "totalItemCount": 0
        }
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Search

HTTP Request

POST /api/v1/exports/search

Interactive Demo

📋 Description: Submits a request to export search results related to the financial organization structure, enabling users to analyze and retrieve hierarchical data of financial entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	FosExportJobDtoFilter	false	Request body containing the search criteria and filters for retrieving financial organization structure data, including hierarchy and entity details.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "erpSystemIdIn": [
    0
  ],
  "categoryIn": [
    "NON_ERP"
  ],
  "itemsIn": [
    "INTERNAL_ASSET_CLASS"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFosExportJobDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "fileStorageId": "string",
      "generatingExportFile": true,
      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
      "version": 0,
      "readOnly": true,
      "docStoreId": 0,
      "erpSystemId": 0,
      "category": "NON_ERP",
      "items": [
        "INTERNAL_ASSET_CLASS"
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Search Details

HTTP Request

POST /api/v1/exports/reports/details/search

Interactive Demo

📋 Description: Submits a request to search for detailed reports within the financial organization structure, allowing users to explore the hierarchy and relationships of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing detailed search criteria for financial entity reports, including organization structure and hierarchy parameters.
» filter	body	FosExportItemReportDtoFilter	false	Data transfer object representing a filter for generating export reports related to financial entities within an organization’s structure and hierarchy.
»» reportTypeEqual	body	string	false	Filter by exact match of report type
»» itemIdIn	body	[integer]	false	Filter by multiple values of item id
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of financial entities within an organization’s hierarchical structure, facilitating efficient retrieval and management of organizational data.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Enumerated Values

Attribute	Value
»» reportTypeEqual	ERROR, SKIPPED, SUCCESS, WARNING

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "reportTypeEqual": "SUCCESS",
    "itemIdIn": [
      0
    ]
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFosExportItemReportDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "rowIdentifier": "string",
      "reportType": "SUCCESS",
      "message": "string",
      "itemId": 0
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Cancel

HTTP Request

POST /api/v1/exports/cancel/{id}

Interactive Demo

📋 Description: Cancels a specified export operation within the financial organization structure, allowing for the effective management of organizational hierarchies and financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Cancel All

HTTP Request

POST /api/v1/exports/cancel/bulk

Interactive Demo

📋 Description: Initiates the cancellation of multiple export requests within the financial organization structure, allowing users to efficiently manage and adjust their hierarchical data operations.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers for bulk cancellation of export requests within the organizational structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Find All

HTTP Request

GET /api/v1/exports

Interactive Demo

📋 Description: Retrieves the organizational structure and hierarchy of financial entities, providing insights into the relationships and classifications within the financial organization.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the financial organization structure export should be returned in a paginated format, facilitating efficient data retrieval for large hierarchies.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFosExportJobDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "fileStorageId": "string",
      "generatingExportFile": true,
      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
      "version": 0,
      "readOnly": true,
      "docStoreId": 0,
      "erpSystemId": 0,
      "category": "NON_ERP",
      "items": [
        "INTERNAL_ASSET_CLASS"
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Create

HTTP Request

POST /api/v1/exports

Interactive Demo

📋 Description: Creates a new financial organization structure export, allowing users to define and manage the hierarchy of financial entities within their organization.

Parameters

Name	In	Type	Required	Description
body	body	FosExportJobDto	true	Request body containing the hierarchical structure and details of financial entities within the organization for export purposes.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "batchSize": 1000,
  "totalObjectCount": 0,
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "fileStorageId": "string",
  "generatingExportFile": true,
  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "readOnly": true,
  "docStoreId": 0,
  "erpSystemId": 0,
  "category": "NON_ERP",
  "items": [
    "INTERNAL_ASSET_CLASS"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosExportJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "fileStorageId": "string",
    "generatingExportFile": true,
    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
    "version": 0,
    "readOnly": true,
    "docStoreId": 0,
    "erpSystemId": 0,
    "category": "NON_ERP",
    "items": [
      "INTERNAL_ASSET_CLASS"
    ]
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Report By Task

HTTP Request

GET /api/v1/exports/reports/task/{taskId}

Interactive Demo

📋 Description: Retrieves the detailed report associated with a specific task identified by the {taskId} parameter, providing insights into the financial organization structure and hierarchy relevant to the task.

Parameters

Name	In	Type	Required	Description
taskId	path	integer(int64)	true	Unique identifier for the task

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "exportTaskId": 0,
    "excelItemType": "INTERNAL_ASSET_CLASS",
    "startedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "doneItemCount": 0,
    "failedItemCount": 0,
    "cancelledItemCount": 0,
    "totalItemCount": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[FosExportItemDto]	false	none	[Data transfer object representing an export item within the financial organization structure, encapsulating essential details about the entity’s hierarchy and organizational relationships.]
» id	integer(int64)	false	none	Unique identifier for the resource
» exportTaskId	integer(int64)	false	none	Unique identifier for the export task
» excelItemType	string	false	none	Type of the excel item
» startedAt	string(date-time)	false	none	Represents the date and time when the financial entity’s organizational structure was initiated, providing essential context for hierarchy and reporting purposes.
» finishedAt	string(date-time)	false	none	Timestamp indicating when the financial entity’s export process was completed within the organizational structure.
» doneItemCount	integer(int32)	false	none	Count of done item
» failedItemCount	integer(int32)	false	none	Count of failed item
» cancelledItemCount	integer(int32)	false	none	Count of cancelled item
» totalItemCount	integer(int32)	false	none	Count of total item

Enumerated Values

Attribute

Value

excelItemType

ACCOUNTING_STANDARD, ACCOUNTING_STANDARD_DETERMINATION, AGREEMENT_GROUP, ALTERNATE_EXCHANGE_RATE, ASSET, ASSET_CLASS, ASSET_CLASS_DETERMINATION, ASSET_TRANSACTION_TYPE_DETERMINATION, BUSINESS_AREA, BUSINESS_UNIT, BUSINESS_UNIT_TO_COMPANY, CHART_OF_ACCOUNT, CHART_OF_DEPRECIATION, COMPANY, COMPANY_FINANCIAL_SETTING, COMPANY_TO_ACCOUNTING_STANDARD, COMPANY_TO_CONSUMER_PRICE_INDEX_CATEGORY, COMPANY_TO_COST_CENTER, COMPANY_TO_DEPARTMENT, COMPANY_TO_GENERAL_LEDGER_ACCOUNT, COMPANY_TO_PARTNER, COMPANY_TO_PROJECT, COMPANY_TO_TRANSFER_VARIANT, CONSUMER_PRICE_INDEX_CATEGORY, CONSUMER_PRICE_INDEX_VALUE, CONTACT_ROLE, CONTRACT_CATEGORY_GROUP, CONTRACT_GROUP_1, CONTRACT_GROUP_2, CONTROLLING_AREA, COST_CENTER, COST_CENTER_TO_PROFIT_CENTER, COUNTRY, CURRENCY, DEPARTMENT, DEPARTMENT_TO_LEASE_GROUP, DEPRECIATION_AREA, DEPRECIATION_AREA_DETERMINATION, DOCUMENT_TYPE, DOCUMENT_TYPE_DETERMINATION, END_OF_TERM_DETERMINATION, END_OF_TERM_MAPPING, ERP_SYSTEM, EXCHANGE_RATE, EXCHANGE_RATE_TYPE, EXPENSE_ACCOUNT_DETERMINATION, EXPENSE_CATEGORY, FISCAL_PERIOD, FISCAL_VARIANT, FUNCTIONAL_AREA, GENERAL_LEDGER_ACCOUNT, GENERAL_SETTING, INCREMENTAL_BORROWING_RATE, INTERNAL_ASSET_CLASS, INTERNAL_ORDER, INTERNAL_ORDER_TYPE, INVOICE_REJECTION_REASON, LEASE_AREA, LEASE_AREA_TO_BUSINESS_UNIT, LEASE_GROUP, LESSEE_ACCOUNT_DETERMINATION, LESSEE_ACCOUNT_MAPPING, LESSEE_ASSET_TRANSACTION_TYPE_MAPPING, LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LESSOR_ACCOUNT_DETERMINATION, LESSOR_ACCOUNT_MAPPING, LESSOR_ASSET_TRANSACTION_TYPE_MAPPING, LESSOR_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LOCATION, MODULE_MANAGEMENT, NAKISA_COMPANY, NETWORK, NON_LEASE_DOCUMENT_TYPE_DETERMINATION, NON_LEASE_LESSEE_ACCOUNT_DETERMINATION, NON_LEASE_LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, NON_LEASE_LESSEE_GL_ACCOUNT_MAPPING, NON_LEASE_LESSOR_ACCOUNT_DETERMINATION, NON_LEASE_LESSOR_ACCOUNT_MAPPING, NUMBER_RANGE_CONFIG, PARTNER, PARTNER_CONTACT, PARTNER_CONTACT_TO_CONTACT_ROLE, PARTNER_ROLE, PARTNER_TO_PARTNER_CONTACT, PARTNER_TO_PARTNER_ROLE, PAYMENT_BLOCK, PAYMENT_METHOD, PAYMENT_TERM, PLANT, POSTING_PERIOD_CONTROL, POSTING_PERIOD_VARIANT, PROFILE, PROFIT_CENTER, PROJECT, PURCHASE_ORDER, PURCHASING_ORGANIZATION, REGION, REVERSAL_REASON, SEGMENT, SYSTEM_FINANCIAL_SETTING, TAX_CODE, TAX_CODE_DETERMINATION, TAX_CODE_EXPENSE_CATEGORY_MAPPING, TAX_JURISDICTION, TAX_RATE_DETERMINATION, TAX_RATE_MAPPING, TRADING_PARTNER, TRANSACTION_TYPE, TRANSFER_VARIANT, UNIT_OF_MEASURE, USER_PROFILE, VENDOR_GENERAL_LEDGER_DETERMINATION, VENDOR_GENERAL_LEDGER_EXPENSE_CATEGORY_ACCOUNT_MAPPING, VENDOR_SECURITY_PROFILE, WORK_BREAKDOWN_STRUCTURE

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Report By Job

HTTP Request

GET /api/v1/exports/reports/job/{jobId}

Interactive Demo

📋 Description: Retrieves the export report associated with a specific job ID within the financial organization structure, providing insights into the hierarchy and organization of financial entities.

Parameters

Name	In	Type	Required	Description
jobId	path	integer(int64)	true	Unique identifier for the job

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "ids": [
      0
    ],
    "excelItemType": "INTERNAL_ASSET_CLASS",
    "startedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "doneItemCount": 0,
    "failedItemCount": 0,
    "cancelledItemCount": 0,
    "totalItemCount": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[FosJobExportItemDto]	false	none	[Data transfer object representing an export item related to job roles within the financial organization structure, facilitating the organization and hierarchy of financial entities.]
» ids	[integer]	false	none	List of ids items
» excelItemType	string	false	none	Type of the excel item
» startedAt	string(date-time)	false	none	Represents the date and time when the financial entity’s organizational structure was initiated, providing essential context for hierarchy and reporting purposes.
» finishedAt	string(date-time)	false	none	Timestamp indicating when the financial entity’s job export process was completed within the organizational structure.
» doneItemCount	integer(int32)	false	none	Count of done item
» failedItemCount	integer(int32)	false	none	Count of failed item
» cancelledItemCount	integer(int32)	false	none	Count of cancelled item
» totalItemCount	integer(int32)	false	none	Count of total item

Enumerated Values

Attribute

Value

excelItemType

ACCOUNTING_STANDARD, ACCOUNTING_STANDARD_DETERMINATION, AGREEMENT_GROUP, ALTERNATE_EXCHANGE_RATE, ASSET, ASSET_CLASS, ASSET_CLASS_DETERMINATION, ASSET_TRANSACTION_TYPE_DETERMINATION, BUSINESS_AREA, BUSINESS_UNIT, BUSINESS_UNIT_TO_COMPANY, CHART_OF_ACCOUNT, CHART_OF_DEPRECIATION, COMPANY, COMPANY_FINANCIAL_SETTING, COMPANY_TO_ACCOUNTING_STANDARD, COMPANY_TO_CONSUMER_PRICE_INDEX_CATEGORY, COMPANY_TO_COST_CENTER, COMPANY_TO_DEPARTMENT, COMPANY_TO_GENERAL_LEDGER_ACCOUNT, COMPANY_TO_PARTNER, COMPANY_TO_PROJECT, COMPANY_TO_TRANSFER_VARIANT, CONSUMER_PRICE_INDEX_CATEGORY, CONSUMER_PRICE_INDEX_VALUE, CONTACT_ROLE, CONTRACT_CATEGORY_GROUP, CONTRACT_GROUP_1, CONTRACT_GROUP_2, CONTROLLING_AREA, COST_CENTER, COST_CENTER_TO_PROFIT_CENTER, COUNTRY, CURRENCY, DEPARTMENT, DEPARTMENT_TO_LEASE_GROUP, DEPRECIATION_AREA, DEPRECIATION_AREA_DETERMINATION, DOCUMENT_TYPE, DOCUMENT_TYPE_DETERMINATION, END_OF_TERM_DETERMINATION, END_OF_TERM_MAPPING, ERP_SYSTEM, EXCHANGE_RATE, EXCHANGE_RATE_TYPE, EXPENSE_ACCOUNT_DETERMINATION, EXPENSE_CATEGORY, FISCAL_PERIOD, FISCAL_VARIANT, FUNCTIONAL_AREA, GENERAL_LEDGER_ACCOUNT, GENERAL_SETTING, INCREMENTAL_BORROWING_RATE, INTERNAL_ASSET_CLASS, INTERNAL_ORDER, INTERNAL_ORDER_TYPE, INVOICE_REJECTION_REASON, LEASE_AREA, LEASE_AREA_TO_BUSINESS_UNIT, LEASE_GROUP, LESSEE_ACCOUNT_DETERMINATION, LESSEE_ACCOUNT_MAPPING, LESSEE_ASSET_TRANSACTION_TYPE_MAPPING, LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LESSOR_ACCOUNT_DETERMINATION, LESSOR_ACCOUNT_MAPPING, LESSOR_ASSET_TRANSACTION_TYPE_MAPPING, LESSOR_EXPENSE_CATEGORY_ACCOUNT_MAPPING, LOCATION, MODULE_MANAGEMENT, NAKISA_COMPANY, NETWORK, NON_LEASE_DOCUMENT_TYPE_DETERMINATION, NON_LEASE_LESSEE_ACCOUNT_DETERMINATION, NON_LEASE_LESSEE_EXPENSE_CATEGORY_ACCOUNT_MAPPING, NON_LEASE_LESSEE_GL_ACCOUNT_MAPPING, NON_LEASE_LESSOR_ACCOUNT_DETERMINATION, NON_LEASE_LESSOR_ACCOUNT_MAPPING, NUMBER_RANGE_CONFIG, PARTNER, PARTNER_CONTACT, PARTNER_CONTACT_TO_CONTACT_ROLE, PARTNER_ROLE, PARTNER_TO_PARTNER_CONTACT, PARTNER_TO_PARTNER_ROLE, PAYMENT_BLOCK, PAYMENT_METHOD, PAYMENT_TERM, PLANT, POSTING_PERIOD_CONTROL, POSTING_PERIOD_VARIANT, PROFILE, PROFIT_CENTER, PROJECT, PURCHASE_ORDER, PURCHASING_ORGANIZATION, REGION, REVERSAL_REASON, SEGMENT, SYSTEM_FINANCIAL_SETTING, TAX_CODE, TAX_CODE_DETERMINATION, TAX_CODE_EXPENSE_CATEGORY_MAPPING, TAX_JURISDICTION, TAX_RATE_DETERMINATION, TAX_RATE_MAPPING, TRADING_PARTNER, TRANSACTION_TYPE, TRANSFER_VARIANT, UNIT_OF_MEASURE, USER_PROFILE, VENDOR_GENERAL_LEDGER_DETERMINATION, VENDOR_GENERAL_LEDGER_EXPENSE_CATEGORY_ACCOUNT_MAPPING, VENDOR_SECURITY_PROFILE, WORK_BREAKDOWN_STRUCTURE

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Generate Export File

HTTP Request

GET /api/v1/exports/generate/{id}

Interactive Demo

📋 Description: Generates and retrieves the export file for a specified financial entity’s organizational structure, identified by the unique ID provided in the path. This operation facilitates the analysis and management of hierarchical relationships within the financial organization.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Get Excel Categories

HTTP Request

GET /api/v1/exports/excel-categories

Interactive Demo

📋 Description: Retrieves a list of financial entity categories in Excel format, providing insights into the organization’s structure and hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NON_ERP"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

FOS Export Job - Download Export File

HTTP Request

GET /api/v1/exports/download/{id}

Interactive Demo

📋 Description: Downloads the specified financial organization structure export by its unique identifier, facilitating access to hierarchical data related to financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---