Enterprise APIs

The Arrangement Microservice APIs can be categorized under the following versions:

Version 1

Following are the list of Business APIs supported:

TABLE NAME	OPERATION ID	URI	API DESCRIPTION
Arrangement Details	getPartyArrangementDetails	/holdings/parties/{partyid}/bulkarrangements	Retrieves all the Arrangement details of the PartyId.
	getPartyRoleForArrangement	/holdings/arrangement/{arrangementid}/roles	Retrieves the Party Roles for the ArrangementId.
	getBulkArrangements	/holdings/bulkarrangements/{arrangementid}	Retrieves Arrangement details for the list of arrangementid/IBAN.
	getReconciledArrangementDetails	/holdings/arrangements/{arrangementid}/reconcile	Retrieves Arrangement details to Reconcilation for a given arrangement id.
Payment Schedules	getScheduleForArrangement	/holdings/arrangement/{arrangementid}/schedules	Retrieves the Payment Schedules for the ArrangementId.
Payment Schedules	getScheduleStatusForArrangement	/holdings/arrangement/{arrangementid}/schedulestatus	Retrieves the Payment Schedules status for the ArrangementId.
Company	getListOfCompany	/reference/companies	Retrieves the list of available companies.
	createCompany	/reference/companies/{companyId}	Creates a new company.
	updateCompany	/reference/companies/{companyId}	Updates company details.

Version 2

Following are the list of Business APIs supported from release 202101 onwards:

TABLE NAME	OPERATION ID	URI	API DESCRIPTION
Arrangement Details	getPartyArrangementDetailsV2	/holdings/parties/{partyid}/bulkarrangements	Retrieves all the Arrangement details of the PartyId.
	getBulkArrangementsV2	/holdings/bulkarrangements/{arrangementid}	Retrieves Arrangement details for the list of arrangementid/IBAN.
	getPartyRoleForArrangementV2	/holdings/arrangement/{arrangementid}/roles	Get the Party Roles for the ArrangementId.
Payment Schedules	getScheduleForArrangementV2	/holdings/arrangement/{arrangementid}/schedules	Retrieves the Payment Schedules for the ArrangementId.
Payment Schedules	getScheduleStatusForArrangementV2	/holdings/arrangement/{arrangementid}/schedulestatus	Retrieves the Payment Schedules status for the ArrangementId.
Party Details	getPartyDetailsV2	/holdings/parties/{partyid}	Get the Party and its information Details for the PartyId.

Version 3

Following are the list of Business APIs supported from 202104 onwards:

TABLE NAME	OPERATION ID	URI	API DESCRIPTION
Arrangement Details	getPartyArrangementDetailsV3	/holdings/parties/{partyid}/bulkarrangements	Retrieves all the Arrangement details of the PartyId.
	getBulkArrangementsV3	/holdings/bulkarrangements/{arrangementid}	Retrieves Arrangement details for the list of arrangementid/IBAN.
	createArrangementInfoV3	/holdings/arrangements/	Create Arrangement Details.
	updateArrangementInfoV3	/holdings/arrangements/	Update Arrangement Details.
	getBillDetailsV3	/holdings/arrangements/{arrangementId}/bills	Get Bill Details for the ArrangementId.

Version 4

Following are the list of Business APIs supported from 202110 onwards:

TABLE NAME	OPERATION ID	URI	API DESCRIPTION
Arrangement Details	getPartyArrangementDetailsV4	/holdings/parties/{partyid}/bulkarrangements	Retrieves all the Arrangement details of the PartyId.
	getBulkArrangementsV4	/holdings/bulkarrangements/{arrangementid}	Retrieves Arrangement details for the list of arrangementid/IBAN.
	createArrangementInfoV4	/holdings/arrangements/	Create Arrangement Details.
	updateArrangementInfoV4	/holdings/arrangements/	Update Arrangement Details.
Party Role Details	getPartyRoles	/reference/partyroles	Get all the party roles.

Version 5

Following are the list of Business APIs supported from 202110 onwards:

TABLE NAME	OPERATION ID	URI	API DESCRIPTION
Arrangement Details	getPartyArrangementDetailsV5	/holdings/parties/{partyid}/bulkarrangements	Get all the Arrangement Details of the PartyId.
Arrangement Details	getBulkArrangementsV5	/holdings/bulkarrangements/{arrangementid}	Get ArrangementDetails for the list of arrangementid/IBAN.

To view the complete APIs specification, refer to the Service Spec (Swagger) .

In this topic