FOS Import Job

FOS Import Job - Get

HTTP Request

GET /api/v1/imports/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific financial entity’s organizational structure by its unique identifier, facilitating insights into the hierarchy and relationships within the 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	ResponseFosImportJobDto

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",
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "fileStorageId": "string",
    "importDocumentFileName": "string",
    "version": 0,
    "readOnly": true,
    "importDocumentStoreId": 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 Import Job - Update

HTTP Request

PUT /api/v1/imports/{id}

Interactive Demo

📋 Description: Updates the financial organization structure by modifying the details of a specified financial entity identified by its unique ID, ensuring alignment with the current organizational hierarchy.

Parameters

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

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosImportJobDto

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",
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "fileStorageId": "string",
    "importDocumentFileName": "string",
    "version": 0,
    "readOnly": true,
    "importDocumentStoreId": 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 Import Job - Create Or Update Bulk

HTTP Request

PUT /api/v1/imports/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple financial entities within the organization structure in a single request, ensuring alignment with the established hierarchy and organizational framework.

Parameters

Name	In	Type	Required	Description
body	body	FosImportJobDto	true	Request body containing bulk data for creating or updating financial entities within the organizational structure, including hierarchical relationships and relevant attributes.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFosImportJobDto

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",
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "fileStorageId": "string",
      "importDocumentFileName": "string",
      "version": 0,
      "readOnly": true,
      "importDocumentStoreId": 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 Import Job - Create Or Update

HTTP Request

PUT /api/v1/imports/createOrUpdate

Interactive Demo

📋 Description: Updates or creates financial entity records within the organizational structure, ensuring accurate representation of the hierarchy and relationships in the financial organization. This operation facilitates efficient management of organizational data by synchronizing changes in real-time.

Parameters

Name	In	Type	Required	Description
body	body	FosImportJobDto	true	Request body containing the financial organization structure data, including details for creating or updating the hierarchy of financial entities.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosImportJobDto

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",
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "fileStorageId": "string",
    "importDocumentFileName": "string",
    "version": 0,
    "readOnly": true,
    "importDocumentStoreId": 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 Import Job - Bulk Update

HTTP Request

PUT /api/v1/imports/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	FosImportJobDto	true	Request body containing bulk import data for financial organization structure, including details on hierarchy and relationships between financial entities.

Body Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListFosImportJobDto

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",
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "fileStorageId": "string",
      "importDocumentFileName": "string",
      "version": 0,
      "readOnly": true,
      "importDocumentStoreId": 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 Import Job - List Export Types

HTTP Request

POST /api/v1/imports/types

Interactive Demo

📋 Description: Creates new financial entity types within the organization structure, enabling the establishment of a hierarchical framework for effective financial management.

Parameters

Name	In	Type	Required	Description
body	body	FosImportJobDto	true	Request body containing the financial entity hierarchy data, including organization types and structural relationships essential for defining the organizational framework.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "queueTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "batchSize": 1000,
  "totalObjectCount": 0,
  "fileStorageId": "string",
  "importDocumentFileName": "string",
  "version": 0,
  "readOnly": true,
  "importDocumentStoreId": 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 Import Job - Download Template

HTTP Request

POST /api/v1/imports/template

Interactive Demo

📋 Description: Uploads a structured template for importing financial organization data, enabling the establishment or modification of the hierarchy within a financial entity.

Parameters

Name	In	Type	Required	Description
sampleData	query	boolean	false	Indicates whether to include sample data in the import template for defining the financial organization structure and hierarchy.
body	body	FosImportJobDto	true	Request body containing the financial organization structure template data, including hierarchical relationships and attributes of financial entities.

Default Values

Parameter	Default	Type
sampleData	true	query

Body Parameters

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

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 Import Job - Search Tasks

HTTP Request

POST /api/v1/imports/tasks/search

Interactive Demo

📋 Description: Submits a request to search for specific tasks within the financial organization structure, enabling users to efficiently navigate and manage the hierarchy of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the search criteria for financial entity tasks, including organization structure and hierarchy parameters.
» filter	body	FosImportTaskDtoFilter	false	Data transfer object representing a filter for FosImportTask, used to refine and manage the import tasks within the financial organization structure, ensuring alignment with organizational hierarchy and entity specifications.
»» 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	PageFosImportTaskDto

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,
          "importTaskId": 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 Import Job - Search

HTTP Request

POST /api/v1/imports/search

Interactive Demo

📋 Description: Submits a request to import and search for financial entities within the organization’s structure and hierarchy, enabling efficient management and analysis of financial data.

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	FosImportJobDtoFilter	false	Request body containing the financial organization structure data, including hierarchy details and attributes of the financial entities to be imported.

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	PageFosImportJobDto

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",
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "fileStorageId": "string",
      "importDocumentFileName": "string",
      "version": 0,
      "readOnly": true,
      "importDocumentStoreId": 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 Import Job - Search Details

HTTP Request

POST /api/v1/imports/reports/details/search

Interactive Demo

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

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing search criteria and filters for retrieving detailed reports on the financial organization structure and hierarchy of entities.
» filter	body	FosImportItemReportDtoFilter	false	Data transfer object representing a filter for generating reports on imported financial items within an organization’s structure, facilitating analysis of hierarchical relationships among financial entities.
»» 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	PageFosImportItemReportDto

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": [
    {
      "rowNumber": 0,
      "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 Import Job - Cancel

HTTP Request

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

Interactive Demo

📋 Description: Cancels an existing import operation identified by the specified ID within the financial organization structure, ensuring the integrity of the organizational hierarchy and data management processes.

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 Import Job - Cancel All

HTTP Request

POST /api/v1/imports/cancel/bulk

Interactive Demo

📋 Description: Initiates a bulk cancellation of import requests within the financial organization structure, allowing users to efficiently manage and adjust hierarchical data related to financial entities.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of financial entity identifiers and associated metadata for bulk cancellation of organization structure imports.

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 Import Job - Find All

HTTP Request

GET /api/v1/imports

Interactive Demo

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

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFosImportJobDto

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",
      "queueTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "batchSize": 1000,
      "totalObjectCount": 0,
      "fileStorageId": "string",
      "importDocumentFileName": "string",
      "version": 0,
      "readOnly": true,
      "importDocumentStoreId": 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 Import Job - Create

HTTP Request

POST /api/v1/imports

Interactive Demo

📋 Description: Submits a new financial organization structure import, enabling the integration of hierarchical data for financial entities within the system.

Parameters

Name	In	Type	Required	Description
body	body	object	true	Request body containing the financial organization structure data, including details on hierarchy and relationships between financial entities.
» request	body	FosImportJobDto	true	Data transfer object representing an import job for financial organization structures, encapsulating details related to the hierarchy and configuration of financial entities within the organization.
»» id	body	integer(int64)	false	Unique identifier for the resource
»» taskCount	body	integer(int32)	false	Count of task
»» failedTaskCount	body	integer(int32)	false	Count of failed task
»» doneTaskCount	body	integer(int32)	false	Count of done task
»» inProgressTaskCount	body	integer(int32)	false	Count of in progress task
»» cancelledTaskCount	body	integer(int32)	false	Count of cancelled task
»» errorMessage	body	string	false	Descriptive message detailing any errors encountered during the import process of financial organization structures.
»» queueTime	body	string(date-time)	false	Time of the queue
»» startTime	body	string(date-time)	false	Time of the start
»» endTime	body	string(date-time)	false	Time of the end
»» status	body	string	false	Status of the resource
»» batchSize	body	integer(int32)	false	Numeric value representing batchSize
»» totalObjectCount	body	integer(int32)	false	Count of total object
»» fileStorageId	body	string	false	Unique identifier for the file storage
»» importDocumentFileName	body	string	false	Name of the import document file
»» version	body	integer(int32)	false	Numeric value representing version
»» readOnly	body	boolean	false	Boolean flag indicating readOnly status
»» importDocumentStoreId	body	integer(int64)	false	Unique identifier for the import document store
»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»» category	body	string	true	Category of the resource
»» items	body	[string]	false	List of items items
» file	body	string(binary)	true	none

Enumerated Values

Attribute	Value
»» category	DETERMINATION, ERP, INITIAL_DATA, NON_ERP, SECURITY, SETTING
»» items	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
»» status	CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED

Parameter Constraints

Parameter	Constraints
»» batchSize	Min: 1000, Max: 15000

Body Parameters

{
    "file": "string",
    "request": {
        "batchSize": 1000,
        "cancelledTaskCount": 0,
        "category": "NON_ERP",
        "doneTaskCount": 0,
        "endTime": "2019-08-24 14:15:22+00:00",
        "erpSystemId": 0,
        "errorMessage": "string",
        "failedTaskCount": 0,
        "fileStorageId": "string",
        "id": 0,
        "importDocumentFileName": "string",
        "importDocumentStoreId": 0,
        "inProgressTaskCount": 0,
        "items": [
            "INTERNAL_ASSET_CLASS"
        ],
        "queueTime": "2019-08-24 14:15:22+00:00",
        "readOnly": true,
        "startTime": "2019-08-24 14:15:22+00:00",
        "status": "CREATED",
        "taskCount": 0,
        "totalObjectCount": 0,
        "version": 0
    }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseFosImportJobDto

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",
    "queueTime": "2019-08-24T14:15:22Z",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "batchSize": 1000,
    "totalObjectCount": 0,
    "fileStorageId": "string",
    "importDocumentFileName": "string",
    "version": 0,
    "readOnly": true,
    "importDocumentStoreId": 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 Import Job - Report By Task

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed reports for a specific import task identified by the provided task ID, facilitating insights into the financial organization structure and hierarchy of the associated financial entity.

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,
    "importTaskId": 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	[FosImportItemDto]	false	none	[Data transfer object representing an import item within the financial organization structure, encapsulating details related to the hierarchy and classification of financial entities.]
» id	integer(int64)	false	none	Unique identifier for the resource
» importTaskId	integer(int64)	false	none	Unique identifier for the import 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 management and reporting.
» finishedAt	string(date-time)	false	none	Represents the date and time when the financial entity’s import 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 Import Job - Report By Job

HTTP Request

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

Interactive Demo

📋 Description: Retrieves detailed reports for a specific import job identified by the jobId, providing insights into the financial organization structure and hierarchy of the associated financial entity.

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	[FosJobImportItemDto]	false	none	[Data transfer object representing an import item for financial job structures within an organization, facilitating the management of hierarchical relationships and organizational 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 import process was initiated.
» finishedAt	string(date-time)	false	none	Timestamp indicating when the financial job import process was completed, essential for tracking the status within the organization’s financial hierarchy.
» 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 Import Job - Get Excel Categories

HTTP Request

GET /api/v1/imports/excel-categories

Interactive Demo

📋 Description: Retrieves a list of Excel categories used within the financial organization structure, facilitating the understanding of the hierarchy and classification of financial entities.

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 Import Job - Download Xlsx Report

HTTP Request

GET /api/v1/imports/download_xlsx_report/{id}

Interactive Demo

📋 Description: Downloads the specified XLSX report for the financial organization structure identified by the provided ID, facilitating analysis of the hierarchy and relationships within the financial entity.

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 Import Job - Download Original Import File

HTTP Request

GET /api/v1/imports/download_original/{id}

Interactive Demo

📋 Description: Downloads the original document associated with a specified financial entity import, enabling users to access and review the foundational data within the organization’s hierarchical structure.

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

---