[POST] .../v1/partnerbalance/getinbasecurrency
Returns information about reconciliation statements with partners. Use this method to build a partner reconciliation statement converted to the account base currency for a selected period. The response returns performed partner balance rows ordered by date, including opening amount, debit, credit, firm and translated document type; debit and credit are calculated through the stored exchange rate. The request body is required and start_date, end_date and partner_id are mandatory; date, partner_id and firm_id can be supplied through filters. The current request user must have partner reconciliation select permission. Missing body, invalid dates, invalid partner_id, denied access, translation lookup failures, database failures and balance storage errors are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| date | int | |
| end_date | int | Period end date as Unix time in seconds. |
| firm_id | int | Firm ID. |
| partner_id | int | Partner ID. |
| start_date | int | Period start date as Unix time in seconds. |
Request Example
{
"filters": [
{
"Field": "date",
"Operator": "GreaterOrEqual",
"Value": "1711929600"
},
{
"Field": "date",
"Operator": "LessOrEqual",
"Value": "1714521600"
},
{
"Field": "partner_id",
"Operator": "Equal",
"Value": "15"
},
{
"Field": "firm_id",
"Operator": "Equal",
"Value": "2"
}
]
}
Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of PartnerBalanceBase | Result array. |
Response Example
{
"ok": true,
"result": [
{
"id": 3001,
"date": 1714550400,
"document_code": "PMT-000042",
"document_id": 42,
"start_amount": 0.000,
"debit": 2500000.000,
"credit": 0.000,
"firm": {
"id": 2,
"name": "REGOS Retail"
},
"document_type": {
"id": 5,
"name": "Payment",
"last_update": 1714550400
}
}
]
}