Endpoints

AccountingAccountMappings

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

APIDescription
GET api/{version}/AccountingAccountMappings

Get AccountingAccountMappings from the server. Supports OData URL.

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

Get AccountingAccount by id.

POST api/{version}/AccountingAccountMappings

Creates an AccountingAccountMapping.

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

Updates an AccountingAccountMapping.

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

Deletes an AccountingAccountMapping

AccountingAccounts

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

APIDescription
GET api/{version}/AccountingAccounts

Get AccountingAccounts from the server. Supports OData URL.

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

Get AccountingAccount by id.

POST api/{version}/AccountingAccounts

Creates an AccountingAccount.

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

Updates an AccountingAccount.

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

No documentation available.

Accounts

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}/Accounts/{id}

Get Account by id.

AccountStatuses

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

APIDescription
GET api/{version}/AccountStatuses

Get AccountStatuses from the server. Supports OData URL.

AccountTerms

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

APIDescription
GET api/{version}/AccountTerms

Get AccountTerms from the server. Supports OData URL.

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

Get AccountTerm by id.

AccountTypes

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

APIDescription
GET api/{version}/AccountTypes

Get AccountTypes from the server. Supports OData URL.

BankNames

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

APIDescription
GET api/{version}/BankNames

Get BankNames from the server. Supports OData URL.

Countries

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

APIDescription
GET api/{version}/Countries

Get Countries from the server. Supports OData URL.

Currencies

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

APIDescription
GET api/{version}/Currencies

Get Currencies from the server. Supports OData URL.

CustomerTypes

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

APIDescription
GET api/{version}/CustomerTypes

Get CustomerTypes from the server. Supports OData URL.

Files

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}/Files

Get Files from the server. Supports OData URL.

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

Get File by id.

POST api/{version}/Files

Creates a File.

FileTypes

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

APIDescription
GET api/{version}/FileTypes

Get FileTypes from the server. Supports OData URL.

GlobalSettings

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

APIDescription
GET api/{version}/GlobalSettings

Get GlobalSettings from the server. Supports OData URL.

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

Get GlobalSetting by id.

IndustryNames

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

APIDescription
GET api/{version}/IndustryNames

Get IndustryNames from the server. Supports OData URL.

InvoiceDueDateOfMonthTypes

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

APIDescription
GET api/{version}/InvoiceDueDateOfMonthTypes

Get InvoiceDueDateOfMonthTypes from the server. Supports OData URL.

Invoices

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

APIDescription
GET api/{version}/Invoices

Get Invoices from the server. Supports OData URL.

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

Get Invoice by id.

LegalEntityStatuses

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

APIDescription
GET api/{version}/LegalEntityStatuses

Get LegalEntityStatuses from the server.

LegalEntityTypes

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

APIDescription
GET api/{version}/LegalEntityTypes

Get LegalEntityTypes from the server. Supports OData URL.

Lenders

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}/Lenders/{id}

Get Lender by id.

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

Updates a Lender.

LoanApplications

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.

Mandates

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

APIDescription
GET api/{version}/Mandates

Get Mandates from the server. Supports OData URL.

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

Get Mandate by id.

POST api/{version}/Mandates

Creates a Mandate.

PaymentReceivers

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

APIDescription
GET api/{version}/PaymentReceivers

Get PaymentReceivers from the server. Supports OData URL.

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

Get PaymentReceiver by id.

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

Updates a PaymentReceiver.

POST api/{version}/PaymentReceivers

Creates a PaymentReceiver.

PaymentReceiverTypes

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

APIDescription
GET api/{version}/PaymentReceiverTypes

Get PaymentReceiverTypes from the server. Supports OData URL.

PaymentRoutes

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

APIDescription
GET api/{version}/PaymentRoutes

Get PaymentRoutes from the server. Supports OData URL.

Persons

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

APIDescription
GET api/{version}/Persons

Get Persons from the server. Supports OData URL.

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

Get Person by id.

POST api/{version}/Persons

Creates a Person.

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

Updates a Person.

Products

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

APIDescription
GET api/{version}/Products

Get Products from the server. Supports OData URL.

ProductStatuses

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

APIDescription
GET api/{version}/ProductStatuses

Get ProductStatuses from the server. Supports OData URL.

RepaymentTypes

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

APIDescription
GET api/{version}/RepaymentTypes

Get RepaymentTypes from the server. Supports OData URL.

SettlementOrders

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}/SettlementOrders/{id}

Get SettlementOrder by id.

SettlementOrderStatuses

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

APIDescription
GET api/{version}/SettlementOrderStatuses

Get SettlementOrderStatuses from the server. Supports OData URL.

SettlementOrderTypes

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

APIDescription
GET api/{version}/SettlementOrderTypes

Get SettlementOrderTypes from the server. Supports OData URL.

Signings

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

APIDescription
GET api/{version}/Signings

Get Signings from the server. Supports OData URL.

POST api/{version}/Signings

Creates a Signing.

SigningTypes

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

APIDescription
GET api/{version}/SigningTypes

Get SigningTypes from the server. Supports OData URL.

SiteDocuments

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

APIDescription
GET api/{version}/SiteDocuments

Get SiteDocuments from the server. Supports OData URL.

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

Get SiteDocument by id.

TransactionTypes

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

APIDescription
GET api/{version}/TransactionTypes

Get TransactionTypes from the server. Supports OData URL.

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

Get TransactionType by id.

Users

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}/Users

Get Users from the server. Supports OData URL.