24.1 Bank Statement Master
Interface
It allows you:
to view Bank Statement (master)
to insert new Bank Statement (master)
to update Bank Statement (master) - only for Document in Draft
to delete Bank Statement (master) - only for Document in Draft
to process Bank Statement (master)
Prerequisites:
In order to use this API Method for inserting or updating data there must be accomplished the following requirements in SocrateCloud:
to have an active Organization
to have an Account at the Bank
Columns that can be used as filters:
Organization (Name)
Name (Bank Statement Name)
Description (Bank Statement Description)
BankName
BankAccount_ID
IBAN
AccountNo
StatementDate
DocStatus
Actions that can be done:
list
full list
create
full create
update - only for Document in Draft
delete - only for Document in Draft
process
Bank Statement fields (Master)
In SocrateCloud, a Bank Statement (Master) has the following structure:
API Methods:
List
URL: https://api.socratecloud.com/webapi/rest/bank/statement/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}
Method: GET
Available filter parameters:
Organization (Name)
Name (Bank Statement Name)
Description (Bank Statement Description)
BankName
BankAccount_ID
IBAN
AccountNo
StatementDate
DocStatus
Return: JSON object with next format:
{
"data": [
{
"Organization_ID": 123456,
"OrganizationValue": "Org Test",
"Organization": "Org Test",
"Created": "2023-01-25 13:10:33+0000",
"CreatedBy": "User Test",
"Updated": "2023-01-25 13:10:33+0000",
"UpdatedBy": "User Test",
"BankAccount_ID": 12345,
"IBAN": "1234567890",
"AccountNo": "1234567890",
"BankName": "BankNameTest",
"StatementDate": "2023-01-25 00:00:00+0000",
"BankStatement_ID": 1234,
"Name": "Extras nr: 00123 - test",
"Description": "00123 - test",
"IsManual": false,
"BeginningBalance": 321,
"StatementDifference": 0,
"EndingBalance": 321,
"DocStatus": "DR",
"lines": []
}
],
"totalRows": 1
}
Full List
URL: https://api.socratecloud.com/webapi/rest/bank/statement/full/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}
Method: GET
Available filter parameters:
Organization (Name)
Name (Bank Statement Name)
Description (Bank Statement Description)
BankName
BankAccount_ID
IBAN
AccountNo
StatementDate
DocStatus
Return: JSON object with next format:
{
"data": [
{
"Organization_ID": 123456,
"OrganizationValue": "Org Test",
"Organization": "Org Test",
"Created": "2023-01-25 13:10:33+0000",
"CreatedBy": "User Test",
"Updated": "2023-01-25 13:10:33+0000",
"UpdatedBy": "User Test",
"BankAccount_ID": 12345,
"IBAN": "1234567890",
"AccountNo": "1234567890",
"BankName": "BankNameTest",
"StatementDate": "2023-01-25 00:00:00+0000",
"BankStatement_ID": 1234,
"Name": "Extras nr: 00123 - test",
"Description": "00123 - test",
"IsManual": false,
"BeginningBalance": 321,
"StatementDifference": 0,
"EndingBalance": 321,
"DocStatus": "DR",
"lines": [
{
"Organization_ID":123456,
"OrganizationValue":"Org Test",
"Organization":"Org Test",
"Created":"2023-02-05 00:00:00+0000",
"CreatedBy_ID":1234,
"CreatedBy":"User Test",
"Updated":"2023-02-05 00:00:00+0000",
"UpdatedBy_ID":1234,
"UpdatedBy":"User Test",
"Line":10,
"Description":"Test Description",
"StatementLineDate":"2023-02-05 00:00:00+0000",
"DateAcct":"2023-02-05 00:00:00+0000",
"ValutaDate":"2023-02-05 00:00:00+0000",
"StmtAmt":12,
"TrxAmt":10,
"InterestAmt":-2,
"BPartner_ID":54321,
"BPartnerValue":"Tert Test",
"BPartnerName":"Tert Test",
"Currency_ID":123,
"ConversionType_ID":321,
"ConversionTypeValue":"S",
"ConversionTypeName":"Spot",
"Invoice_ID":1234,
"InvoiceNo":"Test Invoice",
"Order_ID":12345,
"OrderNo":"Test Order",
"Payment_ID":6543,
"PaymentNo":"6543",
"ChargeAmt":4,
"Charge_ID":65432,
"ChargeName":"Avans",
"SAFT_TaxType_ID":12345,
"SAFT_TaxType_Value":"Test TaxType",
"SAFT_TaxType_Name":"Test TaxType",
"SAFT_Tax_ID":2345,
"SAFT_Tax_Value":"Test Tax",
"SAFT_Tax_Name":"Test Tax",
"SAFT_TaxPercentage":15,
"SAFT_TaxBaseAmt":5,
"TrxOrganization_ID":654321,
"TrxOrganizationValue":"Test Organization",
"TrxOrganization":"Test Organization",
"Project_ID":34567,
"ProjectValue":"Test Project",
"ProjectName":"Test Project",
"ProjectPhase_ID":4567,
"ProjectPhase":"Test Phase",
"Activity_ID":5432,
"ActivityValue":"Test Activity",
"Activity":"Test Activity",
"Campaign_ID":98765,
"CampaignValue":"Test Campaign",
"CampaignName":"Test Campaign",
"Asset_ID":87654,
"AssetValue":"Test Asset",
"Asset":"Test Asset"
}
]
}
],
"totalRows": 1
}
Create
URL: https://api.socratecloud.com/webapi/rest/bank/statement/create/{version}?accessToken={access_token}
Method: POST
In the content are mandatory:
Organization_ID or OrganizationValue or Organization
BankAccount_ID or IBAN or AccountNo
Return an object with "data" and "id" for success or error message (starts with "Error:"). Where "data" is Name of Bank Statement and "id" is Id of Bank Statement.
Example for success message:
{
"data": "Extras nr: 00123 - test",
"id": 12345
}
Example for error message:
{
"errorMessage": "The field is mandatory: AccountNo",
"isError": true,
"errorCode": 0
}
Data format:
{
"Organization_ID": 123456,
"OrganizationValue": "Org Test",
"Organization": "Org Test",
"BankAccount_ID": 12345,
"IBAN": "1234567890",
"AccountNo": "1234567890",
"BankName": "BankNameTest",
"StatementDate": "2023-01-25 00:00:00+0000",
"BankStatement_ID": 1234,
"Name": "Extras nr: 00123 - test",
"Description": "00123 - test",
"BeginningBalance": 321
}
Full Create
URL: https://api.socratecloud.com/webapi/rest/bank/statement/full/create/{version}?accessToken={access_token}
Method: POST
In the content are mandatory:
Organization_ID or OrganizationValue or Organization
BankAccount_ID or IBAN or AccountNo
Return an object with "data" and "id" for success or error message (starts with "Error:"). Where "data" is Name of Bank Statement and "id" is Id of Bank Statement.
Example for success message:
{
"data": "Extras nr: 00123 - test",
"id": 12345
}
Example for error message:
{
"errorMessage": "The field is mandatory: Organization",
"isError": true,
"errorCode": 0
}
Data format:
{
"Organization_ID": 123456,
"OrganizationValue": "Org Test",
"Organization": "Org Test",
"BankAccount_ID": 12345,
"IBAN": "1234567890",
"AccountNo": "1234567890",
"BankName": "BankNameTest",
"StatementDate": "2023-01-25 00:00:00+0000",
"BankStatement_ID": 1234,
"Name": "Extras nr: 00123 - test",
"Description": "00123 - test",
"BeginningBalance": 321,
"lines": [
{
"Organization_ID":123456,
"OrganizationValue":"Org Test",
"Organization":"Org Test",
"Description":"Test Description",
"StatementLineDate":"2023-02-05 00:00:00+0000",
"DateAcct":"2023-02-05 00:00:00+0000",
"ValutaDate":"2023-02-05 00:00:00+0000",
"StmtAmt":12,
"TrxAmt":10,
"InterestAmt":-2,
"BPartner_ID":54321,
"BPartnerValue":"Tert Test",
"BPartnerName":"Tert Test",
"Currency_ID":123,
"ConversionType_ID":321,
"ConversionTypeValue":"S",
"ConversionTypeName":"Spot",
"Invoice_ID":1234,
"InvoiceNo":"Test Invoice",
"Order_ID":12345,
"OrderNo":"Test Order",
"Payment_ID":6543,
"PaymentNo":"6543",
"ChargeAmt":4,
"Charge_ID":65432,
"ChargeName":"Avans",
"SAFT_TaxType_ID":12345,
"SAFT_TaxType_Value":"Test TaxType",
"SAFT_TaxType_Name":"Test TaxType",
"SAFT_Tax_ID":2345,
"SAFT_Tax_Value":"Test Tax",
"SAFT_Tax_Name":"Test Tax",
"SAFT_TaxPercentage":15,
"SAFT_TaxBaseAmt":5,
"TrxOrganization_ID":654321,
"TrxOrganizationValue":"Test Organization",
"TrxOrganization":"Test Organization",
"Project_ID":34567,
"ProjectValue":"Test Project",
"ProjectName":"Test Project",
"ProjectPhase_ID":4567,
"ProjectPhase":"Test Phase",
"Activity_ID":5432,
"ActivityValue":"Test Activity",
"Activity":"Test Activity",
"Campaign_ID":98765,
"CampaignValue":"Test Campaign",
"CampaignName":"Test Campaign",
"Asset_ID":87654,
"AssetValue":"Test Asset",
"Asset":"Test Asset"
}
]
}
Update
URL: https://api.socratecloud.com/webapi/rest/bank/statement/update/{version}?accessToken={access_token}
Method: POST
The Parameters are mandatory:
BankStatement_ID or: 'Bank Account' (BankAccount_ID or IBAN or AccountNo) and StatementDate and Name
In the content are mandatory:
Organization_ID or OrganizationValue or Organization
BankAccount_ID or IBAN or AccountNo
StatementDate
Name
Return an object with "data" and "id" for success or error message (starts with "Error:"). Where "data" is Name of Bank Statement and "id" is Id of Bank Statement.
Data format:
{
"Organization_ID": 123456,
"OrganizationValue": "Org Test",
"Organization": "Org Test",
"BankAccount_ID": 12345,
"IBAN": "1234567890",
"AccountNo": "1234567890",
"BankName": "BankNameTest",
"StatementDate": "2023-01-25 00:00:00+0000",
"BankStatement_ID": 1234,
"Name": "Extras nr: 00123 - test",
"Description": "00123 - test",
"BeginningBalance": 321
}
Delete
URL: https://api.socratecloud.com/webapi/rest/bank/statement/delete/{version}?accessToken={access_token}
Method: POST
The Parameters are mandatory:
BankStatement_ID or: 'Bank Account' (BankAccount_ID or IBAN or AccountNo) and StatementDate and Name
Return: "Deleted" for success or error message (starts with "Error: ").
Process
URL: https://api.socratecloud.com/webapi/rest/bank/statement/process/{version}?accessToken={access_token}
Method: POST
The Parameters are mandatory:
BankStatement_ID or: 'Bank Account' (BankAccount_ID or IBAN or AccountNo) and StatementDate and Name
DocumentAction
The Parameter VoidReason is optional.
Return: Document Status for success or error message (starts with "Error: ").