Loan repayments: Bimp API methods
Bimp API methods for the “Loan repayments” resource (/org2/loanRepayment/…): 4 methods. Base URL: https://app.bimpsoft.com. All requests except login pass the company token in the access-token header — see Getting started with the API.
Loan repayment documents
| Method | What it does |
|---|---|
POST /org2/loanRepayment/api-read | A request to obtain detailed information for a particular loan repayment document |
POST /org2/loanRepayment/api-readList | A request to view a list of loan repayment documents |
POST /org2/loanRepayment/api-create | A request to create a loan repayment document |
POST /org2/loanRepayment/api-update | A request to update a loan repayment document |
api-read
POST /org2/loanRepayment/api-read
A request to obtain detailed information for a particular loan repayment document
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
uuid | string (uuid) | yes | A unique uuid key for a loan repayment document |
Response: data field
| Field | Type | Description |
|---|---|---|
uuid | string (uuid) | A unique uuid key for a loan repayment document |
date | string | The document’s date in the format ‘YYYY-MM-DDTHH:MM:SS’ (e.g., ‘2025-05-16T09:17:49’) |
number | string | The document’s number. Use this field if you need to specify a custom number |
name | string | Document name |
comment | string | An optional text field for any additional notes or comments related to the document |
organization | string (uuid) | A unique identifier for the Organization, obtainable from the /organization/api-readList request |
author | string (uuid) | A unique identifier for the Author, obtainable from the /user/api-readList request |
status | string (uuid) | A unique uuid key for a document status |
counterparty | string (uuid) | A unique uuid key for the creditor (counterparty) |
paymentEntity | string (uuid) | The unique identifier for the payment entity type, obtainable from the /bankAccounts/api-readList request OR from /cashRegistry/api-readList request |
currency | string (uuid) | A unique identifier for the Currency, obtainable from the /currency/api-readList request |
rate | number | Currency exchange rate for the document |
documentSum | number | Total amount of the document |
contract | string (uuid) | The unique identifier for the counterparty’s contract, specified in the buyer key. You can retrieve this UUID using the /contract/api-readList request |
project | string (uuid) | A unique identifier for the Project, obtainable from the /project/api-readList request |
lineOfBusiness | string (uuid) | A unique identifier for the Line of Business, obtainable from the /lineOfBusiness/api-readList request |
expenseItem | string (uuid) | A unique identifier for the Expense Item, obtainable from the /expenseItems/api-readList request |
mutualSettlementType | string (uuid) | A unique uuid key for a mutual settlement type |
chartOfAccount | string (uuid) | A unique identifier for the Chart of account, obtainable from the /chartOfAccount/api-readList request |
counterpartyBankAccount | string (uuid) | A unique uuid key for the counterparty bank account |
cashPaymentType | number | Cash payment type code |
curl -X POST 'https://app.bimpsoft.com/org2/loanRepayment/api-read' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"uuid":"00000000-0000-0000-0000-000000000000"}'api-readList
POST /org2/loanRepayment/api-readList
A request to view a list of loan repayment documents
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
pagination | object | yes | |
pagination.offset | number | yes | Begin from {offset} elements |
pagination.count | number | yes | Limit of paginated elemets |
filters | object | Filters for loan repayment list | |
filters.comment | string | An optional text field for any additional notes or comments related to the document | |
filters.organization | string (uuid)[] | A unique identifier for the Organization, obtainable from the /organization/api-readList request | |
filters.author | string (uuid)[] | A unique identifier for the Author, obtainable from the /user/api-readList request | |
filters.counterparty | string (uuid)[] | A unique uuid key for the creditor (counterparty) | |
filters.paymentEntity | string (uuid)[] | The unique identifier for the payment entity type, obtainable from the /bankAccounts/api-readList request OR from /cashRegistry/api-readList request | |
filters.period | object[] | Date period filter [from, to] |
Response: data field
| Field | Type | Description |
|---|---|---|
[].uuid | string (uuid) | |
[].name | string | Document name |
[].number | string | The document’s number. Use this field if you need to specify a custom number |
[].date | string | The document’s date in the format ‘YYYY-MM-DDTHH:MM:SS’ (e.g., ‘2025-05-16T09:17:49’) |
[].comment | string | An optional text field for any additional notes or comments related to the document |
[].documentSum | number | Total amount of the document |
[].author | string (uuid) | A unique identifier for the Author, obtainable from the /user/api-readList request |
[].organization | string (uuid) | A unique identifier for the Organization, obtainable from the /organization/api-readList request |
[].counterparty | string (uuid) | A unique uuid key for the creditor (counterparty) |
[].currency | string (uuid) | A unique identifier for the Currency, obtainable from the /currency/api-readList request |
curl -X POST 'https://app.bimpsoft.com/org2/loanRepayment/api-readList' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"pagination":{"offset":0,"count":10}}'api-create
POST /org2/loanRepayment/api-create
A request to create a loan repayment document
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
organization | string (uuid) | yes | A unique identifier for the Organization, obtainable from the /organization/api-readList request |
paymentEntity | string (uuid) | yes | The unique identifier for the payment entity type, obtainable from the /bankAccounts/api-readList request OR from /cashRegistry/api-readList request |
counterparty | string (uuid) | yes | A unique uuid key for the creditor (counterparty) |
documentSum | number | yes | Total amount of the document |
project | string (uuid) | yes | A unique identifier for the Project, obtainable from the /project/api-readList request |
lineOfBusiness | string (uuid) | yes | A unique identifier for the Line of Business, obtainable from the /lineOfBusiness/api-readList request |
chartOfAccount | string (uuid) | A unique identifier for the Chart of account, obtainable from the /chartOfAccount/api-readList request | |
date | string | The document’s date in the format ‘YYYY-MM-DDTHH:MM:SS’ (e.g., ‘2025-05-16T09:17:49’) | |
number | string | The document’s number. Use this field if you need to specify a custom number | |
name | string | Document name | |
comment | string | An optional text field for any additional notes or comments related to the document | |
author | string (uuid) | A unique identifier for the Author, obtainable from the /user/api-readList request | |
status | string (uuid) | A unique uuid key for a document status | |
currency | string (uuid) | A unique identifier for the Currency, obtainable from the /currency/api-readList request | |
rate | number | Currency exchange rate for the document | |
contract | string (uuid) | The unique identifier for the counterparty’s contract, specified in the buyer key. You can retrieve this UUID using the /contract/api-readList request | |
expenseItem | string (uuid) | A unique identifier for the Expense Item, obtainable from the /expenseItems/api-readList request | |
mutualSettlementType | string (uuid) | A unique uuid key for a mutual settlement type | |
counterpartyBankAccount | string (uuid) | A unique uuid key for the counterparty bank account | |
cashPaymentType | number | Cash payment type code |
Response: data field
| Field | Type | Description |
|---|---|---|
uuid | string (uuid) |
curl -X POST 'https://app.bimpsoft.com/org2/loanRepayment/api-create' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"organization":"00000000-0000-0000-0000-000000000000","paymentEntity":"00000000-0000-0000-0000-000000000000","counterparty":"00000000-0000-0000-0000-000000000000","documentSum":1,"project":"00000000-0000-0000-0000-000000000000","lineOfBusiness":"00000000-0000-0000-0000-000000000000"}'api-update
POST /org2/loanRepayment/api-update
A request to update a loan repayment document
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
uuid | string (uuid) | yes | A unique uuid key for a loan repayment document |
organization | string (uuid) | A unique identifier for the Organization, obtainable from the /organization/api-readList request | |
paymentEntity | string (uuid) | The unique identifier for the payment entity type, obtainable from the /bankAccounts/api-readList request OR from /cashRegistry/api-readList request | |
counterparty | string (uuid) | A unique uuid key for the creditor (counterparty) | |
documentSum | number | Total amount of the document | |
project | string (uuid) | A unique identifier for the Project, obtainable from the /project/api-readList request | |
lineOfBusiness | string (uuid) | A unique identifier for the Line of Business, obtainable from the /lineOfBusiness/api-readList request | |
chartOfAccount | string (uuid) | A unique identifier for the Chart of account, obtainable from the /chartOfAccount/api-readList request | |
date | string | The document’s date in the format ‘YYYY-MM-DDTHH:MM:SS’ (e.g., ‘2025-05-16T09:17:49’) | |
number | string | The document’s number. Use this field if you need to specify a custom number | |
name | string | Document name | |
comment | string | An optional text field for any additional notes or comments related to the document | |
author | string (uuid) | A unique identifier for the Author, obtainable from the /user/api-readList request | |
status | string (uuid) | A unique uuid key for a document status | |
currency | string (uuid) | A unique identifier for the Currency, obtainable from the /currency/api-readList request | |
rate | number | Currency exchange rate for the document | |
contract | string (uuid) | The unique identifier for the counterparty’s contract, specified in the buyer key. You can retrieve this UUID using the /contract/api-readList request | |
expenseItem | string (uuid) | A unique identifier for the Expense Item, obtainable from the /expenseItems/api-readList request | |
mutualSettlementType | string (uuid) | A unique uuid key for a mutual settlement type | |
counterpartyBankAccount | string (uuid) | A unique uuid key for the counterparty bank account | |
cashPaymentType | number | Cash payment type code |
Response: data field
| Field | Type | Description |
|---|---|---|
uuid | string (uuid) |
curl -X POST 'https://app.bimpsoft.com/org2/loanRepayment/api-update' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"uuid":"00000000-0000-0000-0000-000000000000"}'Interactive documentation with a test request option: https://app.bimpsoft.com/docs. The OpenAPI specification is updated together with Bimp; this page is generated from it automatically.