General Ledger Report Profile

General Ledger Report Profile - Search

HTTP Request

POST /api/v1/general-ledger/report-profile/search

Interactive Demo

📋 Description: Submits a search request for report profiles within the General Ledger, enabling users to efficiently locate specific ledger entries, transactions, or accounts related to financial records.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing search criteria for retrieving general ledger report profiles, including parameters related to ledger entries, transactions, accounts, and financial records.
» filter	body	ReportProfileDtoFilter	false	Data transfer object representing a filter for report profiles within the General Ledger domain, facilitating the retrieval of ledger entries, transactions, accounts, and financial records based on specified criteria.
»» 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
»» nameLike	body	string	false	Filter by partial match of name
»» principalPositionTypeEqual	body	string	false	Filter by exact match of principal position type
»» erpSystemFilterTypeIn	body	[string]	false	Filter by multiple values of erp system filter type
»» erpSystemsIn	body	[ErpSystemLiteDto]	false	Filter by multiple values of erp systems
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» leaseAreaFilterTypeIn	body	[string]	false	Filter by multiple values of lease area filter type
»» leaseAreasIn	body	[LeaseAreaLiteDto]	false	Filter by multiple values of lease areas
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» businessUnitFilterTypeIn	body	[string]	false	Filter by multiple values of business unit filter type
»» businessUnitsIn	body	[BusinessUnitLiteDto]	false	Filter by multiple values of business units
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» companyFilterTypeIn	body	[string]	false	Filter by multiple values of company filter type
»» companyCodesIn	body	[CompanyLiteDto]	false	Filter by multiple values of company codes
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»»» countryId	body	integer(int64)	false	Unique identifier for the country
»»» countryDisplayId	body	string	false	Unique identifier for the country display
»»» name	body	string	false	none
»» departmentFilterTypeIn	body	[string]	false	Filter by multiple values of department filter type
»» leaseDepartmentsIn	body	[DepartmentLiteDto]	false	Filter by multiple values of lease departments
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» leaseGroupFilterTypeIn	body	[string]	false	Filter by multiple values of lease group filter type
»» leaseGroupsIn	body	[LeaseGroupLiteDto]	false	Filter by multiple values of lease groups
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» costCenterFilterTypeIn	body	[string]	false	Filter by multiple values of cost center filter type
»» costCentersIn	body	[CostCenterLiteDto]	false	Filter by multiple values of cost centers
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» profitCenterFilterTypeIn	body	[string]	false	Filter by multiple values of profit center filter type
»» profitCentersIn	body	[ProfitCenterLiteDto]	false	Filter by multiple values of profit centers
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»»» validTo	body	string(date)	false	Date until which the resource is valid
»»» erpSystemId	body	integer(int64)	false	Unique identifier for the erp system
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
»» workBreakdownStructureFilterTypeIn	body	[string]	false	Filter by multiple values of work breakdown structure filter type
»» workBreakdownStructuresIn	body	[WorkBreakdownStructureLiteDto]	false	Filter by multiple values of work breakdown structures
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» name	body	string	false	Name of the resource
»» objectStatusIn	body	[string]	false	Filter by multiple values of object status
»» securityProfileIdLike	body	string	false	Filter by partial match of security profile id
»» calendarTypeEqual	body	string	false	Filter by exact match of calendar type
»» fiscalVariantEqual	body	FiscalVariantLiteDto	false	Data transfer object representing a simplified fiscal variant, encapsulating essential details related to ledger entries, transactions, and accounts within the General Ledger domain for effective financial record management.
»»» id	body	integer(int64)	false	Unique identifier for the resource
»»» displayId	body	string	false	Unique identifier for the display
»»» status	body	string	false	Status of the resource
»»» isCalendarYear	body	boolean	false	Whether the resource is calendar year
»»» yearDependent	body	boolean	false	Boolean flag indicating yearDependent status
»»» erpSystemDisplayId	body	string	false	Unique identifier for the erp system display
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» businessUnitFilterTypeIn	ALL, LIST
»» calendarTypeEqual	FISCAL_VARIANT, REGULAR_CALENDAR, _360
»» companyFilterTypeIn	ALL, LIST
»» costCenterFilterTypeIn	ALL, LIST
»» departmentFilterTypeIn	ALL, LIST
»» erpSystemFilterTypeIn	ALL, LIST
»» leaseAreaFilterTypeIn	ALL, LIST
»» leaseGroupFilterTypeIn	ALL, LIST
»» objectStatusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» principalPositionTypeEqual	LESSEE, LESSOR
»» profitCenterFilterTypeIn	ALL, LIST
»» workBreakdownStructureFilterTypeIn	ALL, LIST
»»» status	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

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",
    "nameLike": "string",
    "principalPositionTypeEqual": "LESSEE",
    "erpSystemFilterTypeIn": [
      "ALL"
    ],
    "erpSystemsIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseAreaFilterTypeIn": [
      "ALL"
    ],
    "leaseAreasIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "businessUnitFilterTypeIn": [
      "ALL"
    ],
    "businessUnitsIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "companyFilterTypeIn": [
      "ALL"
    ],
    "companyCodesIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string",
        "countryId": 0,
        "countryDisplayId": "string",
        "name": "string"
      }
    ],
    "departmentFilterTypeIn": [
      "ALL"
    ],
    "leaseDepartmentsIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "leaseGroupFilterTypeIn": [
      "ALL"
    ],
    "leaseGroupsIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "costCenterFilterTypeIn": [
      "ALL"
    ],
    "costCentersIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "profitCenterFilterTypeIn": [
      "ALL"
    ],
    "profitCentersIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string",
        "validTo": "2019-08-24",
        "erpSystemId": 0,
        "erpSystemDisplayId": "string"
      }
    ],
    "workBreakdownStructureFilterTypeIn": [
      "ALL"
    ],
    "workBreakdownStructuresIn": [
      {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "name": "string"
      }
    ],
    "objectStatusIn": [
      "CREATED"
    ],
    "securityProfileIdLike": "string",
    "calendarTypeEqual": "REGULAR_CALENDAR",
    "fiscalVariantEqual": {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string"
    }
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageReportProfileDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string",
      "principalPositionType": "LESSEE",
      "erpSystemFilterType": "ALL",
      "erpSystems": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseAreaFilterType": "ALL",
      "leaseAreas": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "businessUnitFilterType": "ALL",
      "businessUnits": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "companyFilterType": "ALL",
      "companyCodes": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string"
        }
      ],
      "departmentFilterType": "ALL",
      "leaseDepartments": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "leaseGroupFilterType": "ALL",
      "leaseGroups": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "costCenterFilterType": "ALL",
      "costCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "profitCenterFilterType": "ALL",
      "profitCenters": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        }
      ],
      "workBreakdownStructureFilterType": "ALL",
      "workBreakdownStructures": [
        {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        }
      ],
      "objectStatus": "CREATED",
      "securityProfileId": 0,
      "calendarType": "REGULAR_CALENDAR",
      "fiscalVariant": {
        "id": 0,
        "displayId": "string",
        "status": "CREATED",
        "isCalendarYear": true,
        "yearDependent": true,
        "erpSystemDisplayId": "string"
      },
      "assetClassFilterType": "ALL",
      "assetClasses": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "functionalAreaFilterType": "ALL",
      "functionalAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "businessAreaFilterType": "ALL",
      "businessAreas": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "vendorFilterType": "ALL",
      "vendors": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "leaseClassificationFilterType": "ALL",
      "leaseClassifications": "string",
      "accountingStandardType": "string",
      "filterObjectDto": {
        "id": 0,
        "profileId": 0,
        "displayId": "string",
        "objectType": "string"
      },
      "scriptProfile": true
    }
  ],
  "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

General Ledger Report Profile - Search Lease Types

HTTP Request

POST /api/v1/general-ledger/report-profile/leaseTypes

Interactive Demo

📋 Description: Creates a new lease type entry within the general ledger report profile, enabling accurate categorization of financial records related to ledger entries and transactions.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "LEASE_CONTRACT_FIXED_PART_A"
]

Response Schema

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

General Ledger Report Profile - Get Lease Classification Types

HTTP Request

POST /api/v1/general-ledger/report-profile/lease-classifications

Interactive Demo

📋 Description: Creates a new lease classification report profile within the General Ledger, enabling users to categorize and manage financial records related to lease transactions effectively.

Parameters

Name	In	Type	Required	Description
body	body	LeaseClassificationTypeCustomRequest	true	Request body containing the lease classification data, including relevant ledger entry details and associated financial records for accurate transaction reporting.

Body Parameters

{
  "accountingStandardType": "GAAP",
  "principalPositionType": "LESSEE",
  "leaseTypes": [
    "LEASE_CONTRACT_FIXED_PART_A"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NON_LEASE"
]

Response Schema

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

General Ledger Report Profile - Search General Ledger Accounts

HTTP Request

POST /api/v1/general-ledger/report-profile/generalLedgers

Interactive Demo

📋 Description: Creates a new general ledger entry by submitting transaction details and associated account information, facilitating accurate financial record management within the General Ledger domain.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the financial record details for ledger entries, including transaction information and account identifiers, necessary for generating a general ledger report profile.
» searchRequest	body	GeneralLedgerAccountSearchRequest	false	Data transfer object representing a request to search for general ledger accounts, facilitating the retrieval of financial records related to ledger entries and transactions.
»» searchTerm	body	string	false	Search term used to filter and retrieve specific ledger entries, transactions, or accounts within the General Ledger for financial record management.
»» 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
»» 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
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» statusEqual	body	string	false	Filter by exact match of status
»» statusIn	body	[string]	false	Filter by multiple values of status
»» erpSystemIdIn	body	[integer]	false	Filter by multiple values of erp system id
»» erpSystemIdEqual	body	integer(int64)	false	Filter by exact match of erp system id
»» erpSystemDisplayIdIn	body	[string]	false	Filter by multiple values of erp system display id
»» idIn	body	[integer]	false	Filter by multiple values of id
»» accountTypeIn	body	[string]	false	Filter by multiple values of account type
»» leaseAreaIdIn	body	[integer]	false	Filter by multiple values of lease area id
»» businessUnitIdIn	body	[integer]	false	Filter by multiple values of business unit id
»» companyIdIn	body	[integer]	false	Filter by multiple values of company id
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» accountTypeIn	BALANCESHEET, PROFITANDLOSS
»» statusEqual	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» statusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

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

Body Parameters

{
  "searchRequest": {
    "searchTerm": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "statusEqual": "CREATED",
    "statusIn": [
      "CREATED"
    ],
    "erpSystemIdIn": [
      0
    ],
    "erpSystemIdEqual": 0,
    "erpSystemDisplayIdIn": [
      "string"
    ],
    "idIn": [
      0
    ],
    "accountTypeIn": [
      "BALANCESHEET"
    ],
    "leaseAreaIdIn": [
      0
    ],
    "businessUnitIdIn": [
      0
    ],
    "companyIdIn": [
      0
    ]
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageGeneralLedgerAccountLite

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "shortName": "string",
      "longName": "string",
      "accountCategory": "BALANCESHEET",
      "accountTarget": "ALL"
    }
  ],
  "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

General Ledger Report Profile - Search General Ledger Account Types

HTTP Request

POST /api/v1/general-ledger/report-profile/generalLedgerTypes

Interactive Demo

📋 Description: Creates a new general ledger type for ledger entries, facilitating the categorization of transactions and enhancing the management of financial records within the accounting system.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "BALANCESHEET"
]

Response Schema

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

General Ledger Report Profile - Search Fiscal Variants

HTTP Request

POST /api/v1/general-ledger/report-profile/fiscalVariants

Interactive Demo

📋 Description: Creates a new fiscal variant for the general ledger report profile, enabling users to define specific parameters for ledger entries and financial records associated with transactions and accounts.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the fiscal variant data for ledger entries, including transaction details and account identifiers necessary for generating comprehensive financial records.
» searchRequest	body	FiscalVariantSearchRequest	false	Data transfer object representing a request to search for fiscal variants within the General Ledger, facilitating the retrieval of specific ledger entries, transactions, and accounts related to financial records.
»» searchTerm	body	string	false	Search term used to filter and retrieve specific ledger entries, transactions, accounts, or financial records within the General Ledger.
»» 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
»» 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
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» statusEqual	body	string	false	Filter by exact match of status
»» statusIn	body	[string]	false	Filter by multiple values of status
»» erpSystemIdIn	body	[integer]	false	Filter by multiple values of erp system id
»» erpSystemIdEqual	body	integer(int64)	false	Filter by exact match of erp system id
»» erpSystemDisplayIdIn	body	[string]	false	Filter by multiple values of erp system display id
»» idIn	body	[integer]	false	Filter by multiple values of id
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» statusEqual	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» statusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

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

Body Parameters

{
  "searchRequest": {
    "searchTerm": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "statusEqual": "CREATED",
    "statusIn": [
      "CREATED"
    ],
    "erpSystemIdIn": [
      0
    ],
    "erpSystemIdEqual": 0,
    "erpSystemDisplayIdIn": [
      "string"
    ],
    "idIn": [
      0
    ]
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageFiscalVariantLite

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "status": "CREATED",
      "isCalendarYear": true,
      "yearDependent": true,
      "erpSystemDisplayId": "string",
      "isErpSystemDefault": true
    }
  ],
  "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

General Ledger Report Profile - Search Exchange Rate Types

HTTP Request

POST /api/v1/general-ledger/report-profile/exchangeRateTypes

Interactive Demo

📋 Description: Creates a new exchange rate type for use in ledger entries and financial transactions, ensuring accurate accounting and reporting within the General Ledger.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the exchange rate type data necessary for accurately recording transactions and maintaining financial records within the general ledger.
» filter	body	ExchangeRateTypeDtoFilter	false	Data transfer object representing filters for exchange rate criteria within the General Ledger, facilitating accurate ledger entries, transactions, and financial records management.
»» 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
»» statusEqual	body	string	false	Filter by exact match of status
»» statusIn	body	[string]	false	Filter by multiple values of status
»» displayIdIn	body	[string]	false	Filter by multiple values of display id
»» displayIdLike	body	string	false	Filter by partial match of display id
»» erpSystemIdEqual	body	integer(int64)	false	Filter by exact match of erp system id
»» erpSystemIdIn	body	[integer]	false	Filter by multiple values of erp system id
»» erpSystemDisplayIdLike	body	string	false	Filter by partial match of erp system display id
»» uiSelector	body	string	false	Specifies the user interface selector for filtering exchange rate types within ledger entries, transactions, accounts, and financial records.
»» exchangeRateTypeLike	body	string	false	Filter by partial match of exchange rate type
»» currencyTypeLike	body	string	false	Filter by partial match of currency type
»» sourceCurrencyTypeIn	body	[string]	false	Filter by multiple values of source currency type
»» translationDateTypeIn	body	[string]	false	Filter by multiple values of translation date type
»» currencyDefinitionTypeIn	body	[string]	false	Filter by multiple values of currency definition type
»» companyIdEqual	body	integer(int64)	false	Filter by exact match of company id
»» companyDisplayIdLike	body	string	false	Filter by partial match of company display id
»» targetCurrencyIdEqual	body	integer(int64)	false	Filter by exact match of target currency id
»» targetCurrencyDisplayIdLike	body	string	false	Filter by partial match of target currency display id
»» referenceCurrencyIdEqual	body	integer(int64)	false	Filter by exact match of reference currency id
»» referenceCurrencyDisplayIdLike	body	string	false	Filter by partial match of reference currency display id
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» currencyDefinitionTypeIn	COMPANY_CURRENCY, CONTRACT_CURRENCY, MONTH_END_CURRENCY, REPORTING_CURRENCY, SECOND_LOCAL_CURRENCY, THIRD_LOCAL_CURRENCY
»» sourceCurrencyTypeIn	COMPANY_CURRENCY, CONTRACT_CURRENCY, N_A
»» statusEqual	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» statusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» translationDateTypeIn	, DOCUMENT_DATE, POSTING_DATE, TRANSLATION_DATE

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",
    "statusEqual": "CREATED",
    "statusIn": [
      "CREATED"
    ],
    "displayIdIn": [
      "string"
    ],
    "displayIdLike": "string",
    "erpSystemIdEqual": 0,
    "erpSystemIdIn": [
      0
    ],
    "erpSystemDisplayIdLike": "string",
    "uiSelector": "string",
    "exchangeRateTypeLike": "string",
    "currencyTypeLike": "string",
    "sourceCurrencyTypeIn": [
      "CONTRACT_CURRENCY"
    ],
    "translationDateTypeIn": [
      "DOCUMENT_DATE"
    ],
    "currencyDefinitionTypeIn": [
      "CONTRACT_CURRENCY"
    ],
    "companyIdEqual": 0,
    "companyDisplayIdLike": "string",
    "targetCurrencyIdEqual": 0,
    "targetCurrencyDisplayIdLike": "string",
    "referenceCurrencyIdEqual": 0,
    "referenceCurrencyDisplayIdLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageExchangeRateTypeDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "exchangeRateType": "string",
      "currencyType": "string",
      "sourceCurrencyType": "CONTRACT_CURRENCY",
      "translationDateType": "DOCUMENT_DATE",
      "currencyDefinitionType": "CONTRACT_CURRENCY",
      "companyId": 0,
      "companyDisplayId": "string",
      "targetCurrencyId": 0,
      "targetCurrencyDisplayId": "string",
      "targetCurrencyDecimalPoints": 0,
      "targetCurrencyName": "string",
      "referenceCurrencyId": 0,
      "referenceCurrencyDisplayId": "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

General Ledger Report Profile - Get Shared Exchange Rate Types

HTTP Request

POST /api/v1/general-ledger/report-profile/exchange-rate-types/shared

Interactive Demo

📋 Description: Creates a shared exchange rate type profile for ledger entries and transactions within the General Ledger, facilitating consistent financial record management across accounts.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the exchange rate type data for ledger entries, including relevant attributes for transactions and financial records.
» searchRequest	body	CompanySearchRequest	false	Data transfer object representing a request to search for company-related financial records within the General Ledger, facilitating the retrieval of ledger entries, transactions, and account information.
»» searchTerm	body	string	false	Search term used to filter and identify specific ledger entries, transactions, accounts, or financial records within the General Ledger.
»» 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
»» 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
»» createdByLike	body	string	false	Filter by partial match of created by
»» createdByEqual	body	string	false	Filter by exact match of created by
»» statusEqual	body	string	false	Filter by exact match of status
»» statusIn	body	[string]	false	Filter by multiple values of status
»» erpSystemIdIn	body	[integer]	false	Filter by multiple values of erp system id
»» erpSystemIdEqual	body	integer(int64)	false	Filter by exact match of erp system id
»» erpSystemDisplayIdIn	body	[string]	false	Filter by multiple values of erp system display id
»» idIn	body	[integer]	false	Filter by multiple values of id
»» displayIdIn	body	[string]	false	Filter by multiple values of display id
»» leaseAreaIdIn	body	[integer]	false	Filter by multiple values of lease area id
»» businessUnitIdIn	body	[integer]	false	Filter by multiple values of business unit id
»» businessUnitIdEqual	body	integer(int64)	false	Filter by exact match of business unit id
»» fiscalVariantIdIn	body	[integer]	false	Filter by multiple values of fiscal variant id
»» fiscalVariantIdEqual	body	integer(int64)	false	Filter by exact match of fiscal variant id
»» companyCommonCurrencySearchTerm	body	string	false	Search term for identifying the common currency used across ledger entries, transactions, accounts, and financial records within the General Ledger API.
»» countryDisplayIdLike	body	string	false	none
»» partnerIdEqual	body	integer(int64)	false	none
»» displayIdLike	body	string	false	none
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» statusEqual	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» statusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Parameter Constraints

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

Body Parameters

{
  "searchRequest": {
    "searchTerm": "string",
    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
    "createdByLike": "string",
    "createdByEqual": "string",
    "statusEqual": "CREATED",
    "statusIn": [
      "CREATED"
    ],
    "erpSystemIdIn": [
      0
    ],
    "erpSystemIdEqual": 0,
    "erpSystemDisplayIdIn": [
      "string"
    ],
    "idIn": [
      0
    ],
    "displayIdIn": [
      "string"
    ],
    "leaseAreaIdIn": [
      0
    ],
    "businessUnitIdIn": [
      0
    ],
    "businessUnitIdEqual": 0,
    "fiscalVariantIdIn": [
      0
    ],
    "fiscalVariantIdEqual": 0,
    "companyCommonCurrencySearchTerm": "string",
    "countryDisplayIdLike": "string",
    "partnerIdEqual": 0,
    "displayIdLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageCompanyCommonCurrency

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "currencyType": "string",
      "currencyDefinitionType": "CONTRACT_CURRENCY",
      "targetCurrencyId": 0,
      "targetCurrencyDisplayId": "string",
      "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

General Ledger Report Profile - Search Document Types

HTTP Request

POST /api/v1/general-ledger/report-profile/document-types

Interactive Demo

📋 Description: Creates a new document type for general ledger report profiles, facilitating the categorization and management of ledger entries, transactions, and financial records.

Parameters

Name	In	Type	Required	Description
body	body	object	false	Request body containing the document type definitions for ledger entries, transactions, accounts, and financial records to be utilized in generating report profiles.
» filter	body	DocumentTypeDtoFilter	false	Data transfer object representing a filter for document types within the General Ledger, enabling users to refine ledger entries, transactions, accounts, and financial records based on specific criteria.
»» 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
»» statusEqual	body	string	false	Filter by exact match of status
»» statusIn	body	[string]	false	Filter by multiple values of status
»» displayIdIn	body	[string]	false	Filter by multiple values of display id
»» displayIdLike	body	string	false	Filter by partial match of display id
»» erpSystemIdEqual	body	integer(int64)	false	Filter by exact match of erp system id
»» erpSystemIdIn	body	[integer]	false	Filter by multiple values of erp system id
»» erpSystemDisplayIdLike	body	string	false	Filter by partial match of erp system display id
»» uiSelector	body	string	false	String identifier used to specify the user interface selection criteria for filtering ledger entries, transactions, accounts, or financial records within the General Ledger API.
»» nameLike	body	string	false	Filter by partial match of name
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of ledger entries, facilitating efficient retrieval and management of financial records, transactions, and account details within the General Ledger domain.
»» 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
»» statusEqual	ACTIVE, CREATED, DECOMMISSIONED, DISABLED
»» statusIn	ACTIVE, CREATED, DECOMMISSIONED, DISABLED

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",
    "statusEqual": "CREATED",
    "statusIn": [
      "CREATED"
    ],
    "displayIdIn": [
      "string"
    ],
    "displayIdLike": "string",
    "erpSystemIdEqual": 0,
    "erpSystemIdIn": [
      0
    ],
    "erpSystemDisplayIdLike": "string",
    "uiSelector": "string",
    "nameLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDocumentTypeDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "name": "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

General Ledger Report Profile - Search Asset Transaction Type Mapping

HTTP Request

GET /api/v1/general-ledger/report-profile/asset-transaction-type-mappings

Interactive Demo

📋 Description: Retrieves the mappings of asset transaction types within the general ledger, providing essential insights into ledger entries and their corresponding financial records. This operation facilitates effective transaction management and account reconciliation.

Parameters

Name	In	Type	Required	Description
valueLike	query	string	false	Filter by partial match of value
pageable	query	Pageable	true	Indicates whether the results of the asset transaction type mappings report should be returned in a paginated format, facilitating efficient navigation through extensive financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageString

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    "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

---