AlphaAlpha Docs
API Reference

Company Bank Accounts

Manage company bank accounts for reconciliation

Create a new company bank account

POST
/company-bank-accounts

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/company-bank-accounts" \  -H "Content-Type: application/json" \  -d '{    "accountNumber": "string",    "accountType": "CHECKING",    "autoMatchEnabled": true,    "currency": "string",    "isActive": true,    "subsidiaryId": "string"  }'
{
  "accountName": "string",
  "accountNumber": "string",
  "accountType": "CHECKING",
  "autoMatchEnabled": true,
  "bankName": "string",
  "bic": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "defaultGLAccountId": "string",
  "id": "string",
  "isActive": true,
  "lastBalanceDate": "2019-08-24T14:15:22Z",
  "lastImportDate": "2019-08-24T14:15:22Z",
  "lastKnownBalance": 0.1,
  "subsidiaryId": "string",
  "subsidiaryName": "string",
  "tenantId": "string",
  "transactionCount": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get all active bank accounts

GET
/company-bank-accounts/active

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/active"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastImportDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "subsidiaryName": "string",
    "tenantId": "string",
    "transactionCount": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get bank accounts by subsidiary

GET
/company-bank-accounts/by-subsidiary/{subsidiaryId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

subsidiaryId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/by-subsidiary/string"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastImportDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "subsidiaryName": "string",
    "tenantId": "string",
    "transactionCount": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Company Bank Account

GET
/company-bank-accounts/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of bank accounts by their IDs

DELETE
/company-bank-accounts/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/company-bank-accounts/delete-list"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Company Bank Account

GET
/company-bank-accounts/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/dynamic-search"
{
  "content": [
    {
      "accountName": "string",
      "accountNumber": "string",
      "accountType": "CHECKING",
      "active": true,
      "autoMatchEnabled": true,
      "bankName": "string",
      "bic": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "defaultGLAccountId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "lastBalanceDate": "2019-08-24T14:15:22Z",
      "lastKnownBalance": 0.1,
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Company Bank Account

POST
/company-bank-accounts/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/company-bank-accounts/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "accountName": "string",
      "accountNumber": "string",
      "accountType": "CHECKING",
      "active": true,
      "autoMatchEnabled": true,
      "bankName": "string",
      "bic": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "defaultGLAccountId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "lastBalanceDate": "2019-08-24T14:15:22Z",
      "lastKnownBalance": 0.1,
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get all company bank accounts with enriched data

GET
/company-bank-accounts/enriched

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/enriched"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastImportDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "subsidiaryName": "string",
    "tenantId": "string",
    "transactionCount": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/company-bank-accounts/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/find?ids=string"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "active": true,
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/company-bank-accounts/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/find-all"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "active": true,
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/company-bank-accounts/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/find-list"
[
  {
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "CHECKING",
    "active": true,
    "autoMatchEnabled": true,
    "bankName": "string",
    "bic": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "defaultGLAccountId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "lastBalanceDate": "2019-08-24T14:15:22Z",
    "lastKnownBalance": 0.1,
    "subsidiaryId": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/company-bank-accounts/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/find/string"
{
  "accountName": "string",
  "accountNumber": "string",
  "accountType": "CHECKING",
  "active": true,
  "autoMatchEnabled": true,
  "bankName": "string",
  "bic": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "defaultGLAccountId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isActive": true,
  "lastBalanceDate": "2019-08-24T14:15:22Z",
  "lastKnownBalance": 0.1,
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/company-bank-accounts/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/page"
{
  "content": [
    {
      "accountName": "string",
      "accountNumber": "string",
      "accountType": "CHECKING",
      "active": true,
      "autoMatchEnabled": true,
      "bankName": "string",
      "bic": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "defaultGLAccountId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "lastBalanceDate": "2019-08-24T14:15:22Z",
      "lastKnownBalance": 0.1,
      "subsidiaryId": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update a company bank account

PATCH
/company-bank-accounts/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/company-bank-accounts/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "accountName": "string",
  "accountNumber": "string",
  "accountType": "CHECKING",
  "autoMatchEnabled": true,
  "bankName": "string",
  "bic": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "defaultGLAccountId": "string",
  "id": "string",
  "isActive": true,
  "lastBalanceDate": "2019-08-24T14:15:22Z",
  "lastImportDate": "2019-08-24T14:15:22Z",
  "lastKnownBalance": 0.1,
  "subsidiaryId": "string",
  "subsidiaryName": "string",
  "tenantId": "string",
  "transactionCount": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/company-bank-accounts/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/company-bank-accounts/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/company-bank-accounts/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/company-bank-accounts/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get a company bank account with enriched data

GET
/company-bank-accounts/{id}/enriched

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/company-bank-accounts/string/enriched"
{
  "accountName": "string",
  "accountNumber": "string",
  "accountType": "CHECKING",
  "autoMatchEnabled": true,
  "bankName": "string",
  "bic": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "defaultGLAccountId": "string",
  "id": "string",
  "isActive": true,
  "lastBalanceDate": "2019-08-24T14:15:22Z",
  "lastImportDate": "2019-08-24T14:15:22Z",
  "lastKnownBalance": 0.1,
  "subsidiaryId": "string",
  "subsidiaryName": "string",
  "tenantId": "string",
  "transactionCount": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Communications

Previous Page

Concepts

Next Page