Financials | Financial Party

The Financial Party represents a bank account of the party.

This service extends Parties.

Overview

api/{tenantKey}/{orgKey}/financialCore/financialParties

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiBaseFinancialPartyFinancialPartyBankAccountsResource
ApiBaseFinancialPartyResource
ApiFinancialPartyFinancialPartyBankAccountsResource
ApiFinancialPartyResource
BaseFinancialPartyFinancialPartyBankAccountsResource
BaseFinancialPartyResource
FinancialPartyBankAccountResource
FinancialPartyResource
MoneyResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

DirectDebitFileType

GET Operations

GET FinancialParties

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

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

GET /financialCore/financialParties/extension

GET FinancialParties (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 FinancialPartyResource.

Response status codes:

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

Resource URL:

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

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

GET FinancialParty 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 FinancialPartyResource.

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

GET /financialCore/financialParties/{id}/extension

GET FinancialParty 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 FinancialPartyResource.

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

GET /financialCore/financialParties/{partyKey}/extension

GET FinancialParties (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 BaseFinancialPartyResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialParties

GET /financialCore/financialParties

GET FinancialParties (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 BaseFinancialPartyResource.

Response status codes:

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

Resource URL:

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

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

GET FinancialParty (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 BaseFinancialPartyResource.

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

GET /financialCore/financialParties/{id}

GET FinancialParty (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 BaseFinancialPartyResource.

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

GET /financialCore/financialParties/{partyKey}

POST Operations

POST FinancialParties

Creates a new entity record.

The following elements are required:

financialPartyResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

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

POST /financialCore/financialParties/extension

POST FinancialParties (with ApiBaseFinancialParty)

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

The following elements are required:

financialPartyResource

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

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialParties

POST /financialCore/financialParties

POST Financial Party

Inserts a new 'Financial Party Bank Account' in the 'Financial Party'.

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
value	(ApiFinancialPartyFinancialPartyBankAccountsResource) The ApiFinancialPartyFinancialPartyBankAccountsResource instance. See ApiFinancialPartyFinancialPartyBankAccountsResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity.
The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName".
While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/financialParties/{partyKey}/financialPartyBankAccounts

POST /financialCore/financialParties/{partyKey}/financialPartyBankAccounts

PUT Operations

PUT Set AccountNumber FinancialPartyBankAccount

Updates the value of attribute 'AccountNumber' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/accountNumber

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/accountNumber

PUT Set BankAccountType FinancialPartyBankAccount

Updates the value of attribute 'BankAccountType' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/bankAccountType

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/bankAccountType

PUT Set Country FinancialPartyBankAccount

Updates the value of attribute 'Country' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/country

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/country

PUT Set Currency FinancialPartyBankAccount

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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/currency

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/currency

PUT Set DirectDebitFileType FinancialPartyBankAccount

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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/directDebitFileType

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/directDebitFileType

PUT Set HasPreviousPayments FinancialPartyBankAccount

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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/hasPreviousPayments

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/hasPreviousPayments

PUT Set IBAN FinancialPartyBankAccount

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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/iBAN

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/iBAN

PUT Set IsActive FinancialParty

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

PUT /financialCore/financialParties/{partyKey}/isActive

PUT Set IsMandateValid FinancialPartyBankAccount

Updates the value of attribute 'IsMandateValid' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/isMandateValid

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/isMandateValid

PUT Set MandateDebitStartDate FinancialPartyBankAccount

Updates the value of attribute 'MandateDebitStartDate' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateDebitStartDate

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateDebitStartDate

PUT Set MandateLimit FinancialPartyBankAccount

Updates the value of attribute 'MandateLimit' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateLimit

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateLimit

PUT Set MandateReference FinancialPartyBankAccount

Updates the value of attribute 'MandateReference' 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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateReference

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/mandateReference

PUT Set SWIFT FinancialPartyBankAccount

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.
lineId	(string) The detail identifier.
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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/sWIFT

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/sWIFT

PUT Set Custom Attribute FinancialParty

Updates the value of 'CustomAttribute' 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.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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

PUT /financialCore/financialParties/{partyKey}/{customAttributeName}

PUT Set Custom Attribute FinancialPartyBankAccount

Updates the value of 'CustomAttribute' 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.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/{customAttributeName}

PUT /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}/{customAttributeName}

DELETE Operations

DELETE Financial Party Bank Account by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

partyKey	(string) The key for the party. Uniquely identifies the entity/party within the organization.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}

DELETE /financialCore/financialParties/{partyKey}/financialPartyBankAccounts/{lineId}

DELETE FinancialParty 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/financialParties/{id}

DELETE /financialCore/financialParties/{id}

DELETE FinancialParty 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/financialParties/{partyKey}

DELETE /financialCore/financialParties/{partyKey}

Resources

ApiBaseFinancialPartyFinancialPartyBankAccountsResource

The following elements are required:

country	(string) The country where the account's institution is based.
iBAN	(string) The financial account's International Bank Account Number.
bankAccountType	(string) The associated bank account type.
currency	(string) The same currency of party.
mandateLimit	(MoneyResource) The mandate limit establishes the maximum allowed limit for direct debit transactions. See MoneyResource .
hasPreviousPayments	(bool) The has previous payments indicate this sepa authorization has already been used (ex.: other application).
isMandateValid	(bool) The is mandate valid indicate the sepa authorization is still valid.
directDebitFileType	(enum DirectDebitFileType) Mandate Type. See DirectDebitFileType.

The following elements are optional:

accountNumber	(string) The account's number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
mandateDebitStartDate	(DateTime) The direct debit authorization date.
mandateReference	(string) The mandate reference is the sepa authorization given by the party.

ApiBaseFinancialPartyResource

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.
oneTimeParty	(bool) A flag indicating if the party has frequent transactions.
currency	(string) The party's default currency.
country	(string) The party's country.
partyAccountType	(string) The type of party for accounting purposes.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

financialPartyBankAccounts	(List of ApiBaseFinancialPartyFinancialPartyBankAccountsResource) The associated financial party bank account. See ApiBaseFinancialPartyFinancialPartyBankAccountsResource.
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.

ApiFinancialPartyFinancialPartyBankAccountsResource

The following elements are required:

country	(string) The country where the account's institution is based.
iBAN	(string) The financial account's International Bank Account Number.
bankAccountType	(string) The associated bank account type.
currency	(string) The same currency of party.
mandateLimit	(MoneyResource) The mandate limit establishes the maximum allowed limit for direct debit transactions. See MoneyResource .
hasPreviousPayments	(bool) The has previous payments indicate this sepa authorization has already been used (ex.: other application).
isMandateValid	(bool) The is mandate valid indicate the sepa authorization is still valid.
directDebitFileType	(enum DirectDebitFileType) Mandate Type. See DirectDebitFileType.

The following elements are optional:

accountNumber	(string) The account's number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
mandateDebitStartDate	(DateTime) The direct debit authorization date.
mandateReference	(string) The mandate reference is the sepa authorization given by the party.

ApiFinancialPartyResource

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:

financialPartyBankAccounts

(List of ApiFinancialPartyFinancialPartyBankAccountsResource) The associated financial party bank account.
See ApiFinancialPartyFinancialPartyBankAccountsResource.

BaseFinancialPartyFinancialPartyBankAccountsResource

The following elements are required:

country	(string) The country where the account's institution is based.
iBAN	(string) The financial account's International Bank Account Number.
bankAccountType	(string) The associated bank account type.
currency	(string) The same currency of party.
mandateLimit	(MoneyResource) The mandate limit establishes the maximum allowed limit for direct debit transactions. See MoneyResource .
hasPreviousPayments	(bool) The has previous payments indicate this sepa authorization has already been used (ex.: other application).
isMandateValid	(bool) The is mandate valid indicate the sepa authorization is still valid.
directDebitFileType	(enum DirectDebitFileType) Mandate Type. See DirectDebitFileType.

The following elements are optional:

accountNumber	(string) The account's number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
mandateDebitStartDate	(DateTime) The direct debit authorization date.
mandateReference	(string) The mandate reference is the sepa authorization given by the party.

BaseFinancialPartyResource

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.
oneTimeParty	(bool) A flag indicating if the party has frequent transactions.
currency	(string) The party's default currency.
country	(string) The party's country.
partyAccountType	(string) The type of party for accounting purposes.
isPerson	(bool) Indicates that this entity is a person.

The following elements are optional:

financialPartyBankAccounts	(List of BaseFinancialPartyFinancialPartyBankAccountsResource) The associated financial party bank account. See BaseFinancialPartyFinancialPartyBankAccountsResource.
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.

FinancialPartyBankAccountResource

The following elements are required:

country	(string) The country where the account's institution is based.
iBAN	(string) The financial account's International Bank Account Number.
bankAccountType	(string) The associated bank account type.
currency	(string) The same currency of party.
mandateLimit	(MoneyResource) The mandate limit establishes the maximum allowed limit for direct debit transactions. See MoneyResource .
hasPreviousPayments	(bool) The has previous payments indicate this sepa authorization has already been used (ex.: other application).
isMandateValid	(bool) The is mandate valid indicate the sepa authorization is still valid.
directDebitFileType	(enum DirectDebitFileType) Mandate Type. See DirectDebitFileType.

The following elements are optional:

accountNumber	(string) The account's number.
sWIFT	(string) The society for Worldwide Interbank Financial Telecommunication number.
mandateDebitStartDate	(DateTime) The direct debit authorization date.
mandateReference	(string) The mandate reference is the sepa authorization given by the party.

FinancialPartyResource

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:

financialPartyBankAccounts

(List of FinancialPartyBankAccountResource) The associated financial party bank account.
See FinancialPartyBankAccountResource.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

DirectDebitFileType

1	CORE
2	B2B