AlphaAlpha Docs
API Reference

Bank Transactions

Bank transaction import and reconciliation API

Get transactions for a specific bank account

GET
/bank-transactions/by-bank-account/{bankAccountId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

bankAccountId*string

Query Parameters

pageable*

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/bank-transactions/by-bank-account/string?page=0&size=1&sort=string"
{
  "content": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountName": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "endToEndId": "string",
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityInfo": {
        "counterpartyName": "string",
        "entityAmount": 0.1,
        "entityDate": "2019-08-24T14:15:22Z",
        "entityId": "string",
        "entityNumber": "string",
        "entityType": "AP_INVOICE"
      },
      "matchedEntityType": "AP_INVOICE",
      "note": "string",
      "reference": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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"
}

Download Csv_ Bank Transaction

GET
/bank-transactions/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/bank-transactions/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 transactions by their IDs

DELETE
/bank-transactions/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/bank-transactions/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_ Bank Transaction

GET
/bank-transactions/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/bank-transactions/dynamic-search"
{
  "content": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "duplicate": true,
      "endToEndId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityType": "AP_INVOICE",
      "mt940TransactionCode": "string",
      "note": "string",
      "reference": "string",
      "sequenceNumber": "string",
      "statementNumber": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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_ Bank Transaction

POST
/bank-transactions/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/bank-transactions/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": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "duplicate": true,
      "endToEndId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityType": "AP_INVOICE",
      "mt940TransactionCode": "string",
      "note": "string",
      "reference": "string",
      "sequenceNumber": "string",
      "statementNumber": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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"
}

Find by list of ids in current tenant

GET
/bank-transactions/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/bank-transactions/find?ids=string"
[
  {
    "absoluteAmount": 0.1,
    "amount": 0.1,
    "bankAccountId": "string",
    "bankAccountNumber": "string",
    "counterpartyAccount": "string",
    "counterpartyBIC": "string",
    "counterpartyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "description": "string",
    "duplicate": true,
    "endToEndId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "importBatchId": "string",
    "isCredit": true,
    "isDebit": true,
    "isDuplicate": true,
    "matchConfidence": 0.1,
    "matchMethod": "AUTO_REFERENCE",
    "matchedAt": "2019-08-24T14:15:22Z",
    "matchedBy": "string",
    "matchedEntityId": "string",
    "matchedEntityType": "AP_INVOICE",
    "mt940TransactionCode": "string",
    "note": "string",
    "reference": "string",
    "sequenceNumber": "string",
    "statementNumber": "string",
    "status": "UNMATCHED",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transactionDate": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "valueDate": "2019-08-24T14:15:22Z"
  }
]
{
  "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
/bank-transactions/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/bank-transactions/find-all"
[
  {
    "absoluteAmount": 0.1,
    "amount": 0.1,
    "bankAccountId": "string",
    "bankAccountNumber": "string",
    "counterpartyAccount": "string",
    "counterpartyBIC": "string",
    "counterpartyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "description": "string",
    "duplicate": true,
    "endToEndId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "importBatchId": "string",
    "isCredit": true,
    "isDebit": true,
    "isDuplicate": true,
    "matchConfidence": 0.1,
    "matchMethod": "AUTO_REFERENCE",
    "matchedAt": "2019-08-24T14:15:22Z",
    "matchedBy": "string",
    "matchedEntityId": "string",
    "matchedEntityType": "AP_INVOICE",
    "mt940TransactionCode": "string",
    "note": "string",
    "reference": "string",
    "sequenceNumber": "string",
    "statementNumber": "string",
    "status": "UNMATCHED",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transactionDate": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "valueDate": "2019-08-24T14:15:22Z"
  }
]
{
  "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
/bank-transactions/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/bank-transactions/find-list"
[
  {
    "absoluteAmount": 0.1,
    "amount": 0.1,
    "bankAccountId": "string",
    "bankAccountNumber": "string",
    "counterpartyAccount": "string",
    "counterpartyBIC": "string",
    "counterpartyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "description": "string",
    "duplicate": true,
    "endToEndId": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "importBatchId": "string",
    "isCredit": true,
    "isDebit": true,
    "isDuplicate": true,
    "matchConfidence": 0.1,
    "matchMethod": "AUTO_REFERENCE",
    "matchedAt": "2019-08-24T14:15:22Z",
    "matchedBy": "string",
    "matchedEntityId": "string",
    "matchedEntityType": "AP_INVOICE",
    "mt940TransactionCode": "string",
    "note": "string",
    "reference": "string",
    "sequenceNumber": "string",
    "statementNumber": "string",
    "status": "UNMATCHED",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transactionDate": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "valueDate": "2019-08-24T14:15:22Z"
  }
]
{
  "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
/bank-transactions/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/bank-transactions/find/string"
{
  "absoluteAmount": 0.1,
  "amount": 0.1,
  "bankAccountId": "string",
  "bankAccountNumber": "string",
  "counterpartyAccount": "string",
  "counterpartyBIC": "string",
  "counterpartyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "duplicate": true,
  "endToEndId": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "importBatchId": "string",
  "isCredit": true,
  "isDebit": true,
  "isDuplicate": true,
  "matchConfidence": 0.1,
  "matchMethod": "AUTO_REFERENCE",
  "matchedAt": "2019-08-24T14:15:22Z",
  "matchedBy": "string",
  "matchedEntityId": "string",
  "matchedEntityType": "AP_INVOICE",
  "mt940TransactionCode": "string",
  "note": "string",
  "reference": "string",
  "sequenceNumber": "string",
  "statementNumber": "string",
  "status": "UNMATCHED",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionDate": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "valueDate": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Import MT940 bank statement file

POST
/bank-transactions/import-mt940

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

bankAccountId*string
autoMatch?boolean
Defaulttrue

Request Body

multipart/form-data

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/bank-transactions/import-mt940?bankAccountId=string" \  -F file="string"
{
  "bankAccountId": "string",
  "bankAccountNumber": "string",
  "closingBalance": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "errorMessage": "string",
  "fileName": "string",
  "id": "string",
  "openingBalance": 0.1,
  "statementDate": "2019-08-24T14:15:22Z",
  "statementNumber": "string",
  "status": "PENDING",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionsDuplicate": 0,
  "transactionsImported": 0,
  "transactionsMatched": 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 MT940 imports, optionally filtered by bank account

GET
/bank-transactions/imports

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

bankAccountId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/bank-transactions/imports"
[
  {
    "bankAccountId": "string",
    "bankAccountNumber": "string",
    "closingBalance": 0.1,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "errorMessage": "string",
    "fileName": "string",
    "id": "string",
    "openingBalance": 0.1,
    "statementDate": "2019-08-24T14:15:22Z",
    "statementNumber": "string",
    "status": "PENDING",
    "subsidiaryId": "string",
    "tenantId": "string",
    "transactionsDuplicate": 0,
    "transactionsImported": 0,
    "transactionsMatched": 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"
}

Rollback an MT940 import (delete all imported transactions)

POST
/bank-transactions/imports/{importId}/rollback

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

importId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/bank-transactions/imports/string/rollback"
{
  "bankAccountId": "string",
  "bankAccountNumber": "string",
  "closingBalance": 0.1,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "errorMessage": "string",
  "fileName": "string",
  "id": "string",
  "openingBalance": 0.1,
  "statementDate": "2019-08-24T14:15:22Z",
  "statementNumber": "string",
  "status": "PENDING",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionsDuplicate": 0,
  "transactionsImported": 0,
  "transactionsMatched": 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 page by page number and size with optional sorting based on field to sortBy and direction

GET
/bank-transactions/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/bank-transactions/page"
{
  "content": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "duplicate": true,
      "endToEndId": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityType": "AP_INVOICE",
      "mt940TransactionCode": "string",
      "note": "string",
      "reference": "string",
      "sequenceNumber": "string",
      "statementNumber": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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 paginated bank transactions with enriched data

GET
/bank-transactions/page-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageable*

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/bank-transactions/page-enriched?page=0&size=1&sort=string"
{
  "content": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountName": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "endToEndId": "string",
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityInfo": {
        "counterpartyName": "string",
        "entityAmount": 0.1,
        "entityDate": "2019-08-24T14:15:22Z",
        "entityId": "string",
        "entityNumber": "string",
        "entityType": "AP_INVOICE"
      },
      "matchedEntityType": "AP_INVOICE",
      "note": "string",
      "reference": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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 bank transaction statistics

GET
/bank-transactions/stats

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

bankAccountId?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/bank-transactions/stats"
{
  "ignoredCount": 0,
  "manuallyMatchedCount": 0,
  "matchedCount": 0,
  "netAmount": 0.1,
  "totalCredits": 0.1,
  "totalDebits": 0.1,
  "totalTransactions": 0,
  "unmatchedCount": 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 unmatched bank transactions

GET
/bank-transactions/unmatched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

bankAccountId?string
pageable*

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/bank-transactions/unmatched?page=0&size=1&sort=string"
{
  "content": [
    {
      "absoluteAmount": 0.1,
      "amount": 0.1,
      "bankAccountId": "string",
      "bankAccountName": "string",
      "bankAccountNumber": "string",
      "counterpartyAccount": "string",
      "counterpartyBIC": "string",
      "counterpartyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "description": "string",
      "endToEndId": "string",
      "id": "string",
      "importBatchId": "string",
      "isCredit": true,
      "isDebit": true,
      "isDuplicate": true,
      "matchConfidence": 0.1,
      "matchMethod": "AUTO_REFERENCE",
      "matchedAt": "2019-08-24T14:15:22Z",
      "matchedBy": "string",
      "matchedEntityId": "string",
      "matchedEntityInfo": {
        "counterpartyName": "string",
        "entityAmount": 0.1,
        "entityDate": "2019-08-24T14:15:22Z",
        "entityId": "string",
        "entityNumber": "string",
        "entityType": "AP_INVOICE"
      },
      "matchedEntityType": "AP_INVOICE",
      "note": "string",
      "reference": "string",
      "status": "UNMATCHED",
      "subsidiaryId": "string",
      "tenantId": "string",
      "transactionDate": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "valueDate": "2019-08-24T14:15:22Z"
    }
  ],
  "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"
}

Delete by id in current tenant

DELETE
/bank-transactions/{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/bank-transactions/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
/bank-transactions/{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/bank-transactions/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 bank transaction with enriched data

GET
/bank-transactions/{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/bank-transactions/string/enriched"
{
  "absoluteAmount": 0.1,
  "amount": 0.1,
  "bankAccountId": "string",
  "bankAccountName": "string",
  "bankAccountNumber": "string",
  "counterpartyAccount": "string",
  "counterpartyBIC": "string",
  "counterpartyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "endToEndId": "string",
  "id": "string",
  "importBatchId": "string",
  "isCredit": true,
  "isDebit": true,
  "isDuplicate": true,
  "matchConfidence": 0.1,
  "matchMethod": "AUTO_REFERENCE",
  "matchedAt": "2019-08-24T14:15:22Z",
  "matchedBy": "string",
  "matchedEntityId": "string",
  "matchedEntityInfo": {
    "counterpartyName": "string",
    "entityAmount": 0.1,
    "entityDate": "2019-08-24T14:15:22Z",
    "entityId": "string",
    "entityNumber": "string",
    "entityType": "AP_INVOICE"
  },
  "matchedEntityType": "AP_INVOICE",
  "note": "string",
  "reference": "string",
  "status": "UNMATCHED",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionDate": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "valueDate": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Mark a bank transaction as ignored

PATCH
/bank-transactions/{id}/ignore

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

note?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/bank-transactions/string/ignore"
{
  "absoluteAmount": 0.1,
  "amount": 0.1,
  "bankAccountId": "string",
  "bankAccountName": "string",
  "bankAccountNumber": "string",
  "counterpartyAccount": "string",
  "counterpartyBIC": "string",
  "counterpartyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "endToEndId": "string",
  "id": "string",
  "importBatchId": "string",
  "isCredit": true,
  "isDebit": true,
  "isDuplicate": true,
  "matchConfidence": 0.1,
  "matchMethod": "AUTO_REFERENCE",
  "matchedAt": "2019-08-24T14:15:22Z",
  "matchedBy": "string",
  "matchedEntityId": "string",
  "matchedEntityInfo": {
    "counterpartyName": "string",
    "entityAmount": 0.1,
    "entityDate": "2019-08-24T14:15:22Z",
    "entityId": "string",
    "entityNumber": "string",
    "entityType": "AP_INVOICE"
  },
  "matchedEntityType": "AP_INVOICE",
  "note": "string",
  "reference": "string",
  "status": "UNMATCHED",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionDate": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "valueDate": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Manually match a bank transaction to an entity

POST
/bank-transactions/{id}/match

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 POST "http://localhost:18080/api/v1/bank-transactions/string/match" \  -H "Content-Type: application/json" \  -d '{    "entityId": "string",    "entityType": "AP_INVOICE"  }'
{
  "absoluteAmount": 0.1,
  "amount": 0.1,
  "bankAccountId": "string",
  "bankAccountName": "string",
  "bankAccountNumber": "string",
  "counterpartyAccount": "string",
  "counterpartyBIC": "string",
  "counterpartyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "endToEndId": "string",
  "id": "string",
  "importBatchId": "string",
  "isCredit": true,
  "isDebit": true,
  "isDuplicate": true,
  "matchConfidence": 0.1,
  "matchMethod": "AUTO_REFERENCE",
  "matchedAt": "2019-08-24T14:15:22Z",
  "matchedBy": "string",
  "matchedEntityId": "string",
  "matchedEntityInfo": {
    "counterpartyName": "string",
    "entityAmount": 0.1,
    "entityDate": "2019-08-24T14:15:22Z",
    "entityId": "string",
    "entityNumber": "string",
    "entityType": "AP_INVOICE"
  },
  "matchedEntityType": "AP_INVOICE",
  "note": "string",
  "reference": "string",
  "status": "UNMATCHED",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionDate": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "valueDate": "2019-08-24T14:15:22Z"
}
{
  "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 match suggestions for a bank transaction

GET
/bank-transactions/{id}/match-suggestions

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/bank-transactions/string/match-suggestions"
[
  {
    "confidence": 0.1,
    "counterpartyName": "string",
    "entityAmount": 0.1,
    "entityDate": "2019-08-24T14:15:22Z",
    "entityId": "string",
    "entityNumber": "string",
    "entityType": "AP_INVOICE",
    "matchReason": "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"
}

Remove match from a bank transaction

POST
/bank-transactions/{id}/unmatch

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/bank-transactions/string/unmatch"
{
  "absoluteAmount": 0.1,
  "amount": 0.1,
  "bankAccountId": "string",
  "bankAccountName": "string",
  "bankAccountNumber": "string",
  "counterpartyAccount": "string",
  "counterpartyBIC": "string",
  "counterpartyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "description": "string",
  "endToEndId": "string",
  "id": "string",
  "importBatchId": "string",
  "isCredit": true,
  "isDebit": true,
  "isDuplicate": true,
  "matchConfidence": 0.1,
  "matchMethod": "AUTO_REFERENCE",
  "matchedAt": "2019-08-24T14:15:22Z",
  "matchedBy": "string",
  "matchedEntityId": "string",
  "matchedEntityInfo": {
    "counterpartyName": "string",
    "entityAmount": 0.1,
    "entityDate": "2019-08-24T14:15:22Z",
    "entityId": "string",
    "entityNumber": "string",
    "entityType": "AP_INVOICE"
  },
  "matchedEntityType": "AP_INVOICE",
  "note": "string",
  "reference": "string",
  "status": "UNMATCHED",
  "subsidiaryId": "string",
  "tenantId": "string",
  "transactionDate": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "valueDate": "2019-08-24T14:15:22Z"
}
{
  "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"
}

Auth

Previous Page

Blob storage

Next Page