Financials | Financial Institution
Service to manage entities of type 'FinancialInstitution'.
This service extends Parties.
Overview
| URL | api/{tenantKey}/{orgKey}/financialCore/financialInstitutions |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET FinancialInstitutions
- GET FinancialInstitutions (paged)
- GET FinancialInstitution by identifier
- GET FinancialInstitution by key
- GET FinancialInstitutions (with Party)
- GET FinancialInstitutions (with Party) (paged)
- GET FinancialInstitution (with Party) by identifier
- GET FinancialInstitution (with Party) by key
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET FinancialInstitutions
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See FinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/extension
GET /financialCore/financialInstitutions/extension
GET FinancialInstitutions (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See FinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/extension?page={page}&pageSize={pageSize}
GET /financialCore/financialInstitutions/extension?page={page}&pageSize={pageSize}
GET FinancialInstitution by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See FinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{id}/extension
GET /financialCore/financialInstitutions/{id}/extension
GET FinancialInstitution by key
Returns the entity record that matches the specified key.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
Response:
| When successful, the response body contains the entity record. See FinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}/extension
GET /financialCore/financialInstitutions/{partyKey}/extension
GET FinancialInstitutions (with Party)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseFinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions
GET /financialCore/financialInstitutions
GET FinancialInstitutions (with Party) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See BaseFinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions?page={page}&pageSize={pageSize}
GET /financialCore/financialInstitutions?page={page}&pageSize={pageSize}
GET FinancialInstitution (with Party) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseFinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{id}
GET /financialCore/financialInstitutions/{id}
GET FinancialInstitution (with Party) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
Response:
| When successful, the response body contains the entity record. See BaseFinancialInstitutionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}
GET /financialCore/financialInstitutions/{partyKey}
POST FinancialInstitutions
Creates a new entity record.
The following elements are required:
| financialInstitutionResource | (ApiFinancialInstitutionResource) The request body should contain the entity record that should be created. See ApiFinancialInstitutionResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiFinancialInstitutionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/extension
POST /financialCore/financialInstitutions/extension
POST FinancialInstitutions (with ApiBaseFinancialInstitution)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| financialInstitutionResource | (ApiFinancialInstitutionResource) The request body should contain the entity record that should be created. See ApiFinancialInstitutionResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseFinancialInstitutionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions
POST /financialCore/financialInstitutions
PUT Set BankCode FinancialInstitution
Updates the value of attribute 'BankCode' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}/bankCode
PUT /financialCore/financialInstitutions/{partyKey}/bankCode
PUT Set IsActive FinancialInstitution
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}/isActive
PUT /financialCore/financialInstitutions/{partyKey}/isActive
PUT Set MainSWIFT FinancialInstitution
Updates the value of attribute 'MainSWIFT' in the specified entity record.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}/mainSWIFT
PUT /financialCore/financialInstitutions/{partyKey}/mainSWIFT
DELETE FinancialInstitution by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{id}
DELETE /financialCore/financialInstitutions/{id}
DELETE FinancialInstitution by key
Deletes the entity record that matches the specified key.
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/financialCore/financialInstitutions/{partyKey}
DELETE /financialCore/financialInstitutions/{partyKey}
Resources
ApiBaseFinancialInstitutionResource
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| name | (string) The name for the party. |
| isExternallyManaged | (bool) A flag indicating if the party is externally managed. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| isPerson | (bool) Indicates that this entity is a person. |
The following elements are optional:
| bankCode | (string) The main Society for Worldwide Interbank Financial Telecommunication number. |
| mainSWIFT | (string) The main society for Worldwide Interbank Financial Telecommunication number. |
| searchTerm | (string) The search term. |
| companyTaxID | (string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. |
| electronicMail | (string) The electronic mail for the party. |
| telephone | (string) The telephone for the party. |
| mobile | (string) The mobile for the party. |
| websiteUrl | (string) The website url for the party. |
| notes | (string) The notes for the party. |
| picture | (string) The picture for the party. |
| streetName | (string) The party main address street's name. |
| buildingNumber | (string) The party main address building's number. |
| postalZone | (string) The party main address postal zone. |
| cityName | (string) The party main address city's name. |
| contactName | (string) The party main contact's name. |
| contactTitle | (string) The party main contact's title. |
| username | (string) The party's Identity Username. |
| externalId | (string) The external identifier for the party. |
| externalVersion | (string) The external version for the party. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
ApiFinancialInstitutionResource
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| bankCode | (string) The main Society for Worldwide Interbank Financial Telecommunication number. |
| mainSWIFT | (string) The main society for Worldwide Interbank Financial Telecommunication number. |
BaseFinancialInstitutionResource
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
| name | (string) The name for the party. |
| isExternallyManaged | (bool) A flag indicating if the party is externally managed. |
| currency | (string) The party's default currency. |
| country | (string) The party's country. |
| isPerson | (bool) Indicates that this entity is a person. |
The following elements are optional:
| bankCode | (string) The main Society for Worldwide Interbank Financial Telecommunication number. |
| mainSWIFT | (string) The main society for Worldwide Interbank Financial Telecommunication number. |
| searchTerm | (string) The search term. |
| companyTaxID | (string) The party tax identifier. The unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. |
| electronicMail | (string) The electronic mail for the party. |
| telephone | (string) The telephone for the party. |
| mobile | (string) The mobile for the party. |
| websiteUrl | (string) The website url for the party. |
| notes | (string) The notes for the party. |
| picture | (string) The picture for the party. |
| streetName | (string) The party main address street's name. |
| buildingNumber | (string) The party main address building's number. |
| postalZone | (string) The party main address postal zone. |
| cityName | (string) The party main address city's name. |
| contactName | (string) The party main contact's name. |
| contactTitle | (string) The party main contact's title. |
| username | (string) The party's Identity Username. |
| externalId | (string) The external identifier for the party. |
| externalVersion | (string) The external version for the party. |
| address | (string) The party's main address. |
| contact | (string) The party's main contact. |
| culture | (string) The culture for the party. |
FinancialInstitutionResource
The following elements are required:
| partyKey | (string) The key for the party. Uniquely identifies the entity/party within the organization. |
The following elements are optional:
| bankCode | (string) The main Society for Worldwide Interbank Financial Telecommunication number. |
| mainSWIFT | (string) The main society for Worldwide Interbank Financial Telecommunication number. |