Bank Account

Interface

It allows you:

• to create new bank accounts for an existing customer

• to read the  bank accounts for an existing customer

Prerequisites:

In order to use this API Method there must be accomplished the following requirements in SocrateCloud:

• to have the customer created in SocrateCloud

Columns that can  be used as filters:

• BPartner (mandatory)

• Organization

• Active

• AccountName

• IBAN

• LastModified (UTC time format ISO 8601: yyyy-MM-dd HH:mm:ss Z, max date).Use this filter to get the newest bank account.

Mandatory Parameters when inserting bank accounts:

• BPartner Value

Actions can be done:

• list

• create

• update

• delete

API Methods:

List:

URL: https://api.socratecloud.com/webapi/rest/customer/bank_account/list/0?startRow={0}&endRow={100}&accessToken={access_token}&BPartner={bp_value}

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2007-08-22 08:30:18",

            "CreatedBy": "System",

            "Updated": "2014-02-04 14:40:58",

            "UpdatedBy": "SuperUser",

            "Active": true,

            "BankName": null,

            "IBAN": null,

            "AccountName": "Test",

            "BankAccountType": null

        }

    ],

    "totalRows": 1

}

Create:

URL: https://api.socratecloud.com/webapi/rest/customer/bank_account/create/{version}?accessToken={access_token}&BPartner={bp_value}

Method: POST

Return: bank account name for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "Active": true,

    "BankName": "New Bank",

    "IBAN": "5558874558784488",

    "AccountName": "Test",

    "BankAccountType": "Checking"

}

Update:

URL: https://api.socratecloud.com/webapi/rest/customer/bank_account/update/{version}?accessToken={access_token}&BPartner={bp_value}&AccountName={account_name}

Method: POST

Return: bank account name for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Demo SRL",

    "Active": true,

    "BankName": "New Bank",

    "IBAN": "11111111111111111",

    "AccountName": "Test",

    "BankAccountType": "Checking"

}

Delete:

URL: https://api.socratecloud.com/webapi/rest/customer/bank_account/delete/{version}?accessToken={access_token}&BPartner={bp_value}&AccountName={account_name}

Method: POST

Return: 'Deleted' for success or error message (start with "ERROR: ")