Company Financial Setting

Company Financial Setting - Get

HTTP Request

GET /api/v1/company-financial-settings/{id}

Interactive Demo

📋 Description: Retrieves the financial settings for a specified company, providing essential details about the organization’s financial structure and hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Company Financial Setting - Update

HTTP Request

PUT /api/v1/company-financial-settings/{id}

Interactive Demo

📋 Description: Updates the financial settings of a specified company within the organizational structure, allowing for adjustments to the hierarchy and configuration of financial entities. This operation ensures that financial data aligns with the current organizational needs and compliance requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	CompanyFinancialSettingDto	true	Request body containing the financial settings data for the specified company, including parameters that define the organization’s financial hierarchy and structure.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
  "value": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Company Financial Setting - Delete

HTTP Request

DELETE /api/v1/company-financial-settings/{id}

Interactive Demo

📋 Description: Deletes the specified financial settings for a company, thereby removing its associated financial entity from the organizational structure and hierarchy.

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Company Financial Setting - Create Or Update Bulk

HTTP Request

PUT /api/v1/company-financial-settings/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple financial settings for organizations within the financial entity hierarchy, ensuring alignment with the overall organizational structure.

Parameters

Name	In	Type	Required	Description
body	body	CompanyFinancialSettingDto	true	Request body containing bulk financial settings data for multiple financial entities, structured to reflect the organization’s hierarchy and operational requirements.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Company Financial Setting - Create Or Update

HTTP Request

PUT /api/v1/company-financial-settings/createOrUpdate

Interactive Demo

📋 Description: Creates or updates financial settings for a specified company within the organizational structure, ensuring alignment with the established financial hierarchy and entity requirements.

Parameters

Name	In	Type	Required	Description
body	body	CompanyFinancialSettingDto	true	Request body containing the financial settings data for creating or updating the organization’s financial structure and hierarchy.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
  "value": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Company Financial Setting - Bulk Update

HTTP Request

PUT /api/v1/company-financial-settings/bulk

Interactive Demo

📋 Description: Updates the financial settings for multiple entities within the organization’s structure, enabling efficient management of financial hierarchies and configurations.

Parameters

Name	In	Type	Required	Description
body	body	CompanyFinancialSettingDto	true	Request body containing bulk financial settings data for the organization’s structure and hierarchy, enabling updates to multiple financial entities simultaneously.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Company Financial Setting - Bulk Create

HTTP Request

POST /api/v1/company-financial-settings/bulk

Interactive Demo

📋 Description: Submits bulk financial settings for multiple entities within the organization’s financial structure, enabling efficient updates to the hierarchy and configuration of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	CompanyFinancialSettingDto	true	Request body containing bulk financial settings data for multiple financial entities, structured to reflect the organization’s hierarchy and organizational structure.

Body Parameters

[
  {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ]
}

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

Company Financial Setting - Bulk Delete

HTTP Request

DELETE /api/v1/company-financial-settings/bulk

Interactive Demo

📋 Description: Deletes multiple financial settings associated with the company’s organizational structure, ensuring the hierarchy and financial entity configurations are accurately maintained.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of financial entity identifiers for bulk deletion within the organization’s financial structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

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

Company Financial Setting - Search

HTTP Request

POST /api/v1/company-financial-settings/search

Interactive Demo

📋 Description: Submits a request to search for financial settings within the organization’s structure, enabling users to identify and manage financial entities based on specified criteria.

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	CompanyFinancialSettingDtoFilter	false	Request body containing the financial entity search criteria, including organization structure and hierarchy parameters, to facilitate targeted retrieval of company financial settings.

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",
  "companySettingTypeIn": [
    "CLASSIFICATION_PERCENTAGE_TERM"
  ],
  "valueEqual": "string",
  "valueLike": "string",
  "companyIdEqual": 0,
  "companyDisplayIdLike": "string",
  "erpSystemIdEqual": 0,
  "erpSystemDisplayIdEqual": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyFinancialSettingDto

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,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "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

Company Financial Setting - Is Accounts Payable Enabled For Companies

HTTP Request

POST /api/v1/company-financial-settings/is-accounts-payable-enabled

Interactive Demo

📋 Description: Enables or disables the accounts payable feature for a specified financial entity within the organizational structure, allowing for tailored financial management based on the company’s hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	false	Request body containing the financial entity settings data to determine if accounts payable functionality is enabled within the organization’s financial structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

{
  "property1": true,
  "property2": true
}

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	boolean	false	none	none

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

Company Financial Setting - Find All

HTTP Request

GET /api/v1/company-financial-settings

Interactive Demo

📋 Description: Retrieves the financial settings associated with the company’s organizational structure, providing insights into the hierarchy and configuration of financial entities. This operation is essential for understanding and managing the financial framework within the organization.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the financial settings retrieval should be paginated, facilitating efficient navigation through the organization’s financial entity hierarchy.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyFinancialSettingDto

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,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "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

Company Financial Setting - Create

HTTP Request

POST /api/v1/company-financial-settings

Interactive Demo

📋 Description: Creates or updates financial settings for a specified company within the organizational structure, ensuring alignment with the established financial hierarchy and entity requirements.

Parameters

Name	In	Type	Required	Description
body	body	CompanyFinancialSettingDto	true	Request body containing the financial settings data for the organization’s structure and hierarchy, including parameters for managing financial entities.

Body Parameters

{
  "id": 0,
  "rowNumber": 0,
  "rowIdentifier": "string",
  "errors": [
    "string"
  ],
  "linkedErrors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "remarks": [
    "string"
  ],
  "skipMessage": "string",
  "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
  "value": "string",
  "companyId": 0,
  "companyDisplayId": "string",
  "erpSystemId": 0,
  "erpSystemDisplayId": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseCompanyFinancialSettingDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "rowNumber": 0,
    "rowIdentifier": "string",
    "errors": [
      "string"
    ],
    "linkedErrors": [
      "string"
    ],
    "warnings": [
      "string"
    ],
    "remarks": [
      "string"
    ],
    "skipMessage": "string",
    "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
    "value": "string",
    "companyId": 0,
    "companyDisplayId": "string",
    "erpSystemId": 0,
    "erpSystemDisplayId": "string"
  }
}

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

Company Financial Setting - Get Metadata

HTTP Request

GET /api/v1/company-financial-settings/meta

Interactive Demo

📋 Description: Retrieves metadata related to the financial settings of the organization, providing insights into the structure and hierarchy of financial entities within the organization. This operation supports effective management and alignment of financial resources.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "COMPANY_SETTING_TYPE"
]

Response Schema

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

Company Financial Setting - Find All By System ID

HTTP Request

GET /api/v1/company-financial-settings/erp-system/{systemId}

Interactive Demo

📋 Description: Retrieves the financial settings associated with a specific ERP system identified by the {systemId}, providing insights into the organization’s financial structure and hierarchy. This operation aids in managing and aligning financial entities within the broader organizational framework.

Parameters

Name	In	Type	Required	Description
systemId	path	integer(int64)	true	Unique identifier for the system
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating the retrieval of financial settings for a specified ERP system within the organizational structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyFinancialSettingDto

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,
      "rowNumber": 0,
      "rowIdentifier": "string",
      "errors": [
        "string"
      ],
      "linkedErrors": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "remarks": [
        "string"
      ],
      "skipMessage": "string",
      "companySettingType": "CLASSIFICATION_PERCENTAGE_TERM",
      "value": "string",
      "companyId": 0,
      "companyDisplayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string"
    }
  ],
  "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

---