Financials | Bank Account

Service to manage entities of type 'PartyBankAccount'.

This service extends Parties.

Overview

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts

URL	api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST PartyBankAccounts
- POST PartyBankAccounts (with ApiBasePartyBankAccount)
PUT:
DELETE:
- DELETE PartyBankAccount by identifier
- DELETE PartyBankAccount by key

All Resources

This service uses the following resources:

ApiBasePartyBankAccountResource
ApiPartyBankAccountResource
BasePartyBankAccountResource
PartyBankAccountResource

All Enumerations

This service uses the following enumerations:

DirectDebitFileType

GET Operations

GET PartyBankAccounts

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PartyBankAccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts/extension

GET /financialCore/partyBankAccounts/extension

GET PartyBankAccounts (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 PartyBankAccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts/extension?page={page}&pageSize={pageSize}

GET /financialCore/partyBankAccounts/extension?page={page}&pageSize={pageSize}

GET PartyBankAccount 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 PartyBankAccountResource.

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/partyBankAccounts/{id}/extension

GET /financialCore/partyBankAccounts/{id}/extension

GET PartyBankAccount 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 PartyBankAccountResource.

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/partyBankAccounts/{partyKey}/extension

GET /financialCore/partyBankAccounts/{partyKey}/extension

GET PartyBankAccounts (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 BasePartyBankAccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts

GET /financialCore/partyBankAccounts

GET PartyBankAccounts (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 BasePartyBankAccountResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts?page={page}&pageSize={pageSize}

GET /financialCore/partyBankAccounts?page={page}&pageSize={pageSize}

GET PartyBankAccount (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 BasePartyBankAccountResource.

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/partyBankAccounts/{id}

GET /financialCore/partyBankAccounts/{id}

GET PartyBankAccount (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 BasePartyBankAccountResource.

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/partyBankAccounts/{partyKey}

GET /financialCore/partyBankAccounts/{partyKey}

POST Operations

POST PartyBankAccounts

Creates a new entity record.

The following elements are required:

partyBankAccountResource

(ApiPartyBankAccountResource) The request body should contain the entity record that should be created.
See ApiPartyBankAccountResource.

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 ApiPartyBankAccountResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts/extension

POST /financialCore/partyBankAccounts/extension

POST PartyBankAccounts (with ApiBasePartyBankAccount)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

partyBankAccountResource

(ApiPartyBankAccountResource) The request body should contain the entity record that should be created.
See ApiPartyBankAccountResource.

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 ApiBasePartyBankAccountResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts

POST /financialCore/partyBankAccounts

PUT Operations

PUT Set Currency PartyBankAccount

Updates the value of attribute 'Currency' 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/partyBankAccounts/{partyKey}/currency

PUT /financialCore/partyBankAccounts/{partyKey}/currency

PUT Set DebitAuthorizationNumber PartyBankAccount

Updates the value of attribute 'DebitAuthorizationNumber' 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/partyBankAccounts/{partyKey}/debitAuthorizationNumber

PUT /financialCore/partyBankAccounts/{partyKey}/debitAuthorizationNumber

PUT Set DirectDebitAmountLimit PartyBankAccount

Updates the value of attribute 'DirectDebitAmountLimit' 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	(decimal) 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/partyBankAccounts/{partyKey}/directDebitAmountLimit

PUT /financialCore/partyBankAccounts/{partyKey}/directDebitAmountLimit

PUT Set DirectDebitFileType PartyBankAccount

Updates the value of attribute 'DirectDebitFileType' 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	(enum DirectDebitFileType) The request body should contain the new value for the attribute. See DirectDebitFileType.

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/partyBankAccounts/{partyKey}/directDebitFileType

PUT /financialCore/partyBankAccounts/{partyKey}/directDebitFileType

PUT Set DirectDebitStartDate PartyBankAccount

Updates the value of attribute 'DirectDebitStartDate' 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	(DateTime) 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/partyBankAccounts/{partyKey}/directDebitStartDate

PUT /financialCore/partyBankAccounts/{partyKey}/directDebitStartDate

PUT Set FinancialInstitution PartyBankAccount

Updates the value of attribute 'FinancialInstitution' 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/partyBankAccounts/{partyKey}/financialInstitution

PUT /financialCore/partyBankAccounts/{partyKey}/financialInstitution

PUT Set HasPreviousPayments PartyBankAccount

Updates the value of attribute 'HasPreviousPayments' 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.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts/{partyKey}/hasPreviousPayments

PUT /financialCore/partyBankAccounts/{partyKey}/hasPreviousPayments

PUT Set IBAN PartyBankAccount

Updates the value of attribute 'IBAN' 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/partyBankAccounts/{partyKey}/iBAN

PUT /financialCore/partyBankAccounts/{partyKey}/iBAN

PUT Set IsActive PartyBankAccount

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/partyBankAccounts/{partyKey}/isActive

PUT /financialCore/partyBankAccounts/{partyKey}/isActive

PUT Set IsAuthorizationActive PartyBankAccount

Updates the value of attribute 'IsAuthorizationActive' 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.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/partyBankAccounts/{partyKey}/isAuthorizationActive

PUT /financialCore/partyBankAccounts/{partyKey}/isAuthorizationActive

PUT Set SWIFT PartyBankAccount

Updates the value of attribute 'SWIFT' 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/partyBankAccounts/{partyKey}/sWIFT

PUT /financialCore/partyBankAccounts/{partyKey}/sWIFT

DELETE Operations

DELETE PartyBankAccount 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/partyBankAccounts/{id}

DELETE /financialCore/partyBankAccounts/{id}

DELETE PartyBankAccount 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/partyBankAccounts/{partyKey}

DELETE /financialCore/partyBankAccounts/{partyKey}

Resources

ApiBasePartyBankAccountResource

The following elements are required:

isAuthorizationActive	(bool) Authorize method of payment by direct debit.
directDebitAmountLimit	(decimal) The direct debit amount limit (value in EUR). (0.00 means no limit).
currency	(string) The direct debit currency (EUR).
hasPreviousPayments	(bool) States wether or not current mandate had allready been used.
directDebitFileType	(enum DirectDebitFileType) The type of the direct debit mandate authorization. See DirectDebitFileType.
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.
country	(string) The party's country.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

iBAN	(string) The party International Bank Account Number.
debitAuthorizationNumber	(string) The direct debit authorization number.
financialInstitution	(string) The associated financial institution.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
directDebitStartDate	(DateTime) The date or the mandate signature or date of the first mandate.
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.

ApiPartyBankAccountResource

The following elements are required:

isAuthorizationActive	(bool) Authorize method of payment by direct debit.
directDebitAmountLimit	(decimal) The direct debit amount limit (value in EUR). (0.00 means no limit).
currency	(string) The direct debit currency (EUR).
hasPreviousPayments	(bool) States wether or not current mandate had allready been used.
directDebitFileType	(enum DirectDebitFileType) The type of the direct debit mandate authorization. See DirectDebitFileType.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

iBAN	(string) The party International Bank Account Number.
debitAuthorizationNumber	(string) The direct debit authorization number.
financialInstitution	(string) The associated financial institution.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
directDebitStartDate	(DateTime) The date or the mandate signature or date of the first mandate.

BasePartyBankAccountResource

The following elements are required:

isAuthorizationActive	(bool) Authorize method of payment by direct debit.
directDebitAmountLimit	(decimal) The direct debit amount limit (value in EUR). (0.00 means no limit).
currency	(string) The direct debit currency (EUR).
hasPreviousPayments	(bool) States wether or not current mandate had allready been used.
directDebitFileType	(enum DirectDebitFileType) The type of the direct debit mandate authorization. See DirectDebitFileType.
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.
country	(string) The party's country.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

iBAN	(string) The party International Bank Account Number.
debitAuthorizationNumber	(string) The direct debit authorization number.
financialInstitution	(string) The associated financial institution.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
directDebitStartDate	(DateTime) The date or the mandate signature or date of the first mandate.
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.

PartyBankAccountResource

The following elements are required:

isAuthorizationActive	(bool) Authorize method of payment by direct debit.
directDebitAmountLimit	(decimal) The direct debit amount limit (value in EUR). (0.00 means no limit).
currency	(string) The direct debit currency (EUR). (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
hasPreviousPayments	(bool) States wether or not current mandate had allready been used.
directDebitFileType	(enum DirectDebitFileType) The type of the direct debit mandate authorization. See DirectDebitFileType.
partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.

The following elements are optional:

iBAN	(string) The party International Bank Account Number.
debitAuthorizationNumber	(string) The direct debit authorization number.
financialInstitution	(string) The associated financial institution. (fk) Allowed value: the natural key of a record of type FinancialInstitution. These records are accessibly through the FinancialInstitutions service.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
directDebitStartDate	(DateTime) The date or the mandate signature or date of the first mandate.

Enumerations

DirectDebitFileType

1	CORE
2	B2B