Endpoints

AccountsController

Account endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/accounts

Get Accounts from the server. Supports OData URL.

POST api/{version}/accounts

Creates an Account.

POST api/{version}/accounts/accountnumbers

Get Accounts from the server.

GET api/{version}/v1.Accounts/{id}

Get Account by id.

FilesController

File endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/files/stream/{id}

Get file stream

GET api/{version}/v1.Files

Get Files from the server. Supports OData URL.

GET api/{version}/v1.Files/{id}

Get File by id.

POST api/{version}/v1.Files

Creates a File.

SettlementOrdersController

SettlementOrder endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/settlementorders

Get SettlementOrders from the server. Supports OData URL.

POST api/{version}/settlementorders

Creates a SettlementOrder.

POST api/{version}/settlementorders/{id}/cancel

Cancel a settlement order.

GET api/{version}/v1.SettlementOrders/{id}

Get SettlementOrder by id.

UsersController

User endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
PUT api/{version}/Users/ChangePassword

Change password for an user.

PUT api/{version}/Users/ResetPassword

Reset password for an user.

GET api/{version}/v1.Users

Get Users from the server. Supports OData URL.

LendersController

Lender endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/Lenders

Get Lenders from the server. Supports OData URL.

POST api/{version}/Lenders

Creates a Lender. Lender is also created in BFS.

POST api/{version}/Lenders/Authenticate

Authenticate a lender.

POST api/{version}/Lenders/setlenderinvestmentprofile

Set lender investment profile.

GET api/{version}/v1.Lenders/{id}

Get Lender by id.

PUT api/{version}/v1.Lenders/{id}

Updates a Lender.

LoanApplicationsController

LoanApplication endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/loanapplications

Get LoanApplications from the server. Supports OData URL.

GET api/{version}/loanapplications/{id}

Get LoanApplication by id.

POST api/{version}/LoanApplications

Creates a LoanApplication

POST api/{version}/LoanApplications/Approve/{id}

Approve a LoanApplication.

POST api/{version}/LoanApplications/Reject/{id}

Reject a LoanApplication.

ValuesController

APIDescription
GET api/{version}/v2.Values

No documentation available.

GET api/{version}/v2.Values/{id}

No documentation available.

POST api/{version}/v2.Values

No documentation available.

PUT api/{version}/v2.Values/{id}

No documentation available.

DELETE api/{version}/v2.Values/{id}

No documentation available.

AccountingAccountMappingsController

AccountingAccountMapping endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.AccountingAccountMappings

Get AccountingAccountMappings from the server. Supports OData URL.

GET api/{version}/v1.AccountingAccountMappings/{id}

Get AccountingAccount by id.

POST api/{version}/v1.AccountingAccountMappings

Creates an AccountingAccountMapping.

PUT api/{version}/v1.AccountingAccountMappings/{id}

Updates an AccountingAccountMapping.

DELETE api/{version}/v1.AccountingAccountMappings/{id}

Deletes an AccountingAccountMapping

AccountingAccountsController

Account endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.AccountingAccounts

Get AccountingAccounts from the server. Supports OData URL.

GET api/{version}/v1.AccountingAccounts/{id}

Get AccountingAccount by id.

POST api/{version}/v1.AccountingAccounts

Creates an AccountingAccount.

PUT api/{version}/v1.AccountingAccounts/{id}

Updates an AccountingAccount.

DELETE api/{version}/v1.AccountingAccounts/{id}

No documentation available.

IndustryNamesController

IndustryNamesendpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.IndustryNames

Get IndustryNames from the server. Supports OData URL.

SigningsController

Signing endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Signings

Get Signings from the server. Supports OData URL.

POST api/{version}/v1.Signings

Creates a Signing.

TransactionTypesController

TransactionType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.TransactionTypes

Get TransactionTypes from the server. Supports OData URL.

GET api/{version}/v1.TransactionTypes/{id}

Get TransactionType by id.

InvoicesController

Invoice endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Invoices

Get Invoices from the server. Supports OData URL.

GET api/{version}/v1.Invoices/{id}

Get Invoice by id.

SiteDocumentsController

SiteDocument endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.SiteDocuments

Get SiteDocuments from the server. Supports OData URL.

GET api/{version}/v1.SiteDocuments/{id}

Get SiteDocument by id.

RepaymentTypesController

RepaymentType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.RepaymentTypes

Get RepaymentTypes from the server. Supports OData URL.

LegalEntityStatusesController

LegalEntityStatuses endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.LegalEntityStatuses

Get LegalEntityStatuses from the server.

AccountTermsController

AccountTerm endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.AccountTerms

Get AccountTerms from the server. Supports OData URL.

GET api/{version}/v1.AccountTerms/{id}

Get AccountTerm by id.

GlobalSettingsController

GlobalSetting endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.GlobalSettings

Get GlobalSettings from the server. Supports OData URL.

GET api/{version}/v1.GlobalSettings/{id}

Get GlobalSetting by id.

MandatesController

Mandate endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Mandates

Get Mandates from the server. Supports OData URL.

GET api/{version}/v1.Mandates/{id}

Get Mandate by id.

POST api/{version}/v1.Mandates

Creates a Mandate.

FileTypesController

FileType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.FileTypes

Get FileTypes from the server. Supports OData URL.

SettlementOrderStatusesController

SettlementOrderStatus endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.SettlementOrderStatuses

Get SettlementOrderStatuses from the server. Supports OData URL.

PaymentRoutesController

PaymentRoute endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.PaymentRoutes

Get PaymentRoutes from the server. Supports OData URL.

CustomerTypesController

CustomerType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.CustomerTypes

Get CustomerTypes from the server. Supports OData URL.

SettlementOrderTypesController

SettlementOrderType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.SettlementOrderTypes

Get SettlementOrderTypes from the server. Supports OData URL.

PaymentReceiverTypesController

PaymentReceiverType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.PaymentReceiverTypes

Get PaymentReceiverTypes from the server. Supports OData URL.

InvoiceDueDateOfMonthTypesController

InvoiceDueDateOfMonthType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.InvoiceDueDateOfMonthTypes

Get InvoiceDueDateOfMonthTypes from the server. Supports OData URL.

ProductStatusesController

ProductStatus endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.ProductStatuses

Get ProductStatuses from the server. Supports OData URL.

AccountStatusesController

AccountStatus endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.AccountStatuses

Get AccountStatuses from the server. Supports OData URL.

ProductsController

Product endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Products

Get Products from the server. Supports OData URL.

CountriesController

Country endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Countries

Get Countries from the server. Supports OData URL.

LegalEntityTypesController

LegalEntityType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.LegalEntityTypes

Get LegalEntityTypes from the server. Supports OData URL.

AccountTypesController

AccountType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.AccountTypes

Get AccountTypes from the server. Supports OData URL.

PersonsController

Person endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Persons

Get Persons from the server. Supports OData URL.

GET api/{version}/v1.Persons/{id}

Get Person by id.

POST api/{version}/v1.Persons

Creates a Person.

PUT api/{version}/v1.Persons/{id}

Updates a Person.

CurrenciesController

Currency endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.Currencies

Get Currencies from the server. Supports OData URL.

BankNamesController

BankName endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.BankNames

Get BankNames from the server. Supports OData URL.

PaymentReceiversController

PaymentReceiver endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.PaymentReceivers

Get PaymentReceivers from the server. Supports OData URL.

GET api/{version}/v1.PaymentReceivers/{id}

Get PaymentReceiver by id.

PUT api/{version}/v1.PaymentReceivers/{id}

Updates a PaymentReceiver.

POST api/{version}/v1.PaymentReceivers

Creates a PaymentReceiver.

SigningTypesController

SigningType endpoints. Replace {version} in URI with version number, for example v1.

APIDescription
GET api/{version}/v1.SigningTypes

Get SigningTypes from the server. Supports OData URL.

ValuesController

APIDescription
GET api/{version}/v1.Values

No documentation available.

GET api/{version}/v1.Values/{id}

No documentation available.

POST api/{version}/v1.Values

No documentation available.

PUT api/{version}/v1.Values/{id}

No documentation available.

DELETE api/{version}/v1.Values/{id}

No documentation available.