Transactions

Listing transactions

A GET request will list all of the transactions.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/ACNT1/transactions?organization_id=987654321&page=0&size=20&analysis_date=2020-01-30&status=ACTUAL&include_children=false&view=PARTY' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_code}/transactions
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

organization_id

Organization ID

page

Requested page number. Optional. Defaults to 0

size

Requested page size. Optional. Defaults to 20

analysis_date

Analysis date (yyyy-mm-dd). Optional. Defaults to today

status

Status, possible values: DRAFT, SIMULATED or ACTUAL. Optional. Defaults to ACTUAL

include_children

Should include or not transaction’s childrens. Optional. Defaults to false

view

View Side, possible values: COUNTERPARTY or PARTY. Optional. Defaults to PARTY.

HTTP request

GET /api/debt/v4/ACNT1/transactions?organization_id=987654321&page=0&size=20&analysis_date=2020-01-30&status=ACTUAL&include_children=false&view=PARTY HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 5997

{
  "_embedded" : {
    "transactions" : [ {
      "object_id" : "123456789",
      "status" : "ACTUAL",
      "reference" : "TX123",
      "external_reference" : "EXT123",
      "type" : "STANDARD_LOAN",
      "trade_date" : "2001-01-01",
      "initial_principal" : {
        "kind" : "Amount",
        "value" : 1000000.0,
        "currency" : "EUR"
      },
      "currency" : "EUR",
      "party" : {
        "code" : "PAR123",
        "label" : "Par 123"
      },
      "counterparty" : {
        "code" : "SYNDICATED",
        "label" : "SYNDICATED"
      },
      "guarantor" : null,
      "interest_rounding_rule" : {
        "value" : "ROUND_UP",
        "label" : null
      },
      "principal_rounding_rule" : {
        "value" : "ROUND_DOWN",
        "label" : null
      },
      "amortization_type" : {
        "value" : "BULLET",
        "label" : null
      },
      "start_date" : "2001-02-01",
      "initial_maturity_date" : "2011-02-01",
      "maturity_date" : "2011-02-02",
      "first_roll_date" : "2020-03-31",
      "calendars" : [ {
        "value" : "CAL1",
        "label" : null
      } ],
      "pool_members" : [ {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      }, {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      } ],
      "custom_properties" : [ ],
      "indexing_type" : "FIXED",
      "spread" : 0.0,
      "outstanding_balance" : {
        "kind" : "Amount",
        "value" : 0.0,
        "currency" : "EUR"
      },
      "_links" : {
        "phases" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/transactions/123456789/phases?organization_id=987654321"
        },
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v4/234567891/transactions/123456789?organization_id=987654321"
        }
      }
    }, {
      "object_id" : "123456789",
      "status" : "ACTUAL",
      "reference" : "TX123",
      "external_reference" : "EXT123",
      "type" : "STANDARD_LOAN",
      "trade_date" : "2001-01-01",
      "initial_principal" : {
        "kind" : "Amount",
        "value" : 1000000.0,
        "currency" : "EUR"
      },
      "currency" : "EUR",
      "party" : {
        "code" : "PAR123",
        "label" : "Par 123"
      },
      "counterparty" : {
        "code" : "SYNDICATED",
        "label" : "SYNDICATED"
      },
      "guarantor" : null,
      "interest_rounding_rule" : {
        "value" : "ROUND_UP",
        "label" : null
      },
      "principal_rounding_rule" : {
        "value" : "ROUND_DOWN",
        "label" : null
      },
      "amortization_type" : {
        "value" : "BULLET",
        "label" : null
      },
      "start_date" : "2001-02-01",
      "initial_maturity_date" : "2011-02-01",
      "maturity_date" : "2011-02-02",
      "first_roll_date" : "2020-03-31",
      "calendars" : [ {
        "value" : "CAL1",
        "label" : null
      } ],
      "pool_members" : [ {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      }, {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      } ],
      "custom_properties" : [ ],
      "indexing_type" : "FIXED",
      "spread" : 0.0,
      "outstanding_balance" : {
        "kind" : "Amount",
        "value" : 0.0,
        "currency" : "EUR"
      },
      "_links" : {
        "phases" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/transactions/123456789/phases?organization_id=987654321"
        },
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v4/234567891/transactions/123456789?organization_id=987654321"
        }
      }
    }, {
      "object_id" : "123456789",
      "status" : "ACTUAL",
      "reference" : "TX123",
      "external_reference" : "EXT123",
      "type" : "STANDARD_LOAN",
      "trade_date" : "2001-01-01",
      "initial_principal" : {
        "kind" : "Amount",
        "value" : 1000000.0,
        "currency" : "EUR"
      },
      "currency" : "EUR",
      "party" : {
        "code" : "PAR123",
        "label" : "Par 123"
      },
      "counterparty" : {
        "code" : "SYNDICATED",
        "label" : "SYNDICATED"
      },
      "guarantor" : null,
      "interest_rounding_rule" : {
        "value" : "ROUND_UP",
        "label" : null
      },
      "principal_rounding_rule" : {
        "value" : "ROUND_DOWN",
        "label" : null
      },
      "amortization_type" : {
        "value" : "BULLET",
        "label" : null
      },
      "start_date" : "2001-02-01",
      "initial_maturity_date" : "2011-02-01",
      "maturity_date" : "2011-02-02",
      "first_roll_date" : "2020-03-31",
      "calendars" : [ {
        "value" : "CAL1",
        "label" : null
      } ],
      "pool_members" : [ {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      }, {
        "code" : "TP1",
        "name" : "Third party 1",
        "percentage" : 50.0,
        "role" : "NONE"
      } ],
      "custom_properties" : [ ],
      "indexing_type" : "FIXED",
      "spread" : 0.0,
      "outstanding_balance" : {
        "kind" : "Amount",
        "value" : 0.0,
        "currency" : "EUR"
      },
      "_links" : {
        "phases" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/transactions/123456789/phases?organization_id=987654321"
        },
        "self" : {
          "href" : "https://apigw.financeactive.eu/api/debt/v4/234567891/transactions/123456789?organization_id=987654321"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v4/ACNT1/transactions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "total_elements" : 3,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.transactions[].object_id

String

Transaction technical ID

_embedded.transactions[].status

String

Lifecycle status of this transaction, in the following: DRAFT, SIMULATED, ACTUAL

_embedded.transactions[].reference

String

Transaction reference name

_embedded.transactions[].external_reference

String

Transaction external reference (from an external system)

_embedded.transactions[].type

String

Transaction type, in the following: STANDARD_LOAN, SUBSIDY_LOAN, CONSTRUCTION_LOAN, ONGOING_LOAN, SWAP, EXTENDABLE_IRS, CALLABLE_IRS, SWAP_LEG, CAP, FLOOR, COLLAR, SCHULDSCHEIN, MEDIUM_TERM_NOTES, CERTIFICATE_OF_DEPOSIT, EUROPEAN_MEDIUM_TERM_NOTES, EUROPEAN_COMMERCIAL_PAPER, EUROPEAN_COMMERCIAL_PAPER_LONG_TERM, INFLATION_LINKED_BOND, US_PRIVATE_PLACEMENT, EU_PRIVATE_PLACEMENT, STERLING_BOND, OBLIGATION_ASSIMILABLE_DU_TRESOR, BON_DU_TRESOR, ISSUING_PROGRAMME_SCHULDSCHEIN, ISSUING_PROGRAMME_MEDIUM_TERM_NOTES, ISSUING_PROGRAMME_CERTIFICATE_OF_DEPOSIT, ISSUING_PROGRAMME_EUROPEAN_MEDIUM_TERM_NOTES, ISSUING_PROGRAMME_EUROPEAN_COMMERCIAL_PAPER, ISSUING_PROGRAMME_EUROPEAN_COMMERCIAL_PAPER_LONG_TERM, ISSUING_PROGRAMME_INFLATION_LINKED_BOND, ISSUING_PROGRAMME_US_PRIVATE_PLACEMENT, ISSUING_PROGRAMME_EU_PRIVATE_PLACEMENT, ISSUING_PROGRAMME_STERLING_BOND, ISSUING_PROGRAMME_OBLIGATION_ASSIMILABLE_DU_TRESOR, ISSUING_PROGRAMME_BON_DU_TRESOR, OVER_THE_COUNTER_CERTIFICATE_PROGRAMME, OVER_THE_COUNTER_CERTIFICATE, REGULAR_CASH_FACILITY, CREDIT_FACILITY, CREDIT_FACILITY_DRAWING, FACILITY_AGREEMENT, UNMANAGED_LOAN, CROSS_CURRENCY_SWAP, PAYMENT_IN_KIND_LOAN, SWAPTION, GUARANTEE, FX_SWAP, FINANCING_LEASE, SIMPLE_LEASE, DOWN_PAYMENT, FINANCING_LEASE_DOWN_PAYMENT, CDC_LOAN, COLLATERAL

_embedded.transactions[].trade_date

String

ISO-8601 date indicating when the transaction initial contract was established

_embedded.transactions[].initial_principal

Object

Initial principal amount, for applicable transaction

_embedded.transactions[].currency

String

ISO-4217 transaction main currency code

_embedded.transactions[].party

Object

Party for this transaction

_embedded.transactions[].counterparty

Object

Counterparty for applicable over-the-counter transactions

_embedded.transactions[].guarantor

Null

Guarantor

_embedded.transactions[].interest_rounding_rule

Object

The rounding rule for interest

_embedded.transactions[].principal_rounding_rule

Object

The rounding rule for principal

_embedded.transactions[].amortization_type

Object

The type of amortization

_embedded.transactions[].start_date

String

ISO-8601 date indicating when the initial cash flow starts

_embedded.transactions[].initial_maturity_date

String

Date indicating when the maturity of the transaction should happen initially

_embedded.transactions[].maturity_date

String

ISO-8601 date indicating when the maturity of the transaction

_embedded.transactions[].first_roll_date

String

The first roll date

_embedded.transactions[].calendars

Array

Calendars

_embedded.transactions[].drawing_default_values

class java.lang.Object

Drawing default values for credit facility

_embedded.transactions[].drawing_default_values.frequency

class com.financeactive.apollo.api.dto.ValueLabelView

Frequency

_embedded.transactions[].drawing_defaultValues.frequency.key

class java.lang.String

Key code of the frequency

_embedded.transactions[].drawing_default_values.frequency.value

class com.financeactive.apollo.api.dto.ValueLabelView

Value label of the frequency

_embedded.transactions[].drawing_default_values.interestRate

class com.financeactive.apollo.api.dto.ValueLabelView

Interest rate

_embedded.transactions[].drawing_default_values.frequency

class java.lang.Double

Frequency

_embedded.transactions[].drawing_default_values.index

class java.lang.String

Index

_embedded.transactions[].drawing_default_values.spread

class java.lang.Double

Spread

_embedded.transactions[].drawing_default_values.initial_interest_rate

class java.lang.Double

Initial interest rate

_embedded.transactions[].drawing_default_values.day_count_convention

class com.financeactive.apollo.api.dto.ValueLabelView

Day count convention

_embedded.transactions[].drawing_default_values.interest_calculation_adjustment

class com.financeactive.apollo.api.dto.ValueLabelView

Interest calculation adjustment

_embedded.transactions[].drawing_default_values.payment_date_adjustment

class com.financeactive.apollo.api.dto.ValueLabelView

Payment date adjustment

_embedded.transactions[].drawing_default_values.amortization_type

class com.financeactive.apollo.api.dto.ValueLabelView

Amortization type

_embedded.transactions[].drawing_default_values.interest_rounding_rule

class com.financeactive.apollo.api.dto.ValueLabelView

Interest rounding rule

_embedded.transactions[].drawing_default_values.principal_rounding_rule

class com.financeactive.apollo.api.dto.ValueLabelView

Principal rounding rule

_embedded.transactions[].pool_members[]

Array

List of pool members

_embedded.transactions[].pool_members[].code

String

Pool member code

_embedded.transactions[].pool_members[].name

String

Pool member name

_embedded.transactions[].pool_members[].percentage

Number

Pool member percentage

_embedded.transactions[].pool_members[].role

String

Pool member role

_embedded.transactions[].custom_properties[]

Array

List of custom properties

_embedded.transactions[].custom_properties[].key

class java.lang.String

Code name of the custom property

_embedded.transactions[].custom_properties[].name

class java.lang.String

Name of the custom property

_embedded.transactions[].custom_properties[].value

class java.lang.String

Value of the custom property

_embedded.transactions[].indexing_type

String

Transaction actual indexing type, in the following: FIXED, FLOATING, STRUCTURED

_embedded.transactions[].spread

Number

Actual Spread, for applicable transactions. Expressed as a floating value between 0 and 1

_embedded.transactions[].outstanding_balance

Object

Amount for the Outstanding Balance indicator, for applicable transactions

_embedded.transactions[]._links

Object

Links to resources linked to this transaction

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Relation Description

self

Link to this transaction list

Retrieving a transaction

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/ACNT1/transactions/123456789?organization_id=987654321' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_code}/transactions/{transaction_id}
Parameter Description

account_code

Account code or ID

transaction_id

Transaction ID

Request parameters

Parameter Description

organization_id

Organization ID

HTTP request

GET /api/debt/v4/ACNT1/transactions/123456789?organization_id=987654321 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1626

{
  "object_id" : "123456789",
  "status" : "ACTUAL",
  "reference" : "TX123",
  "external_reference" : "EXT123",
  "type" : "STANDARD_LOAN",
  "trade_date" : "2001-01-01",
  "initial_principal" : {
    "kind" : "Amount",
    "value" : 1000000.0,
    "currency" : "EUR"
  },
  "currency" : "EUR",
  "party" : {
    "code" : "PAR123",
    "label" : "Par 123"
  },
  "counterparty" : {
    "code" : "SYNDICATED",
    "label" : "SYNDICATED"
  },
  "guarantor" : null,
  "interest_rounding_rule" : {
    "value" : "ROUND_UP",
    "label" : null
  },
  "principal_rounding_rule" : {
    "value" : "ROUND_DOWN",
    "label" : null
  },
  "amortization_type" : {
    "value" : "BULLET",
    "label" : null
  },
  "start_date" : "2001-02-01",
  "initial_maturity_date" : "2011-02-01",
  "maturity_date" : "2011-02-02",
  "first_roll_date" : "2020-03-31",
  "calendars" : [ {
    "value" : "CAL1",
    "label" : null
  } ],
  "pool_members" : [ {
    "code" : "TP1",
    "name" : "Third party 1",
    "percentage" : 50.0,
    "role" : "NONE"
  }, {
    "code" : "TP1",
    "name" : "Third party 1",
    "percentage" : 50.0,
    "role" : "NONE"
  } ],
  "custom_properties" : [ ],
  "indexing_type" : "FIXED",
  "spread" : 0.0,
  "outstanding_balance" : {
    "kind" : "Amount",
    "value" : 0.0,
    "currency" : "EUR"
  },
  "_links" : {
    "phases" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/transactions/123456789/phases?organization_id=987654321"
    },
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v4/234567891/transactions/123456789?organization_id=987654321"
    }
  }
}

Response fields

Path Type Description

object_id

String

Transaction technical ID

status

String

Lifecycle status of this transaction, in the following: DRAFT, SIMULATED, ACTUAL

reference

String

Transaction reference name

external_reference

String

Transaction external reference (from an external system)

type

String

Transaction type, in the following: STANDARD_LOAN, SUBSIDY_LOAN, CONSTRUCTION_LOAN, ONGOING_LOAN, SWAP, EXTENDABLE_IRS, CALLABLE_IRS, SWAP_LEG, CAP, FLOOR, COLLAR, SCHULDSCHEIN, MEDIUM_TERM_NOTES, CERTIFICATE_OF_DEPOSIT, EUROPEAN_MEDIUM_TERM_NOTES, EUROPEAN_COMMERCIAL_PAPER, EUROPEAN_COMMERCIAL_PAPER_LONG_TERM, INFLATION_LINKED_BOND, US_PRIVATE_PLACEMENT, EU_PRIVATE_PLACEMENT, STERLING_BOND, OBLIGATION_ASSIMILABLE_DU_TRESOR, BON_DU_TRESOR, ISSUING_PROGRAMME_SCHULDSCHEIN, ISSUING_PROGRAMME_MEDIUM_TERM_NOTES, ISSUING_PROGRAMME_CERTIFICATE_OF_DEPOSIT, ISSUING_PROGRAMME_EUROPEAN_MEDIUM_TERM_NOTES, ISSUING_PROGRAMME_EUROPEAN_COMMERCIAL_PAPER, ISSUING_PROGRAMME_EUROPEAN_COMMERCIAL_PAPER_LONG_TERM, ISSUING_PROGRAMME_INFLATION_LINKED_BOND, ISSUING_PROGRAMME_US_PRIVATE_PLACEMENT, ISSUING_PROGRAMME_EU_PRIVATE_PLACEMENT, ISSUING_PROGRAMME_STERLING_BOND, ISSUING_PROGRAMME_OBLIGATION_ASSIMILABLE_DU_TRESOR, ISSUING_PROGRAMME_BON_DU_TRESOR, OVER_THE_COUNTER_CERTIFICATE_PROGRAMME, OVER_THE_COUNTER_CERTIFICATE, REGULAR_CASH_FACILITY, CREDIT_FACILITY, CREDIT_FACILITY_DRAWING, FACILITY_AGREEMENT, UNMANAGED_LOAN, CROSS_CURRENCY_SWAP, PAYMENT_IN_KIND_LOAN, SWAPTION, GUARANTEE, FX_SWAP, FINANCING_LEASE, SIMPLE_LEASE, DOWN_PAYMENT, FINANCING_LEASE_DOWN_PAYMENT, CDC_LOAN, COLLATERAL

trade_date

String

ISO-8601 date indicating when the transaction initial contract was established

initial_principal

Object

Initial principal amount, for applicable transaction

currency

String

ISO-4217 transaction main currency code

party

Object

Party for this transaction

counterparty

Object

Counterparty for applicable over-the-counter transactions

guarantor

Null

Guarantor

interest_rounding_rule

Object

The rounding rule for interest

principal_rounding_rule

Object

The rounding rule for principal

amortization_type

Object

The type of amortization

start_date

String

ISO-8601 date indicating when the initial cash flow starts

initial_maturity_date

String

Date indicating when the maturity of the transaction should happen initially

maturity_date

String

ISO-8601 date indicating when the maturity of the transaction

first_roll_date

String

The first roll date

calendars

Array

Calendars

drawing_default_values

class java.lang.Object

Drawing default values for credit facility

drawing_default_values.frequency

class com.financeactive.apollo.api.dto.ValueLabelView

Frequency

drawing_defaultValues.frequency.key

class java.lang.String

Key code of the frequency

drawing_default_values.frequency.value

class com.financeactive.apollo.api.dto.ValueLabelView

Value label of the frequency

drawing_default_values.interestRate

class com.financeactive.apollo.api.dto.ValueLabelView

Interest rate

drawing_default_values.frequency

class java.lang.Double

Frequency

drawing_default_values.index

class java.lang.String

Index

drawing_default_values.spread

class java.lang.Double

Spread

drawing_default_values.initial_interest_rate

class java.lang.Double

Initial interest rate

drawing_default_values.day_count_convention

class com.financeactive.apollo.api.dto.ValueLabelView

Day count convention

drawing_default_values.interest_calculation_adjustment

class com.financeactive.apollo.api.dto.ValueLabelView

Interest calculation adjustment

drawing_default_values.payment_date_adjustment

class com.financeactive.apollo.api.dto.ValueLabelView

Payment date adjustment

drawing_default_values.amortization_type

class com.financeactive.apollo.api.dto.ValueLabelView

Amortization type

drawing_default_values.interest_rounding_rule

class com.financeactive.apollo.api.dto.ValueLabelView

Interest rounding rule

drawing_default_values.principal_rounding_rule

class com.financeactive.apollo.api.dto.ValueLabelView

Principal rounding rule

pool_members[]

Array

List of pool members

pool_members[].code

String

Pool member code

pool_members[].name

String

Pool member name

pool_members[].percentage

Number

Pool member percentage

pool_members[].role

String

Pool member role

custom_properties[]

Array

List of custom properties

custom_properties[].key

class java.lang.String

Code name of the custom property

custom_properties[].name

class java.lang.String

Name of the custom property

custom_properties[].value

class java.lang.String

Value of the custom property

indexing_type

String

Transaction actual indexing type, in the following: FIXED, FLOATING, STRUCTURED

spread

Number

Actual Spread, for applicable transactions. Expressed as a floating value between 0 and 1

outstanding_balance

Object

Amount for the Outstanding Balance indicator, for applicable transactions

_links

Object

Links to resources linked to this transaction

Relation Description

phases

Link to transaction’s phases

self

Link to this transaction list

Cash Flows

Those APIs are used to send all cash flows from a single financial product or a group of financial product. Set up account_id and transaction_id to get the following data:

date: "1999-01-01"/ amount: "-10000.0" / currency: "USD" / type: "PRINCIPAL".

Listing cash flows on a transaction

This is the BETA version. Official version will be released before the end of Q2.

A GET request will list all of the cash flows for a given transaction.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/ACNT1/transactions/123456789/cash-flows?organization_id=987654321&analysis_date=2001-01-01&renewals_until=2019-01-01&view=COUNTERPARTY' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_code}/transactions/{transaction_id}/cash-flows
Parameter Description

account_code

Account code or ID

transaction_id

Transaction ID

Request parameters

Parameter Description

organization_id

Organization ID

analysis_date

Analysis date in ISO-8601 format. Optional. Defaults to current date

renewals_until

the deal will be renewed until this date. Optional.

view

It takes COUNTERPARTY or PARTY as value. if the parameter is not set, the view by default is set to PARTY.

HTTP request

GET /api/debt/v4/ACNT1/transactions/123456789/cash-flows?organization_id=987654321&analysis_date=2001-01-01&renewals_until=2019-01-01&view=COUNTERPARTY HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1247

{
  "_embedded" : {
    "cashFlows" : [ {
      "main" : [ {
        "date" : "2001-01-01",
        "amount" : -1000000.0,
        "currency" : "EUR",
        "type" : "DRAWING"
      }, {
        "date" : "2001-02-01",
        "amount" : 5000.0,
        "currency" : "EUR",
        "type" : "INTEREST"
      }, {
        "date" : "2001-02-01",
        "amount" : 100.0,
        "currency" : "EUR",
        "type" : "FEE"
      }, {
        "date" : "2001-03-01",
        "amount" : 5000.0,
        "currency" : "EUR",
        "type" : "INTEREST"
      }, {
        "date" : "2001-03-01",
        "amount" : 100.0,
        "currency" : "EUR",
        "type" : "DRAWING"
      } ],
      "renewal" : [ {
        "date" : "2001-02-01",
        "amount" : 5000.0,
        "currency" : "EUR",
        "type" : "INTEREST"
      }, {
        "date" : "2001-02-01",
        "amount" : 100.0,
        "currency" : "EUR",
        "type" : "FEE"
      }, {
        "date" : "2001-03-01",
        "amount" : 5000.0,
        "currency" : "EUR",
        "type" : "INTEREST"
      } ]
    } ]
  },
  "_links" : {
    "transaction" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/ACNT1/transactions/123456789?organization_id=987654321"
    }
  }
}

Response fields

Path Type Description

_embedded.cashFlows

Array

An array of Real Cash Flow and renewal Cash Flow resources

_embedded.cashFlows[].main[]

Array

An array of Real Cash Flow resources

_embedded.cashFlows[].renewal[]

Array

An array of renewal Cash Flow resources

_embedded.cashFlows[].main[].date

String

An ISO-8601 date representing the payment date for this cash flow

_embedded.cashFlows[].main[].amount

Number

The numeric amount of this cash flow

_embedded.cashFlows[].main[].currency

String

The currency of the amount for this cash flow

_embedded.cashFlows[].main[].type

String

The payment type in the followings: DRAWING, AMORTIZATION, CAPITALIZATION, NOTIONAL, INTEREST, PREMIUM, FEE, PIK_INTEREST, VIRTUAL_PIK, PAYOFF, SUBSIDY_INTEREST, PIK_INTEREST_PAID, STOCK, PAID_CAPITALIZED_INTEREST, CAPITALIZED_FEE, RESIDUAL, DEFERRED_PRINCIPAL, DEFERRED_INTEREST, DEFERRED_FEE, REFINANCING_WITHOUT_CASH_FLOW, DRAWING_WITHOUT_CASH_FLOW, DEFERRED_RESIDUAL

_links

Object

Links to other resources

Relation Description

transaction

Link to the transaction those cash flows belong to

Listing cash flows on a set of transactions

This is the BETA version. Official version will be released before the end of Q2.

A GET request will list all of the cash flows for a set of transaction IDs.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/ACNT1/cash-flows?organization_id=987654321&analysis_date=2001-01-01&renewals_until=2019-01-01&view=PARTY&stage=ACTUAL&transaction_id=123456789&transaction_id=987654321&page=0&size=10' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_code}/cash-flows
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

organization_id

Organization ID. Mandatory.

transaction_id

Transaction ID. Mandatory. Can be added several times.

analysis_date

Analysis date in ISO-8601 format. Optional. Defaults to current date

renewals_until

the deal will be renewed until this date. Optional.

view

It takes COUNTERPARTY or PARTY as value. if the parameter is not set, the view by default is set to PARTY.

stage

It takes ACTUAL, DRAFT or SIMULATED as value. if the parameter is not set, the stage of the first transaction is used. Explicitly specifying this parameter may improve performance.

size

Page size. Optional. Defaults 10.

page

Page number requested. Optional. Defaults 0.

HTTP request

GET /api/debt/v4/ACNT1/cash-flows?organization_id=987654321&analysis_date=2001-01-01&renewals_until=2019-01-01&view=PARTY&stage=ACTUAL&transaction_id=123456789&transaction_id=987654321&page=0&size=10 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2256

{
  "_embedded" : {
    "cash_flows_by_transaction" : [ {
      "id" : "123456789",
      "cash_flows" : {
        "main" : [ {
          "date" : "2001-01-01",
          "amount" : -1000000.0,
          "currency" : "EUR",
          "type" : "DRAWING"
        }, {
          "date" : "2001-02-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        }, {
          "date" : "2001-02-01",
          "amount" : 100.0,
          "currency" : "EUR",
          "type" : "FEE"
        }, {
          "date" : "2001-03-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        }, {
          "date" : "2001-03-01",
          "amount" : 100.0,
          "currency" : "EUR",
          "type" : "DRAWING"
        } ],
        "renewal" : [ {
          "date" : "2002-02-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        }, {
          "date" : "2002-02-01",
          "amount" : 100.0,
          "currency" : "EUR",
          "type" : "FEE"
        }, {
          "date" : "2002-03-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        } ]
      }
    }, {
      "id" : "987654321",
      "cash_flows" : {
        "main" : [ {
          "date" : "2001-01-01",
          "amount" : -1000000.0,
          "currency" : "EUR",
          "type" : "DRAWING"
        }, {
          "date" : "2001-02-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        }, {
          "date" : "2001-02-01",
          "amount" : 100.0,
          "currency" : "EUR",
          "type" : "FEE"
        }, {
          "date" : "2001-03-01",
          "amount" : 5000.0,
          "currency" : "EUR",
          "type" : "INTEREST"
        }, {
          "date" : "2001-03-01",
          "amount" : 100.0,
          "currency" : "EUR",
          "type" : "DRAWING"
        } ],
        "renewal" : [ ]
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v4/ACNT1/cash-flows?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.cash_flows_by_transaction[]

Array

An array of Cash Flows by Transaction ID

_embedded.cash_flows_by_transaction[].id

String

Transaction ID

_embedded.cash_flows_by_transaction[]cash_flows

Object

An object of Real Cash Flow and renewal Cash Flow resources

_embedded.cash_flows_by_transaction[].cash_flows.main[]

Array

An array of Real Cash Flow resources

_embedded.cash_flows_by_transaction[].cash_flows.renewal[]

Array

An array of renewal Cash Flow resources

_embedded.cash_flows_by_transaction[]cash_flows.main[].date

String

An ISO-8601 date representing the payment date for this cash flow

_embedded.cash_flows_by_transaction[].cash_flows.main[].amount

Number

The numeric amount of this cash flow

_embedded.cash_flows_by_transaction[].cash_flows.main[].currency

String

The currency of the amount for this cash flow

_embedded.cash_flows_by_transaction[].cash_flows.main[].type

String

The payment type in the followings: DRAWING, AMORTIZATION, CAPITALIZATION, NOTIONAL, INTEREST, PREMIUM, FEE, PIK_INTEREST, VIRTUAL_PIK, PAYOFF, SUBSIDY_INTEREST, PIK_INTEREST_PAID, STOCK, PAID_CAPITALIZED_INTEREST, CAPITALIZED_FEE, RESIDUAL, DEFERRED_PRINCIPAL, DEFERRED_INTEREST, DEFERRED_FEE, REFINANCING_WITHOUT_CASH_FLOW, DRAWING_WITHOUT_CASH_FLOW, DEFERRED_RESIDUAL

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Snippet links not found for operation::debt-account-cash-flows-v4-GET

Indicators

Those APIs are used to list and retrieve multiple indicators from a multiple financial products.

Spot Indicators

This is the BETA version. Official version will be released before the end of Q2

A GET request will retrieve multiple indicators from a multiple transactions on a given date.

Please note that there are limitations :

  • A limitation of the number of transactions per page. Default value is set to 20.

  • A threshold per request defined by the number of indicators multiply by the number of transactions per page. Default value is set to 200.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/123456789/indicators/spot?organization_id=987654321&indicator=OUTSTANDING_BALANCE_AFTER_PAYMENT&indicator=RATE_COMMITMENT&transaction_id=1234567&transaction_id=7891011&analysis_date=2012-12-21&view=PARTY&stage=ACTUAL&aggregate=true&page=0&size=10' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_id}/indicators/spot
Parameter Description

account_id

Account ID

Request parameters

Parameter Description

organization_id

Organization ID

indicator

Attribute codes. Multiple values can be set

transaction_id

Transaction IDs. Multiple values can be set

analysis_date

Analysis date in ISO-8601 format. Optional. Default to current date

view

Takes two values : PARTY or COUNTERPARTY. Optional. Default to PARTY

stage

It takes ACTUAL, DRAFT or SIMULATED as value. if the parameter is not set, the stage of the first transaction is used. Explicitly specifying this parameter may improve performance.

aggregate

Boolean value. Default True. If false you will see all children’s indicators.

size

Page size. Optional. Defaults 20.

page

Page number requested. Optional. Defaults 0.

HTTP request

GET /api/debt/v4/123456789/indicators/spot?organization_id=987654321&indicator=OUTSTANDING_BALANCE_AFTER_PAYMENT&indicator=RATE_COMMITMENT&transaction_id=1234567&transaction_id=7891011&analysis_date=2012-12-21&view=PARTY&stage=ACTUAL&aggregate=true&page=0&size=10 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 930

{
  "_embedded" : {
    "deal_indicators" : [ {
      "object_id" : "1234567",
      "reference" : "TX123",
      "stage" : "ACTUAL",
      "success" : {
        "indicator_results" : [ {
          "key" : "OUTSTANDING_BALANCE_AFTER_PAYMENT",
          "success" : {
            "value" : "500000 EUR"
          }
        }, {
          "key" : "RATE_COMMITMENT",
          "failure" : {
            "message" : "Unsupported"
          }
        } ]
      }
    }, {
      "object_id" : "7891011",
      "reference" : "TX456",
      "stage" : "ACTUAL",
      "failure" : {
        "message" : "Amortization mismatch for deal 'TX456': got 10.00EUR while expecting 0"
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v4/123456789/indicators/spot?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.deal_indicators[]

Array

An array of computed transactions

_embedded.deal_indicators[].object_id

String

Transaction ID

_embedded.deal_indicators[].reference

String

Transaction Reference

_embedded.deal_indicators[].stage

String

Transaction Stage. ACTUAL, DRAFT or SIMULATED.

_embedded.deal_indicators[].failure.message

String

Deal failure message

_embedded.deal_indicators[].success.indicator_results[]

Array

An array of computed attributes

_embedded.deal_indicators[].success.indicator_results[].key

String

Attribute key

_embedded.deal_indicators[].success.indicator_results[].success.value

String

Attribute value

_embedded.deal_indicators[].success.indicator_results[].failure.message

String

Attribute failure message

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer

Periodic Indicators

This is the BETA version. Official version will be released before the end of Q2

A GET request will retrieve multiple indicators from a multiple transactions on a given period.

Please note that there are limitations :

  • A limitation of the number of transactions per page. Default value is set to 20.

  • A threshold per request defined by the number of indicators multiply by the number of transactions per page. Default value is set to 200.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v4/123456789/indicators/periodic?organization_id=987654321&indicator=PRINCIPAL_AMORTIZED_ON_PERIOD&indicator=PRINCIPAL_PAID_ON_PERIOD&transaction_id=1234567&transaction_id=7891011&analysis_date=2012-12-21&start_date=2011-12-21&end_date=2013-12-21&include_renewal=true&view=PARTY&stage=ACTUAL&aggregate=false&page=0&size=10' -i -X GET

Path parameters

Table 1. /api/debt/v4/{account_id}/indicators/periodic
Parameter Description

account_id

Account ID

Request parameters

Parameter Description

organization_id

Organization ID

indicator

Attribute codes. Multiple values can be set

transaction_id

Transaction IDs. Multiple values can be set

analysis_date

Analysis date in ISO-8601 format. Optional. Default to current date

start_date

start date of the analysis period. In ISO-8601 format.

end_date

end date of the analysis period. In ISO-8601 format. It can’t be before the start date

view

Takes two values : PARTY or COUNTERPARTY. Optional. Default to PARTY

include_renewal

Boolean value. true or false

stage

It takes ACTUAL, DRAFT or SIMULATED as value. if the parameter is not set, the stage of the first transaction is used. Explicitly specifying this parameter may improve performance.

aggregate

Boolean value. Default True. If false you will see all children’s indicators.

size

Page size. Optional. Defaults 20.

page

Page number requested. Optional. Defaults 0.

HTTP request

GET /api/debt/v4/123456789/indicators/periodic?organization_id=987654321&indicator=PRINCIPAL_AMORTIZED_ON_PERIOD&indicator=PRINCIPAL_PAID_ON_PERIOD&transaction_id=1234567&transaction_id=7891011&analysis_date=2012-12-21&start_date=2011-12-21&end_date=2013-12-21&include_renewal=true&view=PARTY&stage=ACTUAL&aggregate=false&page=0&size=10 HTTP/1.1
Host: apigw.financeactive.eu

HTTP response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json
Cache-Control: no-store,no-cache,must-revalidate
Pragma: no-cache
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 940

{
  "_embedded" : {
    "deal_indicators" : [ {
      "object_id" : "1234567",
      "reference" : "TX123",
      "stage" : "ACTUAL",
      "success" : {
        "indicator_results" : [ {
          "key" : "PRINCIPAL_AMORTIZED_ON_PERIOD",
          "success" : {
            "value" : "1000000 EUR"
          }
        }, {
          "key" : "PRINCIPAL_PAID_ON_PERIOD",
          "failure" : {
            "message" : "Unsupported"
          }
        } ]
      }
    }, {
      "object_id" : "7891011",
      "reference" : "TX456",
      "stage" : "ACTUAL",
      "failure" : {
        "message" : "Amortization mismatch for deal 'TX456': got 10.00EUR while expecting 0"
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v4/123456789/indicators/periodic?page=0&size=10"
    }
  },
  "page" : {
    "size" : 10,
    "total_elements" : 2,
    "total_pages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.deal_indicators[]

Array

An array of computed transactions

_embedded.deal_indicators[].object_id

String

Transaction ID

_embedded.deal_indicators[].reference

String

Transaction Reference

_embedded.deal_indicators[].stage

String

Transaction Stage. ACTUAL, DRAFT or SIMULATED.

_embedded.deal_indicators[].failure.message

String

Deal failure message

_embedded.deal_indicators[].success.indicator_results[]

Array

An array of computed attributes

_embedded.deal_indicators[].success.indicator_results[].key

String

Attribute key

_embedded.deal_indicators[].success.indicator_results[].success.value

String

Attribute value

_embedded.deal_indicators[].success.indicator_results[].failure.message

String

Attribute failure message

_links

Object

Links to other resources

page

Object

Pagination information

page.size

Number

Current page size. Integer

page.total_elements

Number

Total number of elements for this collection. Integer

page.total_pages

Number

Total number of pages. Integer

page.number

Number

Current page number. 0-based integer