Master Agreement Partner

Retrieves A Specific Master Agreement Partner

HTTP Request

GET /api/v1/master-agreement-partners/{id}

📋 Description: Retrieves detailed information about a specific master agreement partner identified by the provided ID, facilitating effective management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved master agreement partner.

ResponseMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "MAP-000045",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "masterAgreementId": 50004567,
33    "masterAgreementDisplayId": "MA-2024-0012",
34    "numberRangeIdentifierValue": "NR-10045",
35    "numberRangeIdentifierType": {
36      "name": "COMPANY_CODE"
37    },
38    "numberRangeType": {
39      "name": "CONTRACT"
40    },
41    "allowsSystemGenerateNewId": true
42  }
43}

Update A Specified Master Agreement Partner

HTTP Request

PUT /api/v1/master-agreement-partners/{id}

📋 Description: Updates the details of a specified master agreement partner, ensuring accurate representation of lease and contract information within the Nakisa Lease Accounting Suite for effective financial obligation management and accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

MasterAgreementPartnerDto

false

Request body containing updated master agreement partner details, including lease terms, contract specifications, and associated financial obligations for accurate accounting entries.

Example Values

Parameter

Example

Type

id

10000086

path

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "MAP-000045",
 4  "partner": {
 5    "id": 10000012,
 6    "displayId": "0000100003",
 7    "status": {
 8      "name": "ACTIVE",
 9      "captionKey": "enum.objectStatus.active",
10      "active": true,
11      "caption": "Active"
12    },
13    "name": "TEST VENDOR GB",
14    "erpSystemDisplayId": "FINQ8S-300"
15  },
16  "partnerRole": {
17    "id": 10000004,
18    "displayId": "40",
19    "status": {
20      "name": "ACTIVE",
21      "captionKey": "enum.objectStatus.active",
22      "active": true,
23      "caption": "Active"
24    },
25    "name": "Lessor"
26  },
27  "masterAgreementId": 50004567,
28  "masterAgreementDisplayId": "MA-2024-0012",
29  "numberRangeIdentifierValue": "NR-10045",
30  "numberRangeIdentifierType": {
31    "name": "COMPANY_CODE"
32  },
33  "numberRangeType": {
34    "name": "CONTRACT"
35  },
36  "allowsSystemGenerateNewId": true
37}

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partner successfully updated.

ResponseMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "MAP-000045",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "masterAgreementId": 50004567,
33    "masterAgreementDisplayId": "MA-2024-0012",
34    "numberRangeIdentifierValue": "NR-10045",
35    "numberRangeIdentifierType": {
36      "name": "COMPANY_CODE"
37    },
38    "numberRangeType": {
39      "name": "CONTRACT"
40    },
41    "allowsSystemGenerateNewId": true
42  }
43}

Delete A Master Agreement Partner

HTTP Request

DELETE /api/v1/master-agreement-partners/{id}

📋 Description: Deletes a specified master agreement partner from the Nakisa Lease Accounting Suite, thereby removing any associated lease and contract financial obligations and ensuring accurate accounting entries.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000085

path

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partner successfully deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Updates Specified Master Agreement Partner

HTTP Request

PATCH /api/v1/master-agreement-partners/{id}

📋 Description: Patches the details of a specified master agreement partner, allowing for updates to lease and contract information relevant to financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

JsonPatch

false

Request body containing the updated master agreement partner details, including financial obligations and contract terms relevant to lease accounting.

Example Values

Parameter

Example

Type

id

10000081

path

body

{"op":"replace","path":"/name","value":"patched contract"}

body

Body Parameters

1{
2  "op": "replace",
3  "path": "/name",
4  "value": "patched contract"
5}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully patched master agreement partner.

ResponseMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "MAP-000045",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "masterAgreementId": 50004567,
33    "masterAgreementDisplayId": "MA-2024-0012",
34    "numberRangeIdentifierValue": "NR-10045",
35    "numberRangeIdentifierType": {
36      "name": "COMPANY_CODE"
37    },
38    "numberRangeType": {
39      "name": "CONTRACT"
40    },
41    "allowsSystemGenerateNewId": true
42  }
43}

Create Or Update A Master Agreement Partner

HTTP Request

PUT /api/v1/master-agreement-partners/createOrUpdate

📋 Description: Updates or creates master agreement partner records within the Nakisa Lease Accounting Suite, ensuring accurate management of lease contracts and financial obligations for streamlined accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

false

Request body containing the master agreement partner details, including lease and contract information, to create or update financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "MAP-000045",
 4  "partner": {
 5    "id": 10000012,
 6    "displayId": "0000100003",
 7    "status": {
 8      "name": "ACTIVE",
 9      "captionKey": "enum.objectStatus.active",
10      "active": true,
11      "caption": "Active"
12    },
13    "name": "TEST VENDOR GB",
14    "erpSystemDisplayId": "FINQ8S-300"
15  },
16  "partnerRole": {
17    "id": 10000004,
18    "displayId": "40",
19    "status": {
20      "name": "ACTIVE",
21      "captionKey": "enum.objectStatus.active",
22      "active": true,
23      "caption": "Active"
24    },
25    "name": "Lessor"
26  },
27  "masterAgreementId": 50004567,
28  "masterAgreementDisplayId": "MA-2024-0012",
29  "numberRangeIdentifierValue": "NR-10045",
30  "numberRangeIdentifierType": {
31    "name": "COMPANY_CODE"
32  },
33  "numberRangeType": {
34    "name": "CONTRACT"
35  },
36  "allowsSystemGenerateNewId": true
37}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the master agreement partner.

ResponseMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "MAP-000045",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "masterAgreementId": 50004567,
33    "masterAgreementDisplayId": "MA-2024-0012",
34    "numberRangeIdentifierValue": "NR-10045",
35    "numberRangeIdentifierType": {
36      "name": "COMPANY_CODE"
37    },
38    "numberRangeType": {
39      "name": "CONTRACT"
40    },
41    "allowsSystemGenerateNewId": true
42  }
43}

Create Or Update Multiple Master Agreement Partners

HTTP Request

PUT /api/v1/master-agreement-partners/createOrUpdate/bulk

📋 Description: Creates or updates multiple master agreement partners in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

false

Request body containing a bulk array of master agreement partner data, including lease details, contract terms, financial obligations, and associated accounting entries for efficient processing.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "MAP-000045",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "masterAgreementId": 50004567,
29    "masterAgreementDisplayId": "MA-2024-0012",
30    "numberRangeIdentifierValue": "NR-10045",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": true
38  }
39]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all master agreement partners.

ResponseListMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "MAP-000045",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "masterAgreementId": 50004567,
34      "masterAgreementDisplayId": "MA-2024-0012",
35      "numberRangeIdentifierValue": "NR-10045",
36      "numberRangeIdentifierType": {
37        "name": "COMPANY_CODE"
38      },
39      "numberRangeType": {
40        "name": "CONTRACT"
41      },
42      "allowsSystemGenerateNewId": true
43    }
44  ]
45}

Update Master Agreement Partners In Bulk

HTTP Request

PUT /api/v1/master-agreement-partners/bulk

📋 Description: Updates multiple master agreement partners in bulk within the Nakisa Lease Accounting Suite, facilitating efficient management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

false

Request body containing a collection of master agreement partner data, including details necessary for managing lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "MAP-000045",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "masterAgreementId": 50004567,
29    "masterAgreementDisplayId": "MA-2024-0012",
30    "numberRangeIdentifierValue": "NR-10045",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": true
38  }
39]

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partners successfully updated.

ResponseListMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "MAP-000045",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "masterAgreementId": 50004567,
34      "masterAgreementDisplayId": "MA-2024-0012",
35      "numberRangeIdentifierValue": "NR-10045",
36      "numberRangeIdentifierType": {
37        "name": "COMPANY_CODE"
38      },
39      "numberRangeType": {
40        "name": "CONTRACT"
41      },
42      "allowsSystemGenerateNewId": true
43    }
44  ]
45}

Create Master Agreement Partners In Bulk

HTTP Request

POST /api/v1/master-agreement-partners/bulk

📋 Description: Facilitates the bulk creation of master agreement partners within the Nakisa Lease Accounting Suite, enabling efficient management of lease contracts and associated financial obligations.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

false

Request body containing bulk data for master agreement partners, including lease details, contract terms, and associated financial obligations for accurate accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "MAP-000045",
 5    "partner": {
 6      "id": 10000012,
 7      "displayId": "0000100003",
 8      "status": {
 9        "name": "ACTIVE",
10        "captionKey": "enum.objectStatus.active",
11        "active": true,
12        "caption": "Active"
13      },
14      "name": "TEST VENDOR GB",
15      "erpSystemDisplayId": "FINQ8S-300"
16    },
17    "partnerRole": {
18      "id": 10000004,
19      "displayId": "40",
20      "status": {
21        "name": "ACTIVE",
22        "captionKey": "enum.objectStatus.active",
23        "active": true,
24        "caption": "Active"
25      },
26      "name": "Lessor"
27    },
28    "masterAgreementId": 50004567,
29    "masterAgreementDisplayId": "MA-2024-0012",
30    "numberRangeIdentifierValue": "NR-10045",
31    "numberRangeIdentifierType": {
32      "name": "COMPANY_CODE"
33    },
34    "numberRangeType": {
35      "name": "CONTRACT"
36    },
37    "allowsSystemGenerateNewId": true
38  }
39]

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partners successfully created.

ResponseListMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "MAP-000045",
10      "partner": {
11        "id": 10000012,
12        "displayId": "0000100003",
13        "status": {
14          "name": "ACTIVE",
15          "captionKey": "enum.objectStatus.active",
16          "active": true,
17          "caption": "Active"
18        },
19        "name": "TEST VENDOR GB",
20        "erpSystemDisplayId": "FINQ8S-300"
21      },
22      "partnerRole": {
23        "id": 10000004,
24        "displayId": "40",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "Lessor"
32      },
33      "masterAgreementId": 50004567,
34      "masterAgreementDisplayId": "MA-2024-0012",
35      "numberRangeIdentifierValue": "NR-10045",
36      "numberRangeIdentifierType": {
37        "name": "COMPANY_CODE"
38      },
39      "numberRangeType": {
40        "name": "CONTRACT"
41      },
42      "allowsSystemGenerateNewId": true
43    }
44  ]
45}

Delete Master Agreement Partners In Bulk

HTTP Request

DELETE /api/v1/master-agreement-partners/bulk

📋 Description: Deletes multiple master agreement partners in bulk, facilitating the management of lease contracts and associated financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

array[integer]

false

Request body containing an array of identifiers for master agreement partners to be deleted, relevant for managing lease and contract financial obligations within the Nakisa Lease Accounting Suite.

Body Parameters

1[
2  123
3]

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partners successfully deleted.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

List All Master Agreement Partners

HTTP Request

GET /api/v1/master-agreement-partners

📋 Description: Retrieves a list of master agreement partners associated with lease contracts, enabling users to manage financial obligations and accounting entries effectively.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the master agreement partners query should be returned in a paginated format, facilitating efficient data retrieval for lease and contract management within the Nakisa Lease Accounting Suite.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of master agreement partners.

PageMasterAgreementPartnerDto

Example Responses

 1{
 2  "totalElements": 250,
 3  "totalPages": 5,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 50,
17  "size": 50,
18  "content": [
19    {
20      "id": 10000001,
21      "displayId": "MAP-000045",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "masterAgreementId": 50004567,
46      "masterAgreementDisplayId": "MA-2024-0012",
47      "numberRangeIdentifierValue": "NR-10045",
48      "numberRangeIdentifierType": {
49        "name": "COMPANY_CODE"
50      },
51      "numberRangeType": {
52        "name": "CONTRACT"
53      },
54      "allowsSystemGenerateNewId": true
55    }
56  ],
57  "number": 0,
58  "sort": {
59    "unsorted": false,
60    "sorted": true,
61    "empty": false
62  },
63  "first": true,
64  "last": false,
65  "empty": false
66}

Create Master Agreement Partner

HTTP Request

POST /api/v1/master-agreement-partners

📋 Description: Creates a new master agreement partner within the Nakisa Lease Accounting Suite, facilitating the management of lease contracts and associated financial obligations for accurate accounting entries.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

false

Request body containing the details of master agreement partners, including lease terms, contract specifications, and associated financial obligations for accurate accounting entries.

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "MAP-000045",
 4  "partner": {
 5    "id": 10000012,
 6    "displayId": "0000100003",
 7    "status": {
 8      "name": "ACTIVE",
 9      "captionKey": "enum.objectStatus.active",
10      "active": true,
11      "caption": "Active"
12    },
13    "name": "TEST VENDOR GB",
14    "erpSystemDisplayId": "FINQ8S-300"
15  },
16  "partnerRole": {
17    "id": 10000004,
18    "displayId": "40",
19    "status": {
20      "name": "ACTIVE",
21      "captionKey": "enum.objectStatus.active",
22      "active": true,
23      "caption": "Active"
24    },
25    "name": "Lessor"
26  },
27  "masterAgreementId": 50004567,
28  "masterAgreementDisplayId": "MA-2024-0012",
29  "numberRangeIdentifierValue": "NR-10045",
30  "numberRangeIdentifierType": {
31    "name": "COMPANY_CODE"
32  },
33  "numberRangeType": {
34    "name": "CONTRACT"
35  },
36  "allowsSystemGenerateNewId": true
37}

Responses

Status

Meaning

Description

Schema

200

OK

Master agreement partner successfully created.

ResponseMasterAgreementPartnerDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "MAP-000045",
 9    "partner": {
10      "id": 10000012,
11      "displayId": "0000100003",
12      "status": {
13        "name": "ACTIVE",
14        "captionKey": "enum.objectStatus.active",
15        "active": true,
16        "caption": "Active"
17      },
18      "name": "TEST VENDOR GB",
19      "erpSystemDisplayId": "FINQ8S-300"
20    },
21    "partnerRole": {
22      "id": 10000004,
23      "displayId": "40",
24      "status": {
25        "name": "ACTIVE",
26        "captionKey": "enum.objectStatus.active",
27        "active": true,
28        "caption": "Active"
29      },
30      "name": "Lessor"
31    },
32    "masterAgreementId": 50004567,
33    "masterAgreementDisplayId": "MA-2024-0012",
34    "numberRangeIdentifierValue": "NR-10045",
35    "numberRangeIdentifierType": {
36      "name": "COMPANY_CODE"
37    },
38    "numberRangeType": {
39      "name": "CONTRACT"
40    },
41    "allowsSystemGenerateNewId": true
42  }
43}

Retrieve Contacts For A Master Agreement Partner

HTTP Request

GET /api/v1/master-agreement-partners/{id}/contacts

📋 Description: Fetches the contact details associated with a specific master agreement partner, facilitating effective management of lease and contract-related communications within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved contacts for the master agreement partner.

ResponseListContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "CONT-0001",
10      "name": "Jane Doe",
11      "position": "Procurement Manager",
12      "email": "jane.doe@example.com",
13      "phone": "+49 123 456 7890",
14      "address": "123 Business St, Berlin, Germany",
15      "description": "Main point of contact for vendor negotiations.",
16      "group": "string",
17      "buildingName": "string",
18      "fax": "string",
19      "numberRangeIdentifierValue": "BU-01",
20      "numberRangeIdentifierType": {
21        "name": "COMPANY_CODE"
22      },
23      "numberRangeType": {
24        "name": "CONTRACT"
25      },
26      "allowsSystemGenerateNewId": true
27    }
28  ]
29}

Create Contact For A Master Agreement Partner

HTTP Request

POST /api/v1/master-agreement-partners/{id}/contacts

📋 Description: Creates a new contact associated with the specified master agreement partner, facilitating the management of lease-related communications and ensuring accurate accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContactDto

false

Request body containing the contact information and associated details for the specified master agreement partner, essential for managing lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 1{
 2  "id": 10000001,
 3  "displayId": "CONT-0001",
 4  "name": "Jane Doe",
 5  "position": "Procurement Manager",
 6  "email": "jane.doe@example.com",
 7  "phone": "+49 123 456 7890",
 8  "address": "123 Business St, Berlin, Germany",
 9  "description": "Main point of contact for vendor negotiations.",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "numberRangeIdentifierValue": "BU-01",
14  "numberRangeIdentifierType": {
15    "name": "COMPANY_CODE"
16  },
17  "numberRangeType": {
18    "name": "CONTRACT"
19  },
20  "allowsSystemGenerateNewId": true
21}

Responses

Status

Meaning

Description

Schema

200

OK

Contact successfully created for the master agreement partner.

ResponseContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 10000001,
 8    "displayId": "CONT-0001",
 9    "name": "Jane Doe",
10    "position": "Procurement Manager",
11    "email": "jane.doe@example.com",
12    "phone": "+49 123 456 7890",
13    "address": "123 Business St, Berlin, Germany",
14    "description": "Main point of contact for vendor negotiations.",
15    "group": "string",
16    "buildingName": "string",
17    "fax": "string",
18    "numberRangeIdentifierValue": "BU-01",
19    "numberRangeIdentifierType": {
20      "name": "COMPANY_CODE"
21    },
22    "numberRangeType": {
23      "name": "CONTRACT"
24    },
25    "allowsSystemGenerateNewId": true
26  }
27}

Create Multiple Contacts For A Master Agreement Partner

HTTP Request

POST /api/v1/master-agreement-partners/{id}/contacts/bulk

📋 Description: Uploads multiple contact records for a specified master agreement partner, facilitating efficient management of lease-related contacts within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ContactDto

false

Request body containing a collection of contact information for master agreement partners, essential for managing lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

 1[
 2  {
 3    "id": 10000001,
 4    "displayId": "CONT-0001",
 5    "name": "Jane Doe",
 6    "position": "Procurement Manager",
 7    "email": "jane.doe@example.com",
 8    "phone": "+49 123 456 7890",
 9    "address": "123 Business St, Berlin, Germany",
10    "description": "Main point of contact for vendor negotiations.",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "numberRangeIdentifierValue": "BU-01",
15    "numberRangeIdentifierType": {
16      "name": "COMPANY_CODE"
17    },
18    "numberRangeType": {
19      "name": "CONTRACT"
20    },
21    "allowsSystemGenerateNewId": true
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

Contacts successfully created for the master agreement partner.

ResponseListContactDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 10000001,
 9      "displayId": "CONT-0001",
10      "name": "Jane Doe",
11      "position": "Procurement Manager",
12      "email": "jane.doe@example.com",
13      "phone": "+49 123 456 7890",
14      "address": "123 Business St, Berlin, Germany",
15      "description": "Main point of contact for vendor negotiations.",
16      "group": "string",
17      "buildingName": "string",
18      "fax": "string",
19      "numberRangeIdentifierValue": "BU-01",
20      "numberRangeIdentifierType": {
21        "name": "COMPANY_CODE"
22      },
23      "numberRangeType": {
24        "name": "CONTRACT"
25      },
26      "allowsSystemGenerateNewId": true
27    }
28  ]
29}

Delete Multiple Contacts For A Master Agreement Partner

HTTP Request

DELETE /api/v1/master-agreement-partners/{id}/contacts/bulk

📋 Description: Deletes multiple contacts associated with a specified master agreement partner, streamlining the management of lease-related financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

array[integer]

false

Request body containing an array of contact identifiers to be removed in bulk from the specified master agreement partner, facilitating efficient management of lease-related financial obligations within the Nakisa Lease Accounting Suite.

Example Values

Parameter

Example

Type

id

10000001

path

Body Parameters

1[
2  123
3]

Responses

Status

Meaning

Description

Schema

200

OK

Contacts successfully deleted for the master agreement partner.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Search Master Agreement Partners

HTTP Request

POST /api/v1/master-agreement-partners/search

📋 Description: Submits a search request for master agreement partners, enabling users to efficiently identify relevant lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

MasterAgreementPartnerDtoFilter

false

Request body containing search criteria and filters for identifying master agreement partners relevant to lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

Body Parameters

 1{
 2  "idIn": [
 3    10001,
 4    10002
 5  ],
 6  "idEqual": 10001,
 7  "idLike": "1000%",
 8  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10  "createdByLike": "admin%",
11  "createdByEqual": "super.admin@nakisa.com",
12  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14  "modifiedByLike": "editor%",
15  "modifiedByEqual": "super.editor@nakisa.com",
16  "displayIdIn": [
17    "MAP-1001",
18    "MAP-1002"
19  ],
20  "displayIdLike": "MAP-%",
21  "partnerIdIn": [
22    20001,
23    20002
24  ],
25  "partnerDisplayIdIn": [
26    "P-2001",
27    "P-2002"
28  ],
29  "partnerRoleIdIn": [
30    30001,
31    30002
32  ],
33  "partnerRoleDisplayIdIn": [
34    "ROLE-VENDOR",
35    "ROLE-CUSTOMER"
36  ],
37  "masterAgreementIdIn": [
38    40001,
39    40002
40  ],
41  "masterAgreementDisplayIdIn": [
42    "MA-2024-001",
43    "MA-2024-002"
44  ]
45}

Responses

Status

Meaning

Description

Schema

200

OK

Search results for master agreement partners successfully returned.

PageMasterAgreementPartnerDto

Example Responses

 1{
 2  "totalElements": 250,
 3  "totalPages": 5,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 50,
17  "size": 50,
18  "content": [
19    {
20      "id": 10000001,
21      "displayId": "MAP-000045",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "masterAgreementId": 50004567,
46      "masterAgreementDisplayId": "MA-2024-0012",
47      "numberRangeIdentifierValue": "NR-10045",
48      "numberRangeIdentifierType": {
49        "name": "COMPANY_CODE"
50      },
51      "numberRangeType": {
52        "name": "CONTRACT"
53      },
54      "allowsSystemGenerateNewId": true
55    }
56  ],
57  "number": 0,
58  "sort": {
59    "unsorted": false,
60    "sorted": true,
61    "empty": false
62  },
63  "first": true,
64  "last": false,
65  "empty": false
66}

Retrieve Partners For A Master Agreement

HTTP Request

GET /api/v1/master-agreement-partners/master-agreement/{masterAgreementId}

📋 Description: Retrieves detailed information about a specific master agreement partner associated with the given master agreement ID, facilitating effective management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

masterAgreementId

path

integer

true

Unique identifier for the master agreement

pageable

query

Pageable

false

Indicates whether the results should be returned in a paginated format, facilitating efficient retrieval of lease and contract data related to financial obligations and accounting entries.

Example Values

Parameter

Example

Type

masterAgreementId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved partners for the master agreement.

PageMasterAgreementPartnerDto

Example Responses

 1{
 2  "totalElements": 250,
 3  "totalPages": 5,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 50,
17  "size": 50,
18  "content": [
19    {
20      "id": 10000001,
21      "displayId": "MAP-000045",
22      "partner": {
23        "id": 10000012,
24        "displayId": "0000100003",
25        "status": {
26          "name": "ACTIVE",
27          "captionKey": "enum.objectStatus.active",
28          "active": true,
29          "caption": "Active"
30        },
31        "name": "TEST VENDOR GB",
32        "erpSystemDisplayId": "FINQ8S-300"
33      },
34      "partnerRole": {
35        "id": 10000004,
36        "displayId": "40",
37        "status": {
38          "name": "ACTIVE",
39          "captionKey": "enum.objectStatus.active",
40          "active": true,
41          "caption": "Active"
42        },
43        "name": "Lessor"
44      },
45      "masterAgreementId": 50004567,
46      "masterAgreementDisplayId": "MA-2024-0012",
47      "numberRangeIdentifierValue": "NR-10045",
48      "numberRangeIdentifierType": {
49        "name": "COMPANY_CODE"
50      },
51      "numberRangeType": {
52        "name": "CONTRACT"
53      },
54      "allowsSystemGenerateNewId": true
55    }
56  ],
57  "number": 0,
58  "sort": {
59    "unsorted": false,
60    "sorted": true,
61    "empty": false
62  },
63  "first": true,
64  "last": false,
65  "empty": false
66}

Delete All Partners For A Master Agreement

HTTP Request

DELETE /api/v1/master-agreement-partners/master-agreement/{masterAgreementId}

📋 Description: Deletes a specified master agreement partner from the Nakisa Lease Accounting Suite, thereby removing associated financial obligations and accounting entries linked to the designated master agreement.

Parameters

Name

In

Type

Required

Description

masterAgreementId

path

integer

true

Unique identifier for the master agreement

Example Values

Parameter

Example

Type

masterAgreementId

10000001

path

Responses

Status

Meaning

Description

Schema

200

OK

All partners successfully deleted for the master agreement.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}

Delete Contact For A Master Agreement Partner

HTTP Request

DELETE /api/v1/master-agreement-partners/{id}/contacts/{contactId}

📋 Description: Deletes a specified contact associated with a master agreement partner, ensuring accurate management of lease-related financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

contactId

path

integer

true

Unique identifier for the contact

Example Values

Parameter

Example

Type

id

10000001

path

contactId

20000005

path

Responses

Status

Meaning

Description

Schema

200

OK

Contact successfully deleted for the master agreement partner.

ResponseVoid

Example Responses

1{
2  "code": "OK",
3  "errors": {
4    "all": []
5  },
6  "object": {}
7}