Transactions

Listing transactions

A GET request will list all of the transactions.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/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/v3/{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/v3/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;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: 5991

{
  "_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/v3/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/v3/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/v3/234567891/transactions/123456789?organization_id=987654321"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/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

Number

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/v3/ACNT1/transactions/123456789?organization_id=987654321' -i -X GET

Path parameters

Table 1. /api/debt/v3/{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/v3/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;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: 1624

{
  "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/v3/234567891/transactions/123456789?organization_id=987654321"
    }
  }
}

Response fields

Path Type Description

object_id

Number

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

Retrieving a transaction phase

A GET request will list all phases of the transactions.

Curl request

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

Path parameters

Table 1. /api/debt/v3/{account_code}/transactions/{transaction_id}/phases
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/v3/ACNT1/transactions/123456789/phases?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;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: 1930

{
  "phases" : [ {
    "start_date" : "2020-04-01",
    "end_date" : "2030-04-01",
    "rate_type" : {
      "value" : "FIXED",
      "label" : "Fixed"
    },
    "day_count_convention" : {
      "value" : "AFBActualActual",
      "label" : "AFB Actual"
    },
    "has_in_advance_interest_payment" : false,
    "has_capitalized_interest" : true,
    "interest_rate" : 1.5,
    "frequency" : {
      "value" : "SEMI_ANNUAL",
      "label" : "Biannually"
    },
    "interest_calculation_adjustment" : {
      "value" : "UNADJUSTED",
      "label" : "Unadjusted"
    },
    "last_stub_period" : {
      "value" : "LONG_LAST",
      "label" : "Long last"
    },
    "payment_date_adjustment" : {
      "day_count" : 3,
      "day_type" : "Calendar",
      "day_convention" : "Following",
      "strategy_type" : "Custom"
    },
    "custom_properties" : [ ]
  }, {
    "start_date" : "2030-04-01",
    "end_date" : "2040-04-01",
    "rate_type" : {
      "value" : "FLOATING",
      "label" : "Floating"
    },
    "index" : "IREF2",
    "spread" : 4.0,
    "day_count_convention" : {
      "value" : "AFBActualActual",
      "label" : "AFB Actual"
    },
    "first_fixing_value" : 3.0,
    "has_in_advance_interest_payment" : true,
    "has_capitalized_interest" : false,
    "frequency" : {
      "value" : "SEMI_ANNUAL",
      "label" : "Biannually"
    },
    "interest_calculation_adjustment" : {
      "value" : "UNADJUSTED",
      "label" : "Unadjusted"
    },
    "last_stub_period" : {
      "value" : "SHORT_LAST",
      "label" : "Short last"
    },
    "payment_date_adjustment" : {
      "day_count" : 3,
      "day_type" : "Calendar",
      "day_convention" : "Following",
      "strategy_type" : "Custom"
    },
    "custom_properties" : [ ]
  } ],
  "_links" : {
    "transaction" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/transactions/123456789?organization_id=987654321"
    }
  }
}

Response fields

Path Type Description

phases[].start_date

String

Phase start date

phases[].end_date

String

Phase end date

phases[].rate_type

Object

Phase rate type

phases[].index

String

Phase index

phases[].spread

Number

Phase spread

phases[].day_count_convention

Object

Phase day count convention

phases[].first_fixing_value

Number

Phase first fixing value

phases[].has_in_advance_interest_payment

Boolean

Phase has in advance interest payment

phases[].has_capitalized_interest

Boolean

Phase has capitalized interest

phases[].interest_rate

Number

Phase interest rate for FIXED rate type

phases[].frequency

Object

Phase frequency

phases[].interest_calculation_adjustment

Object

Phase interest calculation adjustment

phases[].last_stub_period

Object

Phase last stub period

phases[].payment_date_adjustment

Object

Phase payment date adjustment

phases[].payment_date_adjustment.day_count

Number

Phase payment date adjustment day count

phases[].payment_date_adjustment.day_type

String

Phase payment date adjustment day type

phases[].payment_date_adjustment.day_convention

String

Phase payment date adjustment day convention

phases[].payment_date_adjustment.strategy_type

String

Phase payment date adjustment strategy type

phases[].custom_properties[]

Array

List of custom properties

phases[].custom_properties[].key

class java.lang.String

Code name of the custom property

phases[].custom_properties[].name

class java.lang.String

Name of the custom property

phases[].custom_properties[].value

class java.lang.String

Value of the custom property

_links

Object

Links to resources linked to this transaction

Relation Description

transaction

Link to the phase transaction

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 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/v3/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/v3/{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/v3/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;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: 2252

{
  "_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/v3/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

Number

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-GET

Indicators

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

Listing indicators

A GET request will list all of the indicators.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/indicators?organization_id=987654321&analysis_type=SPOT' -i -X GET

Path parameters

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

account_id

Account ID

Request parameters

Parameter Description

organization_id

Organization ID

analysis_type

Analysis type of the indicator list : SPOT, PERIODIC.

HTTP request

GET /api/debt/v3/ACNT1/indicators?organization_id=987654321&analysis_type=SPOT 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: 625

{
  "_embedded" : {
    "indicators" : [ {
      "indicator_id" : {
        "key" : "ACCRUED_FEE",
        "value" : "Accrued fees"
      },
      "value_type" : {
        "key" : "Amount",
        "value" : "Amount"
      }
    }, {
      "indicator_id" : {
        "key" : "deal-current-interest-rate",
        "value" : "Current Rate"
      },
      "value_type" : {
        "key" : "InterestRate",
        "value" : "Interest Rate"
      }
    } ]
  },
  "_links" : {
    "indicator" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/ACNT1/indicators?organization_id=987654321&analysis_type=SPOT"
    }
  }
}

Response fields

Path Type Description

_embedded.indicators[]

Array

An array of indicator resources

_embedded.indicators[].indicator_id

Object

Indicator technical ID

_embedded.indicators[].value_type

Object

The type of value to this indicator.

_links

Object

Link to this indicator list

Relation Description

indicator

Link to the indicator

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.

  • If you use the id of a transaction matured at the analysis date, the API won’t return any results for the selected indicator.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/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&stage=ACTUAL&view=PARTY&page=0&size=10' -i -X GET

Path parameters

Table 1. /api/debt/v3/{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

size

Page size. Optional. Defaults 20.

page

Page number requested. Optional. Defaults 0.

stage

It takes ACTUAL or SIMULATED as value. if the parameter is not set, both will be used. Explicitly specifying this parameter may improve performance.

HTTP request

GET /api/debt/v3/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&stage=ACTUAL&view=PARTY&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;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: 926

{
  "_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/v3/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

Number

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/v3/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&stage=ACTUAL&view=PARTY&page=0&size=10' -i -X GET

Path parameters

Table 1. /api/debt/v3/{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

size

Page size. Optional. Defaults 20.

page

Page number requested. Optional. Defaults 0.

stage

It takes ACTUAL or SIMULATED as value. if the parameter is not set, both will be used. Explicitly specifying this parameter may improve performance.

HTTP request

GET /api/debt/v3/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&stage=ACTUAL&view=PARTY&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;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: 936

{
  "_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/v3/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

Number

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

Integrations

Integrate a deal with an XML file

A POST request that will integrate your file.

This endpoint works with XML files that are compliant with the apollo-v3.xsd, the latest version. Use this endpoint by default, unless your consultant has recommended a version for specific purposes.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/integrations?lax=false' -i -X POST \
    -H 'Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8' \
    -F 'uploadedFile=@empty-v3.xml;type=application/xml' \
    -d '--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v3.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@2eb00797
--abcde--
'

Path parameters

Table 1. /api/debt/v3/{account_code}/integrations
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

lax

Boolean to indicate if the integration should be lenient

HTTP request

POST /api/debt/v3/ACNT1/integrations?lax=false HTTP/1.1
Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Length: 203
Host: apigw.financeactive.eu

--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v3.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@2eb00797
--abcde--

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: 232

{
  "object_id" : 1234567890,
  "filename" : "empty-v3.xml",
  "integrated" : 0,
  "failed" : 0,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/integrations/1234567890"
    }
  }
}

Response fields

Path Type Description

object_id

Number

Integration technical ID

filename

String

Filename integrated

integrated

Number

Number of integrated item

failed

Number

Number of failed item

_links

Object

Links to other resources

Relation Description

self

Link to this integration resource

Integration v3

A POST request that will integrate your file with the v3 engine.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/integrations/xml-v3?lax=false' -i -X POST \
    -H 'Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8' \
    -F 'uploadedFile=@empty-v3.xml;type=application/xml' \
    -d '--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v3.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@71c5ae7b
--abcde--
'

Path parameters

Table 1. /api/debt/v3/{account_code}/integrations/xml-v3
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

lax

Boolean to indicate if the integration should be lenient

HTTP request

POST /api/debt/v3/ACNT1/integrations/xml-v3?lax=false HTTP/1.1
Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Length: 203
Host: apigw.financeactive.eu

--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v3.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@71c5ae7b
--abcde--

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: 232

{
  "object_id" : 1234567890,
  "filename" : "empty-v3.xml",
  "integrated" : 0,
  "failed" : 0,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/integrations/1234567890"
    }
  }
}

Response fields

Path Type Description

object_id

Number

Integration technical ID

filename

String

Filename integrated

integrated

Number

Number of integrated item

failed

Number

Number of failed item

_links

Object

Links to other resources

Relation Description

self

Link to this integration resource

Integration v2

A POST request that will integrate your file with the v2 engine.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/integrations/xml-v2?lax=false' -i -X POST \
    -H 'Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8' \
    -F 'uploadedFile=@empty-v2.xml;type=application/xml' \
    -d '--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v2.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@51a155b0
--abcde--
'

Path parameters

Table 1. /api/debt/v3/{account_code}/integrations/xml-v2
Parameter Description

account_code

Account code or ID

Request parameters

Parameter Description

lax

Boolean to indicate if the integration should be lenient

HTTP request

POST /api/debt/v3/ACNT1/integrations/xml-v2?lax=false HTTP/1.1
Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Length: 203
Host: apigw.financeactive.eu

--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v2.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@51a155b0
--abcde--

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: 232

{
  "object_id" : 1234567890,
  "filename" : "empty-v2.xml",
  "integrated" : 0,
  "failed" : 0,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/integrations/1234567890"
    }
  }
}

Response fields

Path Type Description

object_id

Number

Integration technical ID

filename

String

Filename integrated

integrated

Number

Number of integrated item

failed

Number

Number of failed item

_links

Object

Links to other resources

Relation Description

self

Link to this integration resource

Integration v1

A POST request that will integrate your file with the v1 engine.

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/integrations/xml-v1?lax=false' -i -X POST \
    -H 'Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8' \
    -F 'uploadedFile=@empty-v1.xml;type=application/xml' \
    -d '--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v1.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@45604bc4
--abcde--
'

Path parameters

Table 1. /api/debt/v3/{account_code}/integrations/xml-v1
Parameter Description

account_code

Account code or ID

HTTP request

POST /api/debt/v3/ACNT1/integrations/xml-v1?lax=false HTTP/1.1
Content-Type: multipart/form-data;boundary=abcde;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Length: 203
Host: apigw.financeactive.eu

--abcde
Content-Disposition: form-data; name="uploadedFile"; filename="empty-v1.xml"
Content-Type: application/xml; charset=UTF-8

org.springframework.mock.web.MockMultipartFile@45604bc4
--abcde--

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: 232

{
  "object_id" : 1234567890,
  "filename" : "empty-v1.xml",
  "integrated" : 0,
  "failed" : 0,
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/integrations/1234567890"
    }
  }
}

Response fields

Path Type Description

object_id

Number

Integration technical ID

filename

String

Filename integrated

integrated

Number

Number of integrated item

failed

Number

Number of failed item

_links

Object

Links to other resources

Relation Description

self

Link to this integration resource

Retrieving an integration report

Curl request

$ curl 'https://apigw.financeactive.eu/api/debt/v3/ACNT1/integrations/123456789' -i -X GET

Path parameters

Table 1. /api/debt/v3/{account_code}/integrations/{integration_id}
Parameter Description

account_code

Account code or ID

integration_id

Integration ID

HTTP request

GET /api/debt/v3/ACNT1/integrations/123456789 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: 383

{
  "object_id" : 0,
  "created" : 1,
  "deleted" : 0,
  "updated" : 0,
  "failed" : 0,
  "details" : [ {
    "status" : "SUCCESS",
    "reference" : "TRACKING12345",
    "type" : "TYPE_12345",
    "action" : "CREATED",
    "reason" : "REASON_12345"
  } ],
  "_links" : {
    "self" : {
      "href" : "https://apigw.financeactive.eu/api/debt/v3/234567891/integrations/0"
    }
  }
}

Response fields

Path Type Description

object_id

Number

Integration technical ID

created

Number

Number of created item

deleted

Number

Number of deleted item

updated

Number

Number of updated item

failed

Number

Number of failed item

details

Array

List of details about integrated items

details[].status

String

Tracking status of the item

details[].reference

String

Reference of the item

details[].type

String

Type of the item

details[].action

String

Action performed on the item

details[].reason

String

Reason of the action performed on the item

_links

Object

Links to other resources

Relation Description

self

Link to this integration resource