POST api/v1/transactions/summary
Request Information
URI Parameters
None.
Body Parameters
SearchTransaction| Name | Description | Type | Additional information |
|---|---|---|---|
| date_from | date |
Required |
|
| date_to | date |
None. |
|
| id_establishment | integer |
None. |
|
| is_home | boolean |
None. |
|
| is_public | boolean |
None. |
|
| is_internal | boolean |
None. |
|
| is_card | boolean |
None. |
|
| is_app | boolean |
None. |
|
| points | Collection of integer |
None. |
|
| chargee_ids | Collection of integer |
None. |
|
| authorization | integer |
None. |
|
| establishment.id | integer |
None. |
|
| fulltext | string |
None. |
|
| filter | string |
None. |
|
| password | string |
None. |
|
| establishment.id | string |
None. |
|
| state.id | string |
None. |
|
| fields | Collection of string |
None. |
|
| page | integer |
None. |
|
| id | integer |
None. |
|
| deleted | boolean |
None. |
|
| per_page | integer |
None. |
|
| view_mode | integer |
None. |
|
| sort_fields | string |
None. |
|
| stop_top | boolean |
None. |
|
| tmp | boolean |
None. |
|
| columns | Collection of TitleName |
None. |
|
| time_from | date |
None. |
|
| time_to | date |
None. |
|
| charge_point_ids | Collection of string |
None. |
|
| connector_id | string |
None. |
|
| sort_fields_desc | string |
None. |
|
| disable_count | boolean |
None. |
|
| view_name | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"date_from": "2026-02-08T14:08:55Z",
"date_to": "2026-02-08T14:08:55Z",
"id_establishment": 3,
"is_home": true,
"is_public": true,
"is_internal": true,
"is_card": true,
"is_app": true,
"points": [
1,
2
],
"chargee_ids": [
1,
2
],
"authorization": 9,
"establishment.id": 1,
"fulltext": "sample string 10",
"filter": "sample string 11",
"password": "sample string 12",
"state.id": "sample string 14",
"fields": [
"sample string 1",
"sample string 2"
],
"page": 1,
"id": 15,
"deleted": true,
"per_page": 1,
"view_mode": 1,
"sort_fields": "sample string 16",
"stop_top": true,
"tmp": true,
"columns": [
{
"title": "sample string 1",
"name": "sample string 2",
"width": 1
},
{
"title": "sample string 1",
"name": "sample string 2",
"width": 1
}
],
"time_from": "2026-02-08T14:08:55Z",
"time_to": "2026-02-08T14:08:55Z",
"charge_point_ids": [
"sample string 1",
"sample string 2"
],
"connector_id": "sample string 21",
"sort_fields_desc": "sample string 22",
"disable_count": true,
"view_name": "sample string 24"
}
application/xml, text/xml
Sample:
<SearchTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
<charge_point_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</charge_point_ids>
<columns xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">
<TitleName>
<name>sample string 2</name>
<title>sample string 1</title>
<width>1</width>
</TitleName>
<TitleName>
<name>sample string 2</name>
<title>sample string 1</title>
<width>1</width>
</TitleName>
</columns>
<connector_id xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 21</connector_id>
<date_from i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data" />
<date_to i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data" />
<deleted xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">true</deleted>
<disable_count xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">true</disable_count>
<establishment.id xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 13</establishment.id>
<fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</fields>
<filter xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 11</filter>
<fulltext xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 10</fulltext>
<id xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">15</id>
<page xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">1</page>
<password xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 12</password>
<per_page xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">1</per_page>
<sort_fields xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 16</sort_fields>
<sort_fields_desc xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 22</sort_fields_desc>
<state.id xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 14</state.id>
<stop_top xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">true</stop_top>
<time_from xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">2026-02-08T15:08:55.7820347+01:00</time_from>
<time_to xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">2026-02-08T15:08:55.7820347+01:00</time_to>
<tmp xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">true</tmp>
<view_mode xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">1</view_mode>
<view_name xmlns="http://schemas.datacontract.org/2004/07/Up.Core.Data">sample string 24</view_name>
<authorization>9</authorization>
<chargee_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</chargee_ids>
<date_from>2026-02-08T15:08:55.7820347+01:00</date_from>
<date_to>2026-02-08T15:08:55.7820347+01:00</date_to>
<establishment.id>1</establishment.id>
<id_establishment>3</id_establishment>
<is_app>true</is_app>
<is_card>true</is_card>
<is_home>true</is_home>
<is_internal>true</is_internal>
<is_public>true</is_public>
<points xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</points>
</SearchTransaction>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ReportSummary| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
None. |
|
| number_of_transaction | integer |
None. |
|
| total_amount_of_transaction | decimal number |
None. |
|
| local_number_of_transaction | integer |
None. |
|
| remote_total_amount_of_transaction_internal | decimal number |
None. |
|
| remote_total_amount_of_transaction_public | decimal number |
None. |
|
| remote_total_amount_of_transaction_home | decimal number |
None. |
|
| local_total_amount_of_transaction | decimal number |
None. |
|
| public_number_of_transaction | integer |
None. |
|
| home_number_of_transaction | integer |
None. |
|
| public_total_amount_of_transaction | decimal number |
None. |
|
| remote_total_number_of_transaction | integer |
None. |
|
| home_total_amount_of_transaction | decimal number |
None. |
|
| card_number_of_transaction | integer |
None. |
|
| card_total_amount_of_transaction_internal | decimal number |
None. |
|
| card_total_amount_of_transaction_public | decimal number |
None. |
|
| card_total_amount_of_transaction_home | decimal number |
None. |
|
| transactions | Collection of decimal number |
None. |
|
| local_transactions | Collection of decimal number |
None. |
|
| public_transactions | Collection of decimal number |
None. |
|
| home_transactions | Collection of decimal number |
None. |
|
| card_transactions_internal | Collection of decimal number |
None. |
|
| remote_transactions_internal | Collection of decimal number |
None. |
|
| card_transactions_public | Collection of decimal number |
None. |
|
| card_transactions_home | Collection of decimal number |
None. |
|
| remote_transactions_public | Collection of decimal number |
None. |
|
| remote_transactions_home | Collection of decimal number |
None. |
|
| labels | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"number_of_transaction": 2,
"total_amount_of_transaction": 3.0,
"local_number_of_transaction": 4,
"remote_total_amount_of_transaction_internal": 5.0,
"remote_total_amount_of_transaction_public": 6.0,
"remote_total_amount_of_transaction_home": 7.0,
"local_total_amount_of_transaction": 8.0,
"public_number_of_transaction": 9,
"home_number_of_transaction": 10,
"public_total_amount_of_transaction": 11.0,
"remote_total_number_of_transaction": 12,
"home_total_amount_of_transaction": 13.0,
"card_number_of_transaction": 14,
"card_total_amount_of_transaction_internal": 15.0,
"card_total_amount_of_transaction_public": 16.0,
"card_total_amount_of_transaction_home": 17.0,
"transactions": [
1.0,
2.0
],
"local_transactions": [
1.0,
2.0
],
"public_transactions": [
1.0,
2.0
],
"home_transactions": [
1.0,
2.0
],
"card_transactions_internal": [
1.0,
2.0
],
"remote_transactions_internal": [
1.0,
2.0
],
"card_transactions_public": [
1.0,
2.0
],
"card_transactions_home": [
1.0,
2.0
],
"remote_transactions_public": [
1.0,
2.0
],
"remote_transactions_home": [
1.0,
2.0
],
"labels": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<ReportSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
<card_number_of_transaction>14</card_number_of_transaction>
<card_total_amount_of_transaction_home>17</card_total_amount_of_transaction_home>
<card_total_amount_of_transaction_internal>15</card_total_amount_of_transaction_internal>
<card_total_amount_of_transaction_public>16</card_total_amount_of_transaction_public>
<card_transactions_home xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</card_transactions_home>
<card_transactions_internal xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</card_transactions_internal>
<card_transactions_public xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</card_transactions_public>
<home_number_of_transaction>10</home_number_of_transaction>
<home_total_amount_of_transaction>13</home_total_amount_of_transaction>
<home_transactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</home_transactions>
<id>1</id>
<labels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</labels>
<local_number_of_transaction>4</local_number_of_transaction>
<local_total_amount_of_transaction>8</local_total_amount_of_transaction>
<local_transactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</local_transactions>
<number_of_transaction>2</number_of_transaction>
<public_number_of_transaction>9</public_number_of_transaction>
<public_total_amount_of_transaction>11</public_total_amount_of_transaction>
<public_transactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</public_transactions>
<remote_total_amount_of_transaction_home>7</remote_total_amount_of_transaction_home>
<remote_total_amount_of_transaction_internal>5</remote_total_amount_of_transaction_internal>
<remote_total_amount_of_transaction_public>6</remote_total_amount_of_transaction_public>
<remote_total_number_of_transaction>12</remote_total_number_of_transaction>
<remote_transactions_home xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</remote_transactions_home>
<remote_transactions_internal xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</remote_transactions_internal>
<remote_transactions_public xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</remote_transactions_public>
<total_amount_of_transaction>3</total_amount_of_transaction>
<transactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>2</d2p1:decimal>
</transactions>
</ReportSummary>