NAV Navbar

Finance API v1.0

Scroll down for example requests and responses.

finance-api-controller

Finance Api Controller

findAccountStatementsUsingGET

Code samples

GET /api/v1/accounts/statements

findAccountStatements

Get month end general ledger account statement

Example responses

200 Response

{
  "data": [
    {
      "month": 1,
      "accountName": "accountName",
      "year": 5,
      "creditAmt": 0.8008281904610115,
      "accountNumber": "accountNumber",
      "currencyCode": "currencyCode",
      "debitAmt": 6.027456183070403
    },
    {
      "month": 1,
      "accountName": "accountName",
      "year": 5,
      "creditAmt": 0.8008281904610115,
      "accountNumber": "accountNumber",
      "currencyCode": "currencyCode",
      "debitAmt": 6.027456183070403
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_FinanceAccountStatementJson_

searchEntriesUsingGET

Code samples

GET /api/v1/entries

searchEntries

Search accounting entries

Parameters

Parameter In Type Required Description
entryDateFrom query string(date) false Starting date for search
entryDateTo query string(date) false End date for search
accountTypeCodes[] query array[string] false Defined general ledger account types. For example interest receivable, interest income, loro, loans etc
accountIds[] query array[integer] false Account unique identifiers
directionCodes[] query array[string] false D, C
amountFrom query number false Min amount of entry
amountTo query number false Max amount of entry

Example responses

200 Response

{
  "data": [
    {
      "accountId": 0,
      "eventId": 5,
      "amount": 6.027456183070403,
      "accountName": "accountName",
      "entryDate": "2000-01-23",
      "details": "details",
      "entryNumber": 5,
      "currencyCode": "currencyCode",
      "directionCode": "directionCode",
      "entryId": 1
    },
    {
      "accountId": 0,
      "eventId": 5,
      "amount": 6.027456183070403,
      "accountName": "accountName",
      "entryDate": "2000-01-23",
      "details": "details",
      "entryNumber": 5,
      "currencyCode": "currencyCode",
      "directionCode": "directionCode",
      "entryId": 1
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_FinanceEntryJson_

Schemas

FinanceAccountStatementJson

{
  "month": 1,
  "accountName": "accountName",
  "year": 5,
  "creditAmt": 0.8008281904610115,
  "accountNumber": "accountNumber",
  "currencyCode": "currencyCode",
  "debitAmt": 6.027456183070403
}

Properties

Name Type Required Restrictions Description
accountName string false none General ledger account name
accountNumber string false none General ledger account number
creditAmt number false none Total credit amount per month.
currencyCode string false none Currency - EUR, USD, GDP etc
debitAmt number false none Total credit amount per month.
month integer(int32) false none Month
year integer(int32) false none Year

FinanceEntryJson

{
  "accountId": 0,
  "eventId": 5,
  "amount": 6.027456183070403,
  "accountName": "accountName",
  "entryDate": "2000-01-23",
  "details": "details",
  "entryNumber": 5,
  "currencyCode": "currencyCode",
  "directionCode": "directionCode",
  "entryId": 1
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none General ledger account unique identifier
accountName string false none General ledger account name
amount number false none Amount of entry
currencyCode string false none Currency - EUR, USD, GDP etc
details string false none Description of entry
directionCode string false none D, C
entryDate string(date) false none Date of entry
entryId integer(int64) false none Unique entry identifier
entryNumber integer(int64) false none Unique entry identifier
eventId integer(int64) false none Reference to underlying business event causing the entry

ResponseJson_List_FinanceAccountStatementJson_

{
  "data": [
    {
      "month": 1,
      "accountName": "accountName",
      "year": 5,
      "creditAmt": 0.8008281904610115,
      "accountNumber": "accountNumber",
      "currencyCode": "currencyCode",
      "debitAmt": 6.027456183070403
    },
    {
      "month": 1,
      "accountName": "accountName",
      "year": 5,
      "creditAmt": 0.8008281904610115,
      "accountNumber": "accountNumber",
      "currencyCode": "currencyCode",
      "debitAmt": 6.027456183070403
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [FinanceAccountStatementJson] false none none
errors [string] false none none

ResponseListJson_List_FinanceEntryJson_

{
  "data": [
    {
      "accountId": 0,
      "eventId": 5,
      "amount": 6.027456183070403,
      "accountName": "accountName",
      "entryDate": "2000-01-23",
      "details": "details",
      "entryNumber": 5,
      "currencyCode": "currencyCode",
      "directionCode": "directionCode",
      "entryId": 1
    },
    {
      "accountId": 0,
      "eventId": 5,
      "amount": 6.027456183070403,
      "accountName": "accountName",
      "entryDate": "2000-01-23",
      "details": "details",
      "entryNumber": 5,
      "currencyCode": "currencyCode",
      "directionCode": "directionCode",
      "entryId": 1
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [FinanceEntryJson] false none none
errors [string] false none none