NFS Export Job

Get

HTTP Request

GET /api/v1/exports/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "taskCount": 0,
20    "failedTaskCount": 0,
21    "doneTaskCount": 0,
22    "inProgressTaskCount": 0,
23    "cancelledTaskCount": 0,
24    "errorMessage": "string",
25    "batchSize": 1000,
26    "totalObjectCount": 0,
27    "queueTime": "2019-08-24T14:15:22Z",
28    "startTime": "2019-08-24T14:15:22Z",
29    "endTime": "2019-08-24T14:15:22Z",
30    "status": "CREATED",
31    "fileStorageId": "string",
32    "generatingExportFile": true,
33    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
34    "version": 0,
35    "readOnly": true,
36    "docStoreId": 0,
37    "filter": {
38      "principalPositionType": "LESSEE",
39      "migratedFilterType": "MIGRATED",
40      "erpSystemIds": [
41        0
42      ],
43      "leaseAreaIds": [
44        0
45      ],
46      "businessUnitIds": [
47        0
48      ],
49      "companyIds": [
50        0
51      ],
52      "erpSystemFilterType": "ALL",
53      "leaseAreaFilterType": "ALL",
54      "businessUnitFilterType": "ALL",
55      "companyFilterType": "ALL",
56      "objectTypeFilter": "MASTER_AGREEMENT",
57      "ids": [
58        0
59      ],
60      "leaseComponentRevisionId": 0,
61      "leaseMeasurementId": 0,
62      "fromYear": 0,
63      "toYear": 0,
64      "unitIds": [
65        0
66      ]
67    },
68    "requestReferences": [
69      {
70        "key": "string",
71        "value": "string"
72      }
73    ],
74    "sheetTypes": [
75      {
76        "persistentId": "string",
77        "tabCaption": "string",
78        "sheetCaption": "string",
79        "sheetGroupType": "MASTER_AGREEMENT",
80        "principalPositionMode": "LESSEE",
81        "rowCaption": "string",
82        "order": 0,
83        "name": "string"
84      }
85    ],
86    "sheetGroupTypes": [
87      "MASTER_AGREEMENT"
88    ]
89  }
90}

Update

HTTP Request

PUT /api/v1/exports/{id}

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

body

body

NfsExportJobDto

true

none

Body Parameters

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "batchSize": 1000,
10  "totalObjectCount": 0,
11  "queueTime": "2019-08-24T14:15:22Z",
12  "startTime": "2019-08-24T14:15:22Z",
13  "endTime": "2019-08-24T14:15:22Z",
14  "status": "CREATED",
15  "fileStorageId": "string",
16  "generatingExportFile": true,
17  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18  "version": 0,
19  "readOnly": true,
20  "docStoreId": 0,
21  "filter": {
22    "principalPositionType": "LESSEE",
23    "migratedFilterType": "MIGRATED",
24    "erpSystemIds": [
25      0
26    ],
27    "leaseAreaIds": [
28      0
29    ],
30    "businessUnitIds": [
31      0
32    ],
33    "companyIds": [
34      0
35    ],
36    "erpSystemFilterType": "ALL",
37    "leaseAreaFilterType": "ALL",
38    "businessUnitFilterType": "ALL",
39    "companyFilterType": "ALL",
40    "objectTypeFilter": "MASTER_AGREEMENT",
41    "ids": [
42      0
43    ],
44    "leaseComponentRevisionId": 0,
45    "leaseMeasurementId": 0,
46    "fromYear": 0,
47    "toYear": 0,
48    "unitIds": [
49      0
50    ]
51  },
52  "requestReferences": [
53    {
54      "key": "string",
55      "value": "string"
56    }
57  ],
58  "sheetTypes": [
59    {
60      "persistentId": "string",
61      "tabCaption": "string",
62      "sheetCaption": "string",
63      "sheetGroupType": "MASTER_AGREEMENT",
64      "principalPositionMode": "LESSEE",
65      "rowCaption": "string",
66      "order": 0,
67      "name": "string"
68    }
69  ],
70  "sheetGroupTypes": [
71    "MASTER_AGREEMENT"
72  ]
73}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "taskCount": 0,
20    "failedTaskCount": 0,
21    "doneTaskCount": 0,
22    "inProgressTaskCount": 0,
23    "cancelledTaskCount": 0,
24    "errorMessage": "string",
25    "batchSize": 1000,
26    "totalObjectCount": 0,
27    "queueTime": "2019-08-24T14:15:22Z",
28    "startTime": "2019-08-24T14:15:22Z",
29    "endTime": "2019-08-24T14:15:22Z",
30    "status": "CREATED",
31    "fileStorageId": "string",
32    "generatingExportFile": true,
33    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
34    "version": 0,
35    "readOnly": true,
36    "docStoreId": 0,
37    "filter": {
38      "principalPositionType": "LESSEE",
39      "migratedFilterType": "MIGRATED",
40      "erpSystemIds": [
41        0
42      ],
43      "leaseAreaIds": [
44        0
45      ],
46      "businessUnitIds": [
47        0
48      ],
49      "companyIds": [
50        0
51      ],
52      "erpSystemFilterType": "ALL",
53      "leaseAreaFilterType": "ALL",
54      "businessUnitFilterType": "ALL",
55      "companyFilterType": "ALL",
56      "objectTypeFilter": "MASTER_AGREEMENT",
57      "ids": [
58        0
59      ],
60      "leaseComponentRevisionId": 0,
61      "leaseMeasurementId": 0,
62      "fromYear": 0,
63      "toYear": 0,
64      "unitIds": [
65        0
66      ]
67    },
68    "requestReferences": [
69      {
70        "key": "string",
71        "value": "string"
72      }
73    ],
74    "sheetTypes": [
75      {
76        "persistentId": "string",
77        "tabCaption": "string",
78        "sheetCaption": "string",
79        "sheetGroupType": "MASTER_AGREEMENT",
80        "principalPositionMode": "LESSEE",
81        "rowCaption": "string",
82        "order": 0,
83        "name": "string"
84      }
85    ],
86    "sheetGroupTypes": [
87      "MASTER_AGREEMENT"
88    ]
89  }
90}

Create Or Update Bulk

HTTP Request

PUT /api/v1/exports/createOrUpdate/bulk

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "taskCount": 0,
 5    "failedTaskCount": 0,
 6    "doneTaskCount": 0,
 7    "inProgressTaskCount": 0,
 8    "cancelledTaskCount": 0,
 9    "errorMessage": "string",
10    "batchSize": 1000,
11    "totalObjectCount": 0,
12    "queueTime": "2019-08-24T14:15:22Z",
13    "startTime": "2019-08-24T14:15:22Z",
14    "endTime": "2019-08-24T14:15:22Z",
15    "status": "CREATED",
16    "fileStorageId": "string",
17    "generatingExportFile": true,
18    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
19    "version": 0,
20    "readOnly": true,
21    "docStoreId": 0,
22    "filter": {
23      "principalPositionType": "LESSEE",
24      "migratedFilterType": "MIGRATED",
25      "erpSystemIds": [
26        0
27      ],
28      "leaseAreaIds": [
29        0
30      ],
31      "businessUnitIds": [
32        0
33      ],
34      "companyIds": [
35        0
36      ],
37      "erpSystemFilterType": "ALL",
38      "leaseAreaFilterType": "ALL",
39      "businessUnitFilterType": "ALL",
40      "companyFilterType": "ALL",
41      "objectTypeFilter": "MASTER_AGREEMENT",
42      "ids": [
43        0
44      ],
45      "leaseComponentRevisionId": 0,
46      "leaseMeasurementId": 0,
47      "fromYear": 0,
48      "toYear": 0,
49      "unitIds": [
50        0
51      ]
52    },
53    "requestReferences": [
54      {
55        "key": "string",
56        "value": "string"
57      }
58    ],
59    "sheetTypes": [
60      {
61        "persistentId": "string",
62        "tabCaption": "string",
63        "sheetCaption": "string",
64        "sheetGroupType": "MASTER_AGREEMENT",
65        "principalPositionMode": "LESSEE",
66        "rowCaption": "string",
67        "order": 0,
68        "name": "string"
69      }
70    ],
71    "sheetGroupTypes": [
72      "MASTER_AGREEMENT"
73    ]
74  }
75]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": [
18    {
19      "id": 0,
20      "taskCount": 0,
21      "failedTaskCount": 0,
22      "doneTaskCount": 0,
23      "inProgressTaskCount": 0,
24      "cancelledTaskCount": 0,
25      "errorMessage": "string",
26      "batchSize": 1000,
27      "totalObjectCount": 0,
28      "queueTime": "2019-08-24T14:15:22Z",
29      "startTime": "2019-08-24T14:15:22Z",
30      "endTime": "2019-08-24T14:15:22Z",
31      "status": "CREATED",
32      "fileStorageId": "string",
33      "generatingExportFile": true,
34      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
35      "version": 0,
36      "readOnly": true,
37      "docStoreId": 0,
38      "filter": {
39        "principalPositionType": "LESSEE",
40        "migratedFilterType": "MIGRATED",
41        "erpSystemIds": [
42          0
43        ],
44        "leaseAreaIds": [
45          0
46        ],
47        "businessUnitIds": [
48          0
49        ],
50        "companyIds": [
51          0
52        ],
53        "erpSystemFilterType": "ALL",
54        "leaseAreaFilterType": "ALL",
55        "businessUnitFilterType": "ALL",
56        "companyFilterType": "ALL",
57        "objectTypeFilter": "MASTER_AGREEMENT",
58        "ids": [
59          0
60        ],
61        "leaseComponentRevisionId": 0,
62        "leaseMeasurementId": 0,
63        "fromYear": 0,
64        "toYear": 0,
65        "unitIds": [
66          0
67        ]
68      },
69      "requestReferences": [
70        {
71          "key": "string",
72          "value": "string"
73        }
74      ],
75      "sheetTypes": [
76        {
77          "persistentId": "string",
78          "tabCaption": "string",
79          "sheetCaption": "string",
80          "sheetGroupType": "MASTER_AGREEMENT",
81          "principalPositionMode": "LESSEE",
82          "rowCaption": "string",
83          "order": 0,
84          "name": "string"
85        }
86      ],
87      "sheetGroupTypes": [
88        "MASTER_AGREEMENT"
89      ]
90    }
91  ]
92}

Create Or Update

HTTP Request

PUT /api/v1/exports/createOrUpdate

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "batchSize": 1000,
10  "totalObjectCount": 0,
11  "queueTime": "2019-08-24T14:15:22Z",
12  "startTime": "2019-08-24T14:15:22Z",
13  "endTime": "2019-08-24T14:15:22Z",
14  "status": "CREATED",
15  "fileStorageId": "string",
16  "generatingExportFile": true,
17  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18  "version": 0,
19  "readOnly": true,
20  "docStoreId": 0,
21  "filter": {
22    "principalPositionType": "LESSEE",
23    "migratedFilterType": "MIGRATED",
24    "erpSystemIds": [
25      0
26    ],
27    "leaseAreaIds": [
28      0
29    ],
30    "businessUnitIds": [
31      0
32    ],
33    "companyIds": [
34      0
35    ],
36    "erpSystemFilterType": "ALL",
37    "leaseAreaFilterType": "ALL",
38    "businessUnitFilterType": "ALL",
39    "companyFilterType": "ALL",
40    "objectTypeFilter": "MASTER_AGREEMENT",
41    "ids": [
42      0
43    ],
44    "leaseComponentRevisionId": 0,
45    "leaseMeasurementId": 0,
46    "fromYear": 0,
47    "toYear": 0,
48    "unitIds": [
49      0
50    ]
51  },
52  "requestReferences": [
53    {
54      "key": "string",
55      "value": "string"
56    }
57  ],
58  "sheetTypes": [
59    {
60      "persistentId": "string",
61      "tabCaption": "string",
62      "sheetCaption": "string",
63      "sheetGroupType": "MASTER_AGREEMENT",
64      "principalPositionMode": "LESSEE",
65      "rowCaption": "string",
66      "order": 0,
67      "name": "string"
68    }
69  ],
70  "sheetGroupTypes": [
71    "MASTER_AGREEMENT"
72  ]
73}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "taskCount": 0,
20    "failedTaskCount": 0,
21    "doneTaskCount": 0,
22    "inProgressTaskCount": 0,
23    "cancelledTaskCount": 0,
24    "errorMessage": "string",
25    "batchSize": 1000,
26    "totalObjectCount": 0,
27    "queueTime": "2019-08-24T14:15:22Z",
28    "startTime": "2019-08-24T14:15:22Z",
29    "endTime": "2019-08-24T14:15:22Z",
30    "status": "CREATED",
31    "fileStorageId": "string",
32    "generatingExportFile": true,
33    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
34    "version": 0,
35    "readOnly": true,
36    "docStoreId": 0,
37    "filter": {
38      "principalPositionType": "LESSEE",
39      "migratedFilterType": "MIGRATED",
40      "erpSystemIds": [
41        0
42      ],
43      "leaseAreaIds": [
44        0
45      ],
46      "businessUnitIds": [
47        0
48      ],
49      "companyIds": [
50        0
51      ],
52      "erpSystemFilterType": "ALL",
53      "leaseAreaFilterType": "ALL",
54      "businessUnitFilterType": "ALL",
55      "companyFilterType": "ALL",
56      "objectTypeFilter": "MASTER_AGREEMENT",
57      "ids": [
58        0
59      ],
60      "leaseComponentRevisionId": 0,
61      "leaseMeasurementId": 0,
62      "fromYear": 0,
63      "toYear": 0,
64      "unitIds": [
65        0
66      ]
67    },
68    "requestReferences": [
69      {
70        "key": "string",
71        "value": "string"
72      }
73    ],
74    "sheetTypes": [
75      {
76        "persistentId": "string",
77        "tabCaption": "string",
78        "sheetCaption": "string",
79        "sheetGroupType": "MASTER_AGREEMENT",
80        "principalPositionMode": "LESSEE",
81        "rowCaption": "string",
82        "order": 0,
83        "name": "string"
84      }
85    ],
86    "sheetGroupTypes": [
87      "MASTER_AGREEMENT"
88    ]
89  }
90}

Bulk Update

HTTP Request

PUT /api/v1/exports/bulk

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "taskCount": 0,
 5    "failedTaskCount": 0,
 6    "doneTaskCount": 0,
 7    "inProgressTaskCount": 0,
 8    "cancelledTaskCount": 0,
 9    "errorMessage": "string",
10    "batchSize": 1000,
11    "totalObjectCount": 0,
12    "queueTime": "2019-08-24T14:15:22Z",
13    "startTime": "2019-08-24T14:15:22Z",
14    "endTime": "2019-08-24T14:15:22Z",
15    "status": "CREATED",
16    "fileStorageId": "string",
17    "generatingExportFile": true,
18    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
19    "version": 0,
20    "readOnly": true,
21    "docStoreId": 0,
22    "filter": {
23      "principalPositionType": "LESSEE",
24      "migratedFilterType": "MIGRATED",
25      "erpSystemIds": [
26        0
27      ],
28      "leaseAreaIds": [
29        0
30      ],
31      "businessUnitIds": [
32        0
33      ],
34      "companyIds": [
35        0
36      ],
37      "erpSystemFilterType": "ALL",
38      "leaseAreaFilterType": "ALL",
39      "businessUnitFilterType": "ALL",
40      "companyFilterType": "ALL",
41      "objectTypeFilter": "MASTER_AGREEMENT",
42      "ids": [
43        0
44      ],
45      "leaseComponentRevisionId": 0,
46      "leaseMeasurementId": 0,
47      "fromYear": 0,
48      "toYear": 0,
49      "unitIds": [
50        0
51      ]
52    },
53    "requestReferences": [
54      {
55        "key": "string",
56        "value": "string"
57      }
58    ],
59    "sheetTypes": [
60      {
61        "persistentId": "string",
62        "tabCaption": "string",
63        "sheetCaption": "string",
64        "sheetGroupType": "MASTER_AGREEMENT",
65        "principalPositionMode": "LESSEE",
66        "rowCaption": "string",
67        "order": 0,
68        "name": "string"
69      }
70    ],
71    "sheetGroupTypes": [
72      "MASTER_AGREEMENT"
73    ]
74  }
75]

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseListNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": [
18    {
19      "id": 0,
20      "taskCount": 0,
21      "failedTaskCount": 0,
22      "doneTaskCount": 0,
23      "inProgressTaskCount": 0,
24      "cancelledTaskCount": 0,
25      "errorMessage": "string",
26      "batchSize": 1000,
27      "totalObjectCount": 0,
28      "queueTime": "2019-08-24T14:15:22Z",
29      "startTime": "2019-08-24T14:15:22Z",
30      "endTime": "2019-08-24T14:15:22Z",
31      "status": "CREATED",
32      "fileStorageId": "string",
33      "generatingExportFile": true,
34      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
35      "version": 0,
36      "readOnly": true,
37      "docStoreId": 0,
38      "filter": {
39        "principalPositionType": "LESSEE",
40        "migratedFilterType": "MIGRATED",
41        "erpSystemIds": [
42          0
43        ],
44        "leaseAreaIds": [
45          0
46        ],
47        "businessUnitIds": [
48          0
49        ],
50        "companyIds": [
51          0
52        ],
53        "erpSystemFilterType": "ALL",
54        "leaseAreaFilterType": "ALL",
55        "businessUnitFilterType": "ALL",
56        "companyFilterType": "ALL",
57        "objectTypeFilter": "MASTER_AGREEMENT",
58        "ids": [
59          0
60        ],
61        "leaseComponentRevisionId": 0,
62        "leaseMeasurementId": 0,
63        "fromYear": 0,
64        "toYear": 0,
65        "unitIds": [
66          0
67        ]
68      },
69      "requestReferences": [
70        {
71          "key": "string",
72          "value": "string"
73        }
74      ],
75      "sheetTypes": [
76        {
77          "persistentId": "string",
78          "tabCaption": "string",
79          "sheetCaption": "string",
80          "sheetGroupType": "MASTER_AGREEMENT",
81          "principalPositionMode": "LESSEE",
82          "rowCaption": "string",
83          "order": 0,
84          "name": "string"
85        }
86      ],
87      "sheetGroupTypes": [
88        "MASTER_AGREEMENT"
89      ]
90    }
91  ]
92}

List NFS Sheet Group Types

HTTP Request

POST /api/v1/exports/types

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "MASTER_AGREEMENT"
3]

Response Schema

Search Tasks

HTTP Request

POST /api/v1/exports/tasks/search

Parameters

Name

In

Type

Required

Description

body

body

object

false

none

» filter

body

NfsExportTaskDtoFilter

false

none

»» idIn

body

[integer]

false

none

»» idEqual

body

integer(int64)

false

none

»» idLike

body

string

false

none

»» createdAtGreaterThanOrEqual

body

string(date-time)

false

none

»» createdAtLessThanOrEqual

body

string(date-time)

false

none

»» createdByLike

body

string

false

none

»» createdByEqual

body

string

false

none

»» modifiedAtGreaterThanOrEqual

body

string(date-time)

false

none

»» modifiedAtLessThanOrEqual

body

string(date-time)

false

none

»» modifiedByLike

body

string

false

none

»» modifiedByEqual

body

string

false

none

»» queueTimeGreaterThanOrEqual

body

string(date-time)

false

none

»» queueTimeLessThanOrEqual

body

string(date-time)

false

none

»» startTimeGreaterThanOrEqual

body

string(date-time)

false

none

»» startTimeLessThanOrEqual

body

string(date-time)

false

none

»» endTimeGreaterThanOrEqual

body

string(date-time)

false

none

»» endTimeLessThanOrEqual

body

string(date-time)

false

none

»» statusIn

body

[string]

false

none

»» statusEqual

body

string

false

none

»» jobIdEqual

body

integer(int64)

false

none

»» itemsSheetTypeIn

body

[INfsSheetType]

false

none

»»» persistentId

body

string

true

none

»»» tabCaption

body

string

true

none

»»» sheetCaption

body

string

true

none

»»» sheetGroupType

body

string

true

none

»»» principalPositionMode

body

string

true

none

»»» rowCaption

body

string

true

none

»»» order

body

integer(int32)

false

none

»»» name

body

string

true

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» 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

»»» principalPositionMode

LESSEE, LESSEE_LESSOR, LESSOR

»»» sheetGroupType

ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "filter": {
 3    "idIn": [
 4      0
 5    ],
 6    "idEqual": 0,
 7    "idLike": "string",
 8    "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 9    "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10    "createdByLike": "string",
11    "createdByEqual": "string",
12    "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13    "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14    "modifiedByLike": "string",
15    "modifiedByEqual": "string",
16    "queueTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
17    "queueTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
18    "startTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
19    "startTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
20    "endTimeGreaterThanOrEqual": "2019-08-24T14:15:22Z",
21    "endTimeLessThanOrEqual": "2019-08-24T14:15:22Z",
22    "statusIn": [
23      "CREATED"
24    ],
25    "statusEqual": "CREATED",
26    "jobIdEqual": 0,
27    "itemsSheetTypeIn": [
28      {
29        "persistentId": "string",
30        "tabCaption": "string",
31        "sheetCaption": "string",
32        "sheetGroupType": "MASTER_AGREEMENT",
33        "principalPositionMode": "LESSEE",
34        "rowCaption": "string",
35        "order": 0,
36        "name": "string"
37      }
38    ]
39  },
40  "pageable": {
41    "page": 0,
42    "size": 10,
43    "sort": [
44      "id,asc",
45      "name,desc"
46    ]
47  }
48}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsExportTaskDto

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "numberOfElements": 0,
 5  "size": 0,
 6  "content": [
 7    {
 8      "id": 0,
 9      "queueTime": "2019-08-24T14:15:22Z",
10      "startTime": "2019-08-24T14:15:22Z",
11      "endTime": "2019-08-24T14:15:22Z",
12      "interruptedAt": "2019-08-24T14:15:22Z",
13      "recoveredAt": "2019-08-24T14:15:22Z",
14      "status": "CREATED",
15      "recover": true,
16      "interrupted": true,
17      "interruptionMessage": "string",
18      "errorMessage": "string",
19      "totalObjectCount": 0,
20      "jobId": 0,
21      "filter": {
22        "principalPositionType": "LESSEE",
23        "migratedFilterType": "MIGRATED",
24        "erpSystemIds": [
25          0
26        ],
27        "leaseAreaIds": [
28          0
29        ],
30        "businessUnitIds": [
31          0
32        ],
33        "companyIds": [
34          0
35        ],
36        "erpSystemFilterType": "ALL",
37        "leaseAreaFilterType": "ALL",
38        "businessUnitFilterType": "ALL",
39        "companyFilterType": "ALL",
40        "objectTypeFilter": "MASTER_AGREEMENT",
41        "ids": [
42          0
43        ],
44        "leaseComponentRevisionId": 0,
45        "leaseMeasurementId": 0,
46        "fromYear": 0,
47        "toYear": 0,
48        "unitIds": [
49          0
50        ]
51      },
52      "items": [
53        {
54          "id": 0,
55          "exportTaskId": 0,
56          "sheetType": {
57            "persistentId": "string",
58            "tabCaption": "string",
59            "sheetCaption": "string",
60            "sheetGroupType": "MASTER_AGREEMENT",
61            "principalPositionMode": "LESSEE",
62            "rowCaption": "string",
63            "order": 0,
64            "name": "string"
65          },
66          "startedAt": "2019-08-24T14:15:22Z",
67          "finishedAt": "2019-08-24T14:15:22Z",
68          "doneItemCount": 0,
69          "failedItemCount": 0,
70          "skippedItemCount": 0,
71          "cancelledItemCount": 0,
72          "totalItemCount": 0
73        }
74      ]
75    }
76  ],
77  "number": 0,
78  "sort": {
79    "unsorted": false,
80    "sorted": true,
81    "empty": false
82  },
83  "pageable": {
84    "unpaged": false,
85    "pageSize": 100,
86    "paged": true,
87    "offset": 0,
88    "sort": {
89      "unsorted": false,
90      "sorted": true,
91      "empty": false
92    },
93    "pageNumber": 0
94  },
95  "first": true,
96  "last": true,
97  "empty": true
98}

List Sorted Export Job Sheet Types

HTTP Request

POST /api/v1/exports/sub-items

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "batchSize": 1000,
10  "totalObjectCount": 0,
11  "queueTime": "2019-08-24T14:15:22Z",
12  "startTime": "2019-08-24T14:15:22Z",
13  "endTime": "2019-08-24T14:15:22Z",
14  "status": "CREATED",
15  "fileStorageId": "string",
16  "generatingExportFile": true,
17  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18  "version": 0,
19  "readOnly": true,
20  "docStoreId": 0,
21  "filter": {
22    "principalPositionType": "LESSEE",
23    "migratedFilterType": "MIGRATED",
24    "erpSystemIds": [
25      0
26    ],
27    "leaseAreaIds": [
28      0
29    ],
30    "businessUnitIds": [
31      0
32    ],
33    "companyIds": [
34      0
35    ],
36    "erpSystemFilterType": "ALL",
37    "leaseAreaFilterType": "ALL",
38    "businessUnitFilterType": "ALL",
39    "companyFilterType": "ALL",
40    "objectTypeFilter": "MASTER_AGREEMENT",
41    "ids": [
42      0
43    ],
44    "leaseComponentRevisionId": 0,
45    "leaseMeasurementId": 0,
46    "fromYear": 0,
47    "toYear": 0,
48    "unitIds": [
49      0
50    ]
51  },
52  "requestReferences": [
53    {
54      "key": "string",
55      "value": "string"
56    }
57  ],
58  "sheetTypes": [
59    {
60      "persistentId": "string",
61      "tabCaption": "string",
62      "sheetCaption": "string",
63      "sheetGroupType": "MASTER_AGREEMENT",
64      "principalPositionMode": "LESSEE",
65      "rowCaption": "string",
66      "order": 0,
67      "name": "string"
68    }
69  ],
70  "sheetGroupTypes": [
71    "MASTER_AGREEMENT"
72  ]
73}

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "persistentId": "string",
 4    "tabCaption": "string",
 5    "sheetCaption": "string",
 6    "sheetGroupType": "MASTER_AGREEMENT",
 7    "principalPositionMode": "LESSEE",
 8    "rowCaption": "string",
 9    "order": 0,
10    "name": "string"
11  }
12]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[INfsSheetType]

false

none

none

» persistentId

string

true

none

none

» tabCaption

string

true

none

none

» sheetCaption

string

true

none

none

» sheetGroupType

string

true

none

none

» principalPositionMode

string

true

none

none

» rowCaption

string

true

none

none

» order

integer(int32)

false

none

none

» name

string

true

none

none

Enumerated Values

Attribute

Value

principalPositionMode

LESSEE, LESSEE_LESSOR, LESSOR

sheetGroupType

ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

Search Units

HTTP Request

POST /api/v1/exports/search/units

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLightUnitDto

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "numberOfElements": 0,
 5  "size": 0,
 6  "content": [
 7    {
 8      "id": 10000001,
 9      "displayId": "UNIT-10000001",
10      "name": "Office Laptop",
11      "description": "Laptop issued to employee",
12      "assetNumber": "A-123456",
13      "referenceId": "REF-001",
14      "serialNumber": "SN-987654321",
15      "licenseNumber": "LIC-2025-001",
16      "inventoryNumber": "INV-2025-001",
17      "room": "Room 101",
18      "location": "Head Office",
19      "evaluationGroup1": "EG1",
20      "evaluationGroup2": "EG2",
21      "evaluationGroup3": "EG3",
22      "investmentReason": "New Employee Onboarding",
23      "typeName": "Laptop",
24      "calculateGrossTax": true,
25      "shippingDate": "2025-01-01",
26      "deliveryDate": "2025-01-03",
27      "receptionDate": "2025-01-03",
28      "activationDate": "2025-01-05",
29      "rouEndDate": "2026-01-01",
30      "erpAssetRetirementDate": "2030-12-31",
31      "state": "UNIT_ACTIVE",
32      "activationGroupId": 10000001,
33      "activationGroupDisplayId": "AG-10000001",
34      "principalPositionType": "LESSEE",
35      "internalAssetClass": {
36        "id": 10000001,
37        "displayId": "IAC-001",
38        "status": "CREATED",
39        "name": "Machinery and Equipment",
40        "assetClassType": "PROPERTY",
41        "infiniteUsefulLife": false
42      },
43      "costCenterAllocations": [
44        {
45          "id": 10001,
46          "mainCostCenter": true,
47          "allocationPercentage": 75,
48          "costCenter": {
49            "id": 14001,
50            "displayId": "CC-001",
51            "status": "ACTIVE",
52            "name": "Cost Center A"
53          },
54          "profitCenter": {
55            "id": 9001,
56            "displayId": "PC-001",
57            "status": "ACTIVE",
58            "name": "North Region Profit Center",
59            "validTo": "2025-12-31",
60            "erpSystemId": 101,
61            "erpSystemDisplayId": "SAP-01"
62          }
63        }
64      ],
65      "numberRangeIdentifierType": {
66        "name": "COMPANY_CODE"
67      },
68      "numberRangeIdentifierValue": "1000",
69      "numberRangeType": {
70        "name": "CONTRACT"
71      },
72      "allowsSystemGenerateNewId": false
73    }
74  ],
75  "number": 0,
76  "sort": {
77    "unsorted": false,
78    "sorted": true,
79    "empty": false
80  },
81  "pageable": {
82    "unpaged": false,
83    "pageSize": 100,
84    "paged": true,
85    "offset": 0,
86    "sort": {
87      "unsorted": false,
88      "sorted": true,
89      "empty": false
90    },
91    "pageNumber": 0
92  },
93  "first": true,
94  "last": true,
95  "empty": true
96}

Search Master Agreements

HTTP Request

POST /api/v1/exports/search/master-agreements

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMasterAgreementDto

Example Responses

  1{
  2  "totalPages": 1,
  3  "totalElements": 76,
  4  "numberOfElements": 76,
  5  "size": 100,
  6  "content": [
  7    {
  8      "id": 10000086,
  9      "displayId": "MA-2025-0001",
 10      "year": 2023,
 11      "name": "Global HQ Lease Agreement",
 12      "description": "Master lease agreement for HQ premises.",
 13      "validFrom": "2019-08-24",
 14      "validTo": "2019-08-24",
 15      "targetValue": 1000000,
 16      "legalJurisdiction": "Germany",
 17      "approverComment": "Reviewed and approved by legal team.",
 18      "signingPerson": "John Doe",
 19      "placeOfSignature": "Berlin, Germany",
 20      "dateOfSignature": "2019-08-24",
 21      "state": "MLA_DEFINE",
 22      "dataCreationInfo": {
 23        "id": 0,
 24        "idGenerationType": "AUTO",
 25        "source": "string",
 26        "type": "MIGRATION",
 27        "startDateTime": "2019-08-24T14:15:22Z",
 28        "endDateTime": "2019-08-24T14:15:22Z"
 29      },
 30      "agreementGroup": {
 31        "id": 20000001,
 32        "displayId": "AG-001",
 33        "status": "DECOMMISSIONED",
 34        "name": "Global Agreement Group"
 35      },
 36      "currency": {
 37        "id": 840,
 38        "displayId": "USD",
 39        "status": "ACTIVE",
 40        "name": "United States Dollar",
 41        "decimalPoints": 2
 42      },
 43      "internalAssetClass": {
 44        "id": 10000001,
 45        "displayId": "IAC-001",
 46        "status": "CREATED",
 47        "name": "Machinery and Equipment",
 48        "assetClassType": "PROPERTY",
 49        "infiniteUsefulLife": false
 50      },
 51      "leaseArea": {
 52        "id": 10000001,
 53        "displayId": "0001",
 54        "status": "ACTIVE",
 55        "name": "Global Lease Area"
 56      },
 57      "businessUnit": {
 58        "id": 10000001,
 59        "displayId": "BU0001",
 60        "status": "ACTIVE",
 61        "name": "North America Business Unit"
 62      },
 63      "companyCode": {
 64        "id": 10000006,
 65        "displayId": "1005",
 66        "status": "ACTIVE",
 67        "erpSystemId": 10000001,
 68        "erpSystemDisplayId": "FINQ8S-300",
 69        "countryId": 10000095,
 70        "countryDisplayId": "CA",
 71        "postingPeriodVariantId": 0,
 72        "fiscalVariantId": 0
 73      },
 74      "department": {
 75        "id": 300001,
 76        "displayId": "DEP-01",
 77        "status": "ACTIVE",
 78        "name": "Finance Department"
 79      },
 80      "leaseGroup": {
 81        "id": 60000001,
 82        "displayId": "LG-001",
 83        "status": "ACTIVE",
 84        "name": "Global Lease Group"
 85      },
 86      "allowsSystemGenerateNewId": true,
 87      "numberRangeIdentifierType": {
 88        "name": "COMPANY_CODE"
 89      },
 90      "numberRangeIdentifierValue": "0001",
 91      "numberRangeType": {
 92        "name": "CONTRACT"
 93      }
 94    }
 95  ],
 96  "number": 0,
 97  "sort": {
 98    "unsorted": false,
 99    "sorted": true,
100    "empty": false
101  },
102  "pageable": {
103    "unpaged": false,
104    "pageSize": 100,
105    "paged": true,
106    "offset": 0,
107    "sort": {
108      "unsorted": false,
109      "sorted": true,
110      "empty": false
111    },
112    "pageNumber": 0
113  },
114  "first": true,
115  "last": true,
116  "empty": false
117}

Search Lease Components

HTTP Request

POST /api/v1/exports/search/lease-components

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageLeaseComponentDto

Example Responses

  1{
  2  "totalPages": 1,
  3  "totalElements": 76,
  4  "numberOfElements": 76,
  5  "size": 100,
  6  "content": [
  7    {
  8      "id": 10000003,
  9      "displayId": "LC-100000002",
 10      "principalPositionType": "LESSEE",
 11      "name": "patched lease component",
 12      "description": "string",
 13      "bulkAsset": false,
 14      "rouStartDate": "2019-08-24",
 15      "rouEndDate": "2019-08-24",
 16      "approverComment": "string",
 17      "fairMarketValue": 0,
 18      "allocationNumber": "string",
 19      "guaranteedResidualValue": 0,
 20      "unitDistributions": [],
 21      "revision": {
 22        "id": 10000003,
 23        "displayId": "0461332847-20250827-142605",
 24        "name": "Inception",
 25        "inception": true,
 26        "revisionType": "ACTIVE",
 27        "state": "LC_DEFINE",
 28        "approvedBy": "string",
 29        "approvedAt": "2019-08-24",
 30        "parentRevisionId": 0,
 31        "approverComment": "string",
 32        "leaseComponentId": 10000003,
 33        "leaseComponentDisplayId": "LC-100000002",
 34        "leaseComponentName": "Test2 lease component",
 35        "contractRevisionId": 10000001,
 36        "contractRevisionDisplayId": "1617141777-20250724-115809",
 37        "numberRangeIdentifierType": {
 38          "name": "COMPANY_CODE"
 39        },
 40        "numberRangeIdentifierValue": "string",
 41        "numberRangeType": {
 42          "name": "CONTRACT"
 43        },
 44        "allowsSystemGenerateNewId": false
 45      },
 46      "internalAssetClass": {
 47        "id": 10000001,
 48        "displayId": "IAC-001",
 49        "status": "CREATED",
 50        "name": "Machinery and Equipment",
 51        "assetClassType": "PROPERTY",
 52        "infiniteUsefulLife": false
 53      },
 54      "unitOfMeasure": {
 55        "id": 10000198,
 56        "displayId": "MPA",
 57        "status": "ACTIVE",
 58        "name": "Megapascal",
 59        "erpSystemId": 10000001
 60      },
 61      "notifications": [],
 62      "spreadingFrequency": "NONE",
 63      "contractId": 10000001,
 64      "contractDisplayId": "CT-100000000",
 65      "companyCodeId": 10000002,
 66      "companyCodeDisplayId": "string",
 67      "userDeterminedLeaseType": "LEASE_CONTRACT_FIX",
 68      "endOfTermDate": "2019-08-24",
 69      "endOfTermPeriod": "string",
 70      "allowsSystemGenerateNewId": false,
 71      "transferInfo": {
 72        "transferredFromDisplayId": "CTR-00012",
 73        "transferredFromRevisionId": 20000001,
 74        "transferredToDisplayId": "CTR-00015",
 75        "transferredToRevisionId": 20000005
 76      },
 77      "numberRangeIdentifierType": {
 78        "name": "COMPANY_CODE"
 79      },
 80      "numberRangeIdentifierValue": "string",
 81      "numberRangeType": {
 82        "name": "CONTRACT"
 83      },
 84      "type": "LESSEE"
 85    }
 86  ],
 87  "number": 0,
 88  "sort": {
 89    "unsorted": false,
 90    "sorted": true,
 91    "empty": false
 92  },
 93  "pageable": {
 94    "unpaged": false,
 95    "pageSize": 100,
 96    "paged": true,
 97    "offset": 0,
 98    "sort": {
 99      "unsorted": false,
100      "sorted": true,
101      "empty": false
102    },
103    "pageNumber": 0
104  },
105  "first": true,
106  "last": true,
107  "empty": false
108}

Search Contracts

HTTP Request

POST /api/v1/exports/search/contracts

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageContractDto

Example Responses

  1{
  2  "totalPages": 1,
  3  "totalElements": 76,
  4  "numberOfElements": 76,
  5  "size": 100,
  6  "content": [
  7    {
  8      "id": 10000018,
  9      "displayId": "CT-100001000",
 10      "name": "Testtt Contract",
 11      "principalPositionType": "LESSEE",
 12      "validFrom": "2019-08-24",
 13      "validTo": "2019-08-24",
 14      "amendmentDate": "2019-08-24",
 15      "approverComment": "string",
 16      "contractPhase": "INITIAL",
 17      "dataCreationInfo": {
 18        "id": 0,
 19        "idGenerationType": "AUTO",
 20        "source": "string",
 21        "type": "MIGRATION",
 22        "startDateTime": "2019-08-24T14:15:22Z",
 23        "endDateTime": "2019-08-24T14:15:22Z"
 24      },
 25      "leaseType": "NON_LEASE",
 26      "revision": {
 27        "id": 10000008,
 28        "displayId": "CR-0001",
 29        "name": "Initial Revision",
 30        "inception": "2019-08-24",
 31        "revisionType": "ACTIVE",
 32        "state": "LC_DEFINE",
 33        "approvedBy": "manager.user@company.com",
 34        "approvedAt": "2019-08-24T14:15:22Z",
 35        "parentRevisionId": 10000010,
 36        "approverComment": "Approved with changes.",
 37        "contractId": 20000001,
 38        "contractDisplayId": "C-0001",
 39        "contractName": "Office Lease Contract",
 40        "principalPositionType": "LESSEE",
 41        "mlaId": 30000001,
 42        "companyId": 40000001,
 43        "description": "Revision to adjust payment terms.",
 44        "externalReference": "EXT-REF-001",
 45        "internalReference": "INT-REF-001",
 46        "formOfLease": "FULL",
 47        "jointVentureLeaseType": "GROSS_LEASE",
 48        "businessPlace": "New York Office",
 49        "tradingPartner": {
 50          "id": 0,
 51          "displayId": "string",
 52          "status": "CREATED",
 53          "name": "string",
 54          "erpSystemId": 0,
 55          "erpSystemDisplayId": "string"
 56        },
 57        "contractCategoryGroup": {
 58          "id": 0,
 59          "displayId": "string",
 60          "status": "CREATED",
 61          "name": "string"
 62        },
 63        "contractGroup1": {
 64          "id": 400001,
 65          "displayId": "CG1-01",
 66          "status": "ACTIVE",
 67          "name": "Real Estate Contracts"
 68        },
 69        "contractGroup2": {
 70          "id": 500001,
 71          "displayId": "CG2-01",
 72          "status": "ACTIVE",
 73          "name": "Equipment Leasing Contracts"
 74        },
 75        "group3": "Group3-Value",
 76        "group4": "Group4-Value",
 77        "signingPerson": "John Doe",
 78        "placeOfSignature": "Montreal, Canada",
 79        "dateOfSignature": "2019-08-24T14:15:22Z",
 80        "numberRangeIdentifierType": {
 81          "name": "COMPANY_CODE"
 82        },
 83        "numberRangeIdentifierValue": "0001",
 84        "numberRangeType": {
 85          "name": "CONTRACT"
 86        },
 87        "allowsSystemGenerateNewId": true
 88      },
 89      "currency": {
 90        "id": 840,
 91        "displayId": "USD",
 92        "status": "ACTIVE",
 93        "name": "United States Dollar",
 94        "decimalPoints": 2
 95      },
 96      "companyCurrency": {
 97        "id": 840,
 98        "displayId": "USD",
 99        "status": "ACTIVE",
100        "name": "United States Dollar",
101        "decimalPoints": 2
102      },
103      "indexedCurrency": true,
104      "assetValueCurrencyType": "CONTRACT_CURRENCY",
105      "currencyLocked": true,
106      "leaseArea": {
107        "id": 10000001,
108        "displayId": "0001",
109        "status": "ACTIVE",
110        "name": "Global Lease Area"
111      },
112      "businessUnit": {
113        "id": 10000001,
114        "displayId": "BU0001",
115        "status": "ACTIVE",
116        "name": "North America Business Unit"
117      },
118      "businessUnitLocked": true,
119      "companyCode": {
120        "id": 10000006,
121        "displayId": "1005",
122        "status": "ACTIVE",
123        "erpSystemId": 10000001,
124        "erpSystemDisplayId": "FINQ8S-300",
125        "countryId": 10000095,
126        "countryDisplayId": "CA",
127        "postingPeriodVariantId": 0,
128        "fiscalVariantId": 0
129      },
130      "companyCodeLocked": true,
131      "department": {
132        "id": 300001,
133        "displayId": "DEP-01",
134        "status": "ACTIVE",
135        "name": "Finance Department"
136      },
137      "departmentLocked": true,
138      "leaseGroup": {
139        "id": 60000001,
140        "displayId": "LG-001",
141        "status": "ACTIVE",
142        "name": "Global Lease Group"
143      },
144      "leaseGroupLocked": true,
145      "subleasingInternalAssetClass": {
146        "id": 10000001,
147        "displayId": "IAC-001",
148        "status": "CREATED",
149        "name": "Machinery and Equipment",
150        "assetClassType": "PROPERTY",
151        "infiniteUsefulLife": false
152      },
153      "contractGroup1": {
154        "id": 400001,
155        "displayId": "CG1-01",
156        "status": "ACTIVE",
157        "name": "Real Estate Contracts"
158      },
159      "contractGroup2": {
160        "id": 500001,
161        "displayId": "CG2-01",
162        "status": "ACTIVE",
163        "name": "Equipment Leasing Contracts"
164      },
165      "subleasing": false,
166      "subleasingContractRevisionInfo": {
167        "id": 50000001,
168        "contractId": 40000001,
169        "contractDisplayId": "CTR-0001",
170        "contractName": "Sublease Agreement for Office Space"
171      },
172      "subleasingLeaseComponentRevisionInfo": {
173        "id": 61000001,
174        "leaseComponentId": 80000001,
175        "leaseComponentDisplayId": "LC-0001",
176        "leaseComponentName": "Vehicle Lease Component"
177      },
178      "subleasingActivationGroupRevisionInfo": {
179        "id": 60000001,
180        "activationGroupId": 70000001,
181        "activationGroupDisplayId": "AG-001",
182        "activationGroupName": "Office Equipment Activation Group"
183      },
184      "notifications": [
185        {
186          "id": 10000001,
187          "topic": {
188            "enCaption": "Lease Component Updated",
189            "frCaption": "Composant de bail mis à jour",
190            "name": "LEASE_COMPONENT_UPDATED",
191            "priority": "HIGH"
192          },
193          "username": "super.admin@nakisa.com",
194          "contractId": 10000001,
195          "contractDisplayId": "CT-100000000",
196          "targetId": "CT-100000000",
197          "targetType": "CONTRACT"
198        }
199      ],
200      "masterAgreementId": 10000001,
201      "masterAgreementDisplayId": "string",
202      "allowsSystemGenerateNewId": true,
203      "transferInfo": {
204        "transferredFromDisplayId": "CTR-00012",
205        "transferredFromRevisionId": 20000001,
206        "transferredToDisplayId": "CTR-00015",
207        "transferredToRevisionId": 20000005
208      },
209      "numberRangeIdentifierType": {
210        "name": "COMPANY_CODE"
211      },
212      "numberRangeIdentifierValue": "",
213      "numberRangeType": {
214        "name": "CONTRACT"
215      }
216    }
217  ],
218  "number": 0,
219  "sort": {
220    "unsorted": false,
221    "sorted": true,
222    "empty": false
223  },
224  "pageable": {
225    "unpaged": false,
226    "pageSize": 100,
227    "paged": true,
228    "offset": 0,
229    "sort": {
230      "unsorted": false,
231      "sorted": true,
232      "empty": false
233    },
234    "pageNumber": 0
235  },
236  "first": true,
237  "last": true,
238  "empty": false
239}

Search Charges

HTTP Request

POST /api/v1/exports/search/charges

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageChargeDto

Example Responses

  1{
  2  "totalPages": 0,
  3  "totalElements": 0,
  4  "numberOfElements": 0,
  5  "size": 0,
  6  "content": [
  7    {
  8      "id": 0,
  9      "displayId": "string",
 10      "name": "string",
 11      "description": "string",
 12      "dueDate": "2019-08-24",
 13      "amount": 0.1,
 14      "hasPostedDocument": true,
 15      "fiscalYear": 0,
 16      "fiscalPeriod": 0,
 17      "expenseCategory": {
 18        "id": 101,
 19        "displayId": "EC-2025-001",
 20        "status": "ACTIVE",
 21        "name": "Lease Payment",
 22        "expenseCategoryType": "PAYMENT"
 23      },
 24      "unitId": 0,
 25      "unitDisplayId": "string",
 26      "activationGroupId": 0,
 27      "vendorPaymentSplits": [
 28        {
 29          "percentage": 50,
 30          "calculateTax": true,
 31          "taxExemptionPercentage": 10,
 32          "partner": {
 33            "id": 10000012,
 34            "displayId": "0000100003",
 35            "status": "ACTIVE",
 36            "name": "TEST VENDOR GB",
 37            "erpSystemDisplayId": "FINQ8S-300"
 38          },
 39          "partnerRole": {
 40            "id": 10000004,
 41            "displayId": "40",
 42            "status": "ACTIVE",
 43            "name": "Lessor"
 44          },
 45          "taxCodeDetermination": {
 46            "id": 101,
 47            "displayId": "TX-2025-001",
 48            "companyId": 1001,
 49            "taxJurisdictionId": 2001,
 50            "taxJurisdictionDisplayId": "US-NY",
 51            "defaultTaxCodeId": 301,
 52            "defaultTaxCodeDisplayId": "TAX-001",
 53            "defaultExemptionTaxCodeId": 302,
 54            "defaultExemptionTaxCodeDisplayId": "TAX-EX-001",
 55            "defaultExemptionPercentage": 100,
 56            "mapping": {
 57              "isLeaseExpense": true,
 58              "nonLeaseTaxCodeId": 401,
 59              "nonLeaseTaxCodeDisplayId": "NL-TAX-001",
 60              "nonLeaseExemptionTaxCodeId": 402,
 61              "nonLeaseExemptionTaxCodeDisplayId": "NL-TAX-EX-001",
 62              "nonLeaseExemptionTaxPercentage": 50,
 63              "principalTaxCodeId": 403,
 64              "principalTaxCodeDisplayId": "PR-TAX-001",
 65              "principalExemptionTaxCodeId": 404,
 66              "principalExemptionTaxCodeDisplayId": "PR-TAX-EX-001",
 67              "principalExemptionTaxPercentage": 100
 68            }
 69          }
 70        }
 71      ],
 72      "numberRangeIdentifierType": {
 73        "name": "COMPANY_CODE"
 74      },
 75      "numberRangeIdentifierValue": "string",
 76      "numberRangeType": {
 77        "name": "CONTRACT"
 78      },
 79      "allowsSystemGenerateNewId": true
 80    }
 81  ],
 82  "number": 0,
 83  "sort": {
 84    "unsorted": false,
 85    "sorted": true,
 86    "empty": false
 87  },
 88  "pageable": {
 89    "unpaged": false,
 90    "pageSize": 100,
 91    "paged": true,
 92    "offset": 0,
 93    "sort": {
 94      "unsorted": false,
 95      "sorted": true,
 96      "empty": false
 97    },
 98    "pageNumber": 0
 99  },
100  "first": true,
101  "last": true,
102  "empty": true
103}

Search Activation Groups

HTTP Request

POST /api/v1/exports/search/activation-groups

Parameters

Name

In

Type

Required

Description

body

body

object

true

none

» searchRequest

body

ExportJobObjectListSearchRequest

false

none

»» erpSystemIds

body

[integer]

false

none

»» leaseAreaIds

body

[integer]

false

none

»» businessUnitIds

body

[integer]

false

none

»» companyIds

body

[integer]

false

none

»» searchTerm

body

string

false

none

»» principalPositionType

body

string

false

none

»» migratedFilterType

body

string

false

none

»» fromYear

body

integer(int32)

false

none

»» toYear

body

integer(int32)

false

none

»» ids

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» migratedFilterType

ALL, MIGRATED, NON_MIGRATED

»» principalPositionType

LESSEE, LESSOR

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "searchRequest": {
 3    "erpSystemIds": [
 4      0
 5    ],
 6    "leaseAreaIds": [
 7      0
 8    ],
 9    "businessUnitIds": [
10      0
11    ],
12    "companyIds": [
13      0
14    ],
15    "searchTerm": "string",
16    "principalPositionType": "LESSEE",
17    "migratedFilterType": "MIGRATED",
18    "fromYear": 0,
19    "toYear": 0,
20    "ids": [
21      0
22    ]
23  },
24  "pageable": {
25    "page": 0,
26    "size": 10,
27    "sort": [
28      "id,asc",
29      "name,desc"
30    ]
31  }
32}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageActivationGroupDto

Example Responses

  1{
  2  "totalPages": 1,
  3  "totalElements": 76,
  4  "numberOfElements": 76,
  5  "size": 100,
  6  "content": [
  7    {
  8      "id": 10000001,
  9      "displayId": "AG-100000000",
 10      "principalPositionType": "LESSEE",
 11      "name": "Test2",
 12      "description": "test2",
 13      "approverComment": "Approved after review",
 14      "snapshotData": {
 15        "isParallelCurrencyEnabled": true,
 16        "isCostCenterAllocationEnabled": false,
 17        "useSpotRateForGroupCurrency": true,
 18        "exchangeRateTypes": [
 19          {
 20            "currencyDefinitionType": "CONTRACT_CURRENCY",
 21            "sourceCurrencyType": "COMPANY_CURRENCY",
 22            "translationDateType": "POSTING_DATE",
 23            "targetCurrency": {
 24              "id": "string",
 25              "displayId": "US Dollar",
 26              "decimalPoints": 2
 27            },
 28            "referenceCurrency": {
 29              "id": "string",
 30              "displayId": "Euro"
 31            },
 32            "currencyType": "GROUP_CURRENCY",
 33            "exchangeRateType": "STANDARD"
 34          }
 35        ]
 36      },
 37      "revision": {
 38        "id": 10000001,
 39        "displayId": "0374999413-20250903-161147",
 40        "name": "Inception",
 41        "inception": true,
 42        "revisionType": "REVISION",
 43        "state": "MLA_DEFINE",
 44        "approvedBy": "approver.admin@nakisa.com",
 45        "approvedAt": "2019-08-24T14:15:22Z",
 46        "parentRevisionId": 10000000,
 47        "approverComment": "Approved after financial validation.",
 48        "rouStartDate": "2025-08-01",
 49        "rouEndDate": "2025-08-20",
 50        "activationGroupModification": {
 51          "modificationDate": "2025-08-15",
 52          "terminationType": "CASUALTY",
 53          "terminationDate": {
 54            "timing": "START_OF_DAY",
 55            "year": 2025,
 56            "monthValue": 9,
 57            "dayOfMonth": 4,
 58            "dayOfWeek": "THURSDAY",
 59            "leapYear": false,
 60            "dayOfYear": 247,
 61            "month": "SEPTEMBER"
 62          },
 63          "useManualFmvValue": true,
 64          "useManualAssetValues": false,
 65          "enforceNonLeaseOnIndexation": false,
 66          "applyIndexationLease": true,
 67          "applyIndexationNonLease": false,
 68          "indexationTreatmentType": "DEFAULT",
 69          "indexationStartDate": "2025-09-01",
 70          "indexationDateType": "USER_DEFINED",
 71          "indexationStartDateNonLease": "2025-09-10",
 72          "indexationDateTypeNonLease": "USER_DEFINED",
 73          "modificationReasons": [
 74            "CONTRACT_RATE_CHANGE",
 75            "INDEXATION"
 76          ],
 77          "modificationPerClassificationList": [
 78            {
 79              "accountingStandardId": 1001,
 80              "classificationType": "NON_LEASE",
 81              "accountingStandardType": "IFRS",
 82              "impairmentAmount": 2500.5,
 83              "recoverableAmount": 2000,
 84              "decreaseInAsset": 1500,
 85              "decreaseInTerm": 6
 86            }
 87          ],
 88          "massIndexationTaskId": 987654
 89        },
 90        "activationGroupId": 10000001,
 91        "activationGroupDisplayId": "AG-100000000",
 92        "activationGroupName": "Test2",
 93        "leaseComponentRevisionId": 10000007,
 94        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
 95        "lastLeaseComponentRevisionId": 10000006,
 96        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
 97        "clonedFromRevisionId": 10000002,
 98        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
 99        "lockReason": "PENDING_TERMINATION",
100        "infiniteUsefulLife": false,
101        "transferOfOwnership": false,
102        "specializedAsset": false,
103        "fairMarketValue": 1,
104        "residualValue": 1,
105        "endOfTermIntention": "TO_BE_DETERMINED",
106        "endOfTermDate": "2025-08-11",
107        "endOfTermPeriod": 9,
108        "activationDocumentDate": "2019-08-24",
109        "activationPostingDate": "2019-08-24",
110        "closingDocumentDate": "2019-08-24",
111        "closingPostingDate": "2019-08-24",
112        "numberRangeIdentifierType": {
113          "name": "COMPANY_CODE"
114        },
115        "numberRangeIdentifierValue": "1000",
116        "numberRangeType": {
117          "name": "CONTRACT"
118        },
119        "allowsSystemGenerateNewId": false
120      },
121      "leaseComponentId": 10000007,
122      "leaseComponentDisplayId": "LC-100000200",
123      "companyCodeId": 10000002,
124      "companyCodeDisplayId": "1000",
125      "splittedFromActivationGroupRevisionId": {
126        "id": 10000001,
127        "displayId": "0374999413-20250903-161147",
128        "name": "Inception",
129        "inception": true,
130        "revisionType": "REVISION",
131        "state": "MLA_DEFINE",
132        "approvedBy": "approver.admin@nakisa.com",
133        "approvedAt": "2019-08-24T14:15:22Z",
134        "parentRevisionId": 10000000,
135        "approverComment": "Approved after financial validation.",
136        "rouStartDate": "2025-08-01",
137        "rouEndDate": "2025-08-20",
138        "activationGroupModification": {
139          "modificationDate": "2025-08-15",
140          "terminationType": "CASUALTY",
141          "terminationDate": {
142            "timing": "START_OF_DAY",
143            "year": 2025,
144            "monthValue": 9,
145            "dayOfMonth": 4,
146            "dayOfWeek": "THURSDAY",
147            "leapYear": false,
148            "dayOfYear": 247,
149            "month": "SEPTEMBER"
150          },
151          "useManualFmvValue": true,
152          "useManualAssetValues": false,
153          "enforceNonLeaseOnIndexation": false,
154          "applyIndexationLease": true,
155          "applyIndexationNonLease": false,
156          "indexationTreatmentType": "DEFAULT",
157          "indexationStartDate": "2025-09-01",
158          "indexationDateType": "USER_DEFINED",
159          "indexationStartDateNonLease": "2025-09-10",
160          "indexationDateTypeNonLease": "USER_DEFINED",
161          "modificationReasons": [
162            "CONTRACT_RATE_CHANGE",
163            "INDEXATION"
164          ],
165          "modificationPerClassificationList": [
166            {
167              "accountingStandardId": 1001,
168              "classificationType": "NON_LEASE",
169              "accountingStandardType": "IFRS",
170              "impairmentAmount": 2500.5,
171              "recoverableAmount": 2000,
172              "decreaseInAsset": 1500,
173              "decreaseInTerm": 6
174            }
175          ],
176          "massIndexationTaskId": 987654
177        },
178        "activationGroupId": 10000001,
179        "activationGroupDisplayId": "AG-100000000",
180        "activationGroupName": "Test2",
181        "leaseComponentRevisionId": 10000007,
182        "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
183        "lastLeaseComponentRevisionId": 10000006,
184        "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
185        "clonedFromRevisionId": 10000002,
186        "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
187        "lockReason": "PENDING_TERMINATION",
188        "infiniteUsefulLife": false,
189        "transferOfOwnership": false,
190        "specializedAsset": false,
191        "fairMarketValue": 1,
192        "residualValue": 1,
193        "endOfTermIntention": "TO_BE_DETERMINED",
194        "endOfTermDate": "2025-08-11",
195        "endOfTermPeriod": 9,
196        "activationDocumentDate": "2019-08-24",
197        "activationPostingDate": "2019-08-24",
198        "closingDocumentDate": "2019-08-24",
199        "closingPostingDate": "2019-08-24",
200        "numberRangeIdentifierType": {
201          "name": "COMPANY_CODE"
202        },
203        "numberRangeIdentifierValue": "1000",
204        "numberRangeType": {
205          "name": "CONTRACT"
206        },
207        "allowsSystemGenerateNewId": false
208      },
209      "notifications": [
210        {
211          "id": 100045,
212          "topic": {
213            "enCaption": "Lease Component Updated",
214            "frCaption": "Composant de bail mis à jour",
215            "name": "LEASE_COMPONENT_UPDATED",
216            "priority": "HIGH"
217          },
218          "username": "jdoe",
219          "activationGroupId": 20000123,
220          "activationGroupDisplayId": "AG-100045",
221          "targetId": "jdoe@example.com",
222          "targetType": "USER"
223        }
224      ],
225      "transferInfo": {
226        "transferredFromDisplayId": "CTR-00012",
227        "transferredFromRevisionId": 20000001,
228        "transferredToDisplayId": "CTR-00015",
229        "transferredToRevisionId": 20000005
230      },
231      "numberRangeIdentifierType": {
232        "name": "COMPANY_CODE"
233      },
234      "numberRangeIdentifierValue": "1000",
235      "numberRangeType": {
236        "name": "CONTRACT"
237      },
238      "allowsSystemGenerateNewId": false
239    }
240  ],
241  "number": 0,
242  "sort": {
243    "unsorted": false,
244    "sorted": true,
245    "empty": false
246  },
247  "pageable": {
248    "unpaged": false,
249    "pageSize": 100,
250    "paged": true,
251    "offset": 0,
252    "sort": {
253      "unsorted": false,
254      "sorted": true,
255      "empty": false
256    },
257    "pageNumber": 0
258  },
259  "first": true,
260  "last": true,
261  "empty": false
262}

Schedule Export Job Size Likely Above Threshold

HTTP Request

POST /api/v1/exports/schedule-export-threshold

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "batchSize": 1000,
10  "totalObjectCount": 0,
11  "queueTime": "2019-08-24T14:15:22Z",
12  "startTime": "2019-08-24T14:15:22Z",
13  "endTime": "2019-08-24T14:15:22Z",
14  "status": "CREATED",
15  "fileStorageId": "string",
16  "generatingExportFile": true,
17  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18  "version": 0,
19  "readOnly": true,
20  "docStoreId": 0,
21  "filter": {
22    "principalPositionType": "LESSEE",
23    "migratedFilterType": "MIGRATED",
24    "erpSystemIds": [
25      0
26    ],
27    "leaseAreaIds": [
28      0
29    ],
30    "businessUnitIds": [
31      0
32    ],
33    "companyIds": [
34      0
35    ],
36    "erpSystemFilterType": "ALL",
37    "leaseAreaFilterType": "ALL",
38    "businessUnitFilterType": "ALL",
39    "companyFilterType": "ALL",
40    "objectTypeFilter": "MASTER_AGREEMENT",
41    "ids": [
42      0
43    ],
44    "leaseComponentRevisionId": 0,
45    "leaseMeasurementId": 0,
46    "fromYear": 0,
47    "toYear": 0,
48    "unitIds": [
49      0
50    ]
51  },
52  "requestReferences": [
53    {
54      "key": "string",
55      "value": "string"
56    }
57  ],
58  "sheetTypes": [
59    {
60      "persistentId": "string",
61      "tabCaption": "string",
62      "sheetCaption": "string",
63      "sheetGroupType": "MASTER_AGREEMENT",
64      "principalPositionMode": "LESSEE",
65      "rowCaption": "string",
66      "order": 0,
67      "name": "string"
68    }
69  ],
70  "sheetGroupTypes": [
71    "MASTER_AGREEMENT"
72  ]
73}

Responses

Status

Meaning

Description

Schema

200

OK

OK

integer

Example Responses

10

Search Details

HTTP Request

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

Parameters

Name

In

Type

Required

Description

body

body

object

false

none

» filter

body

NfsExportItemReportDtoFilter

false

none

»» reportTypeEqual

body

string

false

none

»» itemIdIn

body

[integer]

false

none

» pageable

body

Pageable

false

Represents pagination request parameters including page number, page size, and sorting options.

»» page

body

integer(int32)

true

The requested page number (0-based).

»» size

body

integer(int32)

true

The number of elements to be returned per page.

»» sort

body

[string]

false

Sorting criteria in the format: property,(asc

Example Values

Parameter

Example

Type

»» page

0

body

»» size

10

body

»» sort

["id,asc","name,desc"]

body

Enumerated Values

Attribute

Value

»» reportTypeEqual

ERROR, SKIPPED, SUCCESS, WARNING

Parameter Constraints

Parameter

Constraints

»» page

Min: 0

»» size

Min: 1

Body Parameters

 1{
 2  "filter": {
 3    "reportTypeEqual": "SUCCESS",
 4    "itemIdIn": [
 5      0
 6    ]
 7  },
 8  "pageable": {
 9    "page": 0,
10    "size": 10,
11    "sort": [
12      "id,asc",
13      "name,desc"
14    ]
15  }
16}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsExportItemReportDto

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "numberOfElements": 0,
 5  "size": 0,
 6  "content": [
 7    {
 8      "rowIdentifier": "string",
 9      "reportType": "SUCCESS",
10      "message": "string",
11      "itemId": 0
12    }
13  ],
14  "number": 0,
15  "sort": {
16    "unsorted": false,
17    "sorted": true,
18    "empty": false
19  },
20  "pageable": {
21    "unpaged": false,
22    "pageSize": 100,
23    "paged": true,
24    "offset": 0,
25    "sort": {
26      "unsorted": false,
27      "sorted": true,
28      "empty": false
29    },
30    "pageNumber": 0
31  },
32  "first": true,
33  "last": true,
34  "empty": true
35}

Cancel

HTTP Request

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

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Cancel All

HTTP Request

POST /api/v1/exports/cancel/bulk

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

true

none

Body Parameters

1[
2  0
3]

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Find All

HTTP Request

GET /api/v1/exports

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageNfsExportJobDto

Example Responses

  1{
  2  "totalPages": 0,
  3  "totalElements": 0,
  4  "numberOfElements": 0,
  5  "size": 0,
  6  "content": [
  7    {
  8      "id": 0,
  9      "taskCount": 0,
 10      "failedTaskCount": 0,
 11      "doneTaskCount": 0,
 12      "inProgressTaskCount": 0,
 13      "cancelledTaskCount": 0,
 14      "errorMessage": "string",
 15      "batchSize": 1000,
 16      "totalObjectCount": 0,
 17      "queueTime": "2019-08-24T14:15:22Z",
 18      "startTime": "2019-08-24T14:15:22Z",
 19      "endTime": "2019-08-24T14:15:22Z",
 20      "status": "CREATED",
 21      "fileStorageId": "string",
 22      "generatingExportFile": true,
 23      "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
 24      "version": 0,
 25      "readOnly": true,
 26      "docStoreId": 0,
 27      "filter": {
 28        "principalPositionType": "LESSEE",
 29        "migratedFilterType": "MIGRATED",
 30        "erpSystemIds": [
 31          0
 32        ],
 33        "leaseAreaIds": [
 34          0
 35        ],
 36        "businessUnitIds": [
 37          0
 38        ],
 39        "companyIds": [
 40          0
 41        ],
 42        "erpSystemFilterType": "ALL",
 43        "leaseAreaFilterType": "ALL",
 44        "businessUnitFilterType": "ALL",
 45        "companyFilterType": "ALL",
 46        "objectTypeFilter": "MASTER_AGREEMENT",
 47        "ids": [
 48          0
 49        ],
 50        "leaseComponentRevisionId": 0,
 51        "leaseMeasurementId": 0,
 52        "fromYear": 0,
 53        "toYear": 0,
 54        "unitIds": [
 55          0
 56        ]
 57      },
 58      "requestReferences": [
 59        {
 60          "key": "string",
 61          "value": "string"
 62        }
 63      ],
 64      "sheetTypes": [
 65        {
 66          "persistentId": "string",
 67          "tabCaption": "string",
 68          "sheetCaption": "string",
 69          "sheetGroupType": "MASTER_AGREEMENT",
 70          "principalPositionMode": "LESSEE",
 71          "rowCaption": "string",
 72          "order": 0,
 73          "name": "string"
 74        }
 75      ],
 76      "sheetGroupTypes": [
 77        "MASTER_AGREEMENT"
 78      ]
 79    }
 80  ],
 81  "number": 0,
 82  "sort": {
 83    "unsorted": false,
 84    "sorted": true,
 85    "empty": false
 86  },
 87  "pageable": {
 88    "unpaged": false,
 89    "pageSize": 100,
 90    "paged": true,
 91    "offset": 0,
 92    "sort": {
 93      "unsorted": false,
 94      "sorted": true,
 95      "empty": false
 96    },
 97    "pageNumber": 0
 98  },
 99  "first": true,
100  "last": true,
101  "empty": true
102}

Create

HTTP Request

POST /api/v1/exports

Parameters

Name

In

Type

Required

Description

body

body

NfsExportJobDto

true

none

Body Parameters

 1{
 2  "id": 0,
 3  "taskCount": 0,
 4  "failedTaskCount": 0,
 5  "doneTaskCount": 0,
 6  "inProgressTaskCount": 0,
 7  "cancelledTaskCount": 0,
 8  "errorMessage": "string",
 9  "batchSize": 1000,
10  "totalObjectCount": 0,
11  "queueTime": "2019-08-24T14:15:22Z",
12  "startTime": "2019-08-24T14:15:22Z",
13  "endTime": "2019-08-24T14:15:22Z",
14  "status": "CREATED",
15  "fileStorageId": "string",
16  "generatingExportFile": true,
17  "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
18  "version": 0,
19  "readOnly": true,
20  "docStoreId": 0,
21  "filter": {
22    "principalPositionType": "LESSEE",
23    "migratedFilterType": "MIGRATED",
24    "erpSystemIds": [
25      0
26    ],
27    "leaseAreaIds": [
28      0
29    ],
30    "businessUnitIds": [
31      0
32    ],
33    "companyIds": [
34      0
35    ],
36    "erpSystemFilterType": "ALL",
37    "leaseAreaFilterType": "ALL",
38    "businessUnitFilterType": "ALL",
39    "companyFilterType": "ALL",
40    "objectTypeFilter": "MASTER_AGREEMENT",
41    "ids": [
42      0
43    ],
44    "leaseComponentRevisionId": 0,
45    "leaseMeasurementId": 0,
46    "fromYear": 0,
47    "toYear": 0,
48    "unitIds": [
49      0
50    ]
51  },
52  "requestReferences": [
53    {
54      "key": "string",
55      "value": "string"
56    }
57  ],
58  "sheetTypes": [
59    {
60      "persistentId": "string",
61      "tabCaption": "string",
62      "sheetCaption": "string",
63      "sheetGroupType": "MASTER_AGREEMENT",
64      "principalPositionMode": "LESSEE",
65      "rowCaption": "string",
66      "order": 0,
67      "name": "string"
68    }
69  ],
70  "sheetGroupTypes": [
71    "MASTER_AGREEMENT"
72  ]
73}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ResponseNfsExportJobDto

Example Responses

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "taskCount": 0,
20    "failedTaskCount": 0,
21    "doneTaskCount": 0,
22    "inProgressTaskCount": 0,
23    "cancelledTaskCount": 0,
24    "errorMessage": "string",
25    "batchSize": 1000,
26    "totalObjectCount": 0,
27    "queueTime": "2019-08-24T14:15:22Z",
28    "startTime": "2019-08-24T14:15:22Z",
29    "endTime": "2019-08-24T14:15:22Z",
30    "status": "CREATED",
31    "fileStorageId": "string",
32    "generatingExportFile": true,
33    "startedGeneratingExportFileAt": "2019-08-24T14:15:22Z",
34    "version": 0,
35    "readOnly": true,
36    "docStoreId": 0,
37    "filter": {
38      "principalPositionType": "LESSEE",
39      "migratedFilterType": "MIGRATED",
40      "erpSystemIds": [
41        0
42      ],
43      "leaseAreaIds": [
44        0
45      ],
46      "businessUnitIds": [
47        0
48      ],
49      "companyIds": [
50        0
51      ],
52      "erpSystemFilterType": "ALL",
53      "leaseAreaFilterType": "ALL",
54      "businessUnitFilterType": "ALL",
55      "companyFilterType": "ALL",
56      "objectTypeFilter": "MASTER_AGREEMENT",
57      "ids": [
58        0
59      ],
60      "leaseComponentRevisionId": 0,
61      "leaseMeasurementId": 0,
62      "fromYear": 0,
63      "toYear": 0,
64      "unitIds": [
65        0
66      ]
67    },
68    "requestReferences": [
69      {
70        "key": "string",
71        "value": "string"
72      }
73    ],
74    "sheetTypes": [
75      {
76        "persistentId": "string",
77        "tabCaption": "string",
78        "sheetCaption": "string",
79        "sheetGroupType": "MASTER_AGREEMENT",
80        "principalPositionMode": "LESSEE",
81        "rowCaption": "string",
82        "order": 0,
83        "name": "string"
84      }
85    ],
86    "sheetGroupTypes": [
87      "MASTER_AGREEMENT"
88    ]
89  }
90}

Report By Task

HTTP Request

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

Parameters

Name

In

Type

Required

Description

taskId

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "exportTaskId": 0,
 5    "sheetType": {
 6      "persistentId": "string",
 7      "tabCaption": "string",
 8      "sheetCaption": "string",
 9      "sheetGroupType": "MASTER_AGREEMENT",
10      "principalPositionMode": "LESSEE",
11      "rowCaption": "string",
12      "order": 0,
13      "name": "string"
14    },
15    "startedAt": "2019-08-24T14:15:22Z",
16    "finishedAt": "2019-08-24T14:15:22Z",
17    "doneItemCount": 0,
18    "failedItemCount": 0,
19    "skippedItemCount": 0,
20    "cancelledItemCount": 0,
21    "totalItemCount": 0
22  }
23]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[NfsExportItemDto]

false

none

none

» id

integer(int64)

false

none

none

» exportTaskId

integer(int64)

false

none

none

» sheetType

INfsSheetType

false

none

none

»» persistentId

string

true

none

none

»» tabCaption

string

true

none

none

»» sheetCaption

string

true

none

none

»» sheetGroupType

string

true

none

none

»» principalPositionMode

string

true

none

none

»» rowCaption

string

true

none

none

»» order

integer(int32)

false

none

none

»» name

string

true

none

none

» startedAt

string(date-time)

false

none

none

» finishedAt

string(date-time)

false

none

none

» doneItemCount

integer(int32)

false

none

none

» failedItemCount

integer(int32)

false

none

none

» skippedItemCount

integer(int32)

false

none

none

» cancelledItemCount

integer(int32)

false

none

none

» totalItemCount

integer(int32)

false

none

none

Enumerated Values

Attribute

Value

principalPositionMode

LESSEE, LESSEE_LESSOR, LESSOR

sheetGroupType

ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

Report By Job

HTTP Request

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

Parameters

Name

In

Type

Required

Description

jobId

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "ids": [
 4      0
 5    ],
 6    "sheetType": {
 7      "persistentId": "string",
 8      "tabCaption": "string",
 9      "sheetCaption": "string",
10      "sheetGroupType": "MASTER_AGREEMENT",
11      "principalPositionMode": "LESSEE",
12      "rowCaption": "string",
13      "order": 0,
14      "name": "string"
15    },
16    "startedAt": "2019-08-24T14:15:22Z",
17    "finishedAt": "2019-08-24T14:15:22Z",
18    "doneItemCount": 0,
19    "failedItemCount": 0,
20    "skippedItemCount": 0,
21    "cancelledItemCount": 0,
22    "totalItemCount": 0
23  }
24]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[NfsJobExportItemDto]

false

none

none

» ids

[integer]

false

none

none

» sheetType

INfsSheetType

false

none

none

»» persistentId

string

true

none

none

»» tabCaption

string

true

none

none

»» sheetCaption

string

true

none

none

»» sheetGroupType

string

true

none

none

»» principalPositionMode

string

true

none

none

»» rowCaption

string

true

none

none

»» order

integer(int32)

false

none

none

»» name

string

true

none

none

» startedAt

string(date-time)

false

none

none

» finishedAt

string(date-time)

false

none

none

» doneItemCount

integer(int32)

false

none

none

» failedItemCount

integer(int32)

false

none

none

» skippedItemCount

integer(int32)

false

none

none

» cancelledItemCount

integer(int32)

false

none

none

» totalItemCount

integer(int32)

false

none

none

Enumerated Values

Attribute

Value

principalPositionMode

LESSEE, LESSEE_LESSOR, LESSOR

sheetGroupType

ACTIVATION_GROUP, CHARGE, CONTACT, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, NOT_AVAILABLE, SCHEDULE, UNIT

Get All List Object Types

HTTP Request

GET /api/v1/exports/list-all-object-types

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1[
2  "MASTER_AGREEMENT"
3]

Response Schema

Generate Export File

HTTP Request

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

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Download Export File

HTTP Request

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

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

none

Responses

Status

Meaning

Description

Schema

200

OK

OK

None