GET banking/balance?from={from}&to={to}&date={date}&account={account}&currency={currency}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
from

date

None.

to

date

None.

date

date

None.

account

integer

None.

currency

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Balance
NameDescriptionTypeAdditional information
Bank

string

None.

BankID

integer

None.

AccountID

integer

None.

Account

CompanyAccount

None.

CurrencyID

integer

None.

Currency

Currency

None.

Date

date

None.

In

decimal number

None.

Out

decimal number

None.

Available

decimal number

None.

Reserved

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Bank": "sample string 1",
    "BankID": 2,
    "AccountID": 3,
    "Account": {
      "ID": 1,
      "OrganizationalUnitID": 1,
      "LookupText": "sample string 5",
      "Settings": [
        {
          "ID": 1,
          "AccountID": 2,
          "CurrencyID": 1,
          "LinkDocument_CategoryID": 1,
          "COA": "sample string 3",
          "Description": "sample string 4",
          "AutomaticFetching": true
        },
        {
          "ID": 1,
          "AccountID": 2,
          "CurrencyID": 1,
          "LinkDocument_CategoryID": 1,
          "COA": "sample string 3",
          "Description": "sample string 4",
          "AutomaticFetching": true
        }
      ],
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-26T23:20:39.0044537+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-26T23:20:39.0044537+00:00"
      },
      "CountryID": 3,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2024-04-26T23:20:39.0044537+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-26T23:20:39.0044537+00:00"
        }
      },
      "BankID": 4,
      "Bank": {
        "ID": 1,
        "CountryID": 2,
        "Name": "sample string 3",
        "Code": "sample string 4",
        "NBC": "sample string 5",
        "SWIFT": "sample string 6",
        "BankingUrl": "sample string 7"
      },
      "BBAN": "sample string 5",
      "IBAN": "sample string 6",
      "Closed": "2024-04-26T23:20:39.0044537+00:00"
    },
    "CurrencyID": 4,
    "Currency": {
      "ID": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Sign": "sample string 4",
      "Lookup": "sample string 5"
    },
    "Date": "2024-04-26T23:20:39.0044537+00:00",
    "In": 6.0,
    "Out": 7.0,
    "Available": 8.0,
    "Reserved": 9.0
  },
  {
    "Bank": "sample string 1",
    "BankID": 2,
    "AccountID": 3,
    "Account": {
      "ID": 1,
      "OrganizationalUnitID": 1,
      "LookupText": "sample string 5",
      "Settings": [
        {
          "ID": 1,
          "AccountID": 2,
          "CurrencyID": 1,
          "LinkDocument_CategoryID": 1,
          "COA": "sample string 3",
          "Description": "sample string 4",
          "AutomaticFetching": true
        },
        {
          "ID": 1,
          "AccountID": 2,
          "CurrencyID": 1,
          "LinkDocument_CategoryID": 1,
          "COA": "sample string 3",
          "Description": "sample string 4",
          "AutomaticFetching": true
        }
      ],
      "Audit": {
        "AddUser": 1,
        "AddTime": "2024-04-26T23:20:39.0044537+00:00",
        "EditUser": 1,
        "EditTime": "2024-04-26T23:20:39.0044537+00:00"
      },
      "CountryID": 3,
      "Country": {
        "ID": 1,
        "Name": "sample string 2",
        "CurrencyID": 1,
        "Currency": {
          "ID": 1,
          "Code": "sample string 2",
          "Name": "sample string 3",
          "Sign": "sample string 4",
          "Lookup": "sample string 5"
        },
        "ISO31661": 1,
        "Alpha2": "sample string 3",
        "Alpha3": "sample string 4",
        "Audit": {
          "AddUser": 1,
          "AddTime": "2024-04-26T23:20:39.0044537+00:00",
          "EditUser": 1,
          "EditTime": "2024-04-26T23:20:39.0044537+00:00"
        }
      },
      "BankID": 4,
      "Bank": {
        "ID": 1,
        "CountryID": 2,
        "Name": "sample string 3",
        "Code": "sample string 4",
        "NBC": "sample string 5",
        "SWIFT": "sample string 6",
        "BankingUrl": "sample string 7"
      },
      "BBAN": "sample string 5",
      "IBAN": "sample string 6",
      "Closed": "2024-04-26T23:20:39.0044537+00:00"
    },
    "CurrencyID": 4,
    "Currency": {
      "ID": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Sign": "sample string 4",
      "Lookup": "sample string 5"
    },
    "Date": "2024-04-26T23:20:39.0044537+00:00",
    "In": 6.0,
    "Out": 7.0,
    "Available": 8.0,
    "Reserved": 9.0
  }
]

text/xml

Sample:
<ArrayOfBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Banking">
  <Balance>
    <Account>
      <BBAN>sample string 5</BBAN>
      <Bank>
        <BankingUrl>sample string 7</BankingUrl>
        <Code>sample string 4</Code>
        <CountryID>2</CountryID>
        <ID>1</ID>
        <NBC>sample string 5</NBC>
        <Name>sample string 3</Name>
        <SWIFT>sample string 6</SWIFT>
      </Bank>
      <BankID>4</BankID>
      <Closed>2024-04-26T23:20:39.0044537+00:00</Closed>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:Alpha2>sample string 3</d4p1:Alpha2>
        <d4p1:Alpha3>sample string 4</d4p1:Alpha3>
        <d4p1:Audit xmlns:d5p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
          <d5p1:AddTime>2024-04-26T23:20:39.0044537+00:00</d5p1:AddTime>
          <d5p1:AddUser>1</d5p1:AddUser>
          <d5p1:EditTime>2024-04-26T23:20:39.0044537+00:00</d5p1:EditTime>
          <d5p1:EditUser>1</d5p1:EditUser>
        </d4p1:Audit>
        <d4p1:Currency>
          <d4p1:Code>sample string 2</d4p1:Code>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Lookup>sample string 5</d4p1:Lookup>
          <d4p1:Name>sample string 3</d4p1:Name>
          <d4p1:Sign>sample string 4</d4p1:Sign>
        </d4p1:Currency>
        <d4p1:CurrencyID>1</d4p1:CurrencyID>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:ISO31661>1</d4p1:ISO31661>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <CountryID>3</CountryID>
      <IBAN>sample string 6</IBAN>
      <Audit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:AddTime>2024-04-26T23:20:39.0044537+00:00</d4p1:AddTime>
        <d4p1:AddUser>1</d4p1:AddUser>
        <d4p1:EditTime>2024-04-26T23:20:39.0044537+00:00</d4p1:EditTime>
        <d4p1:EditUser>1</d4p1:EditUser>
      </Audit>
      <ID>1</ID>
      <LookupText>sample string 5</LookupText>
      <OrganizationalUnitID>1</OrganizationalUnitID>
      <Settings>
        <CompanyAccountSetting>
          <AccountID>2</AccountID>
          <AutomaticFetching>true</AutomaticFetching>
          <COA>sample string 3</COA>
          <CurrencyID>1</CurrencyID>
          <Description>sample string 4</Description>
          <ID>1</ID>
          <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
        </CompanyAccountSetting>
        <CompanyAccountSetting>
          <AccountID>2</AccountID>
          <AutomaticFetching>true</AutomaticFetching>
          <COA>sample string 3</COA>
          <CurrencyID>1</CurrencyID>
          <Description>sample string 4</Description>
          <ID>1</ID>
          <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
        </CompanyAccountSetting>
      </Settings>
    </Account>
    <AccountID>3</AccountID>
    <Available>8</Available>
    <Bank>sample string 1</Bank>
    <BankID>2</BankID>
    <Currency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Lookup>sample string 5</d3p1:Lookup>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:Sign>sample string 4</d3p1:Sign>
    </Currency>
    <CurrencyID>4</CurrencyID>
    <Date>2024-04-26T23:20:39.0044537+00:00</Date>
    <In>6</In>
    <Out>7</Out>
    <Reserved>9</Reserved>
  </Balance>
  <Balance>
    <Account>
      <BBAN>sample string 5</BBAN>
      <Bank>
        <BankingUrl>sample string 7</BankingUrl>
        <Code>sample string 4</Code>
        <CountryID>2</CountryID>
        <ID>1</ID>
        <NBC>sample string 5</NBC>
        <Name>sample string 3</Name>
        <SWIFT>sample string 6</SWIFT>
      </Bank>
      <BankID>4</BankID>
      <Closed>2024-04-26T23:20:39.0044537+00:00</Closed>
      <Country xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
        <d4p1:Alpha2>sample string 3</d4p1:Alpha2>
        <d4p1:Alpha3>sample string 4</d4p1:Alpha3>
        <d4p1:Audit xmlns:d5p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
          <d5p1:AddTime>2024-04-26T23:20:39.0044537+00:00</d5p1:AddTime>
          <d5p1:AddUser>1</d5p1:AddUser>
          <d5p1:EditTime>2024-04-26T23:20:39.0044537+00:00</d5p1:EditTime>
          <d5p1:EditUser>1</d5p1:EditUser>
        </d4p1:Audit>
        <d4p1:Currency>
          <d4p1:Code>sample string 2</d4p1:Code>
          <d4p1:ID>1</d4p1:ID>
          <d4p1:Lookup>sample string 5</d4p1:Lookup>
          <d4p1:Name>sample string 3</d4p1:Name>
          <d4p1:Sign>sample string 4</d4p1:Sign>
        </d4p1:Currency>
        <d4p1:CurrencyID>1</d4p1:CurrencyID>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:ISO31661>1</d4p1:ISO31661>
        <d4p1:Name>sample string 2</d4p1:Name>
      </Country>
      <CountryID>3</CountryID>
      <IBAN>sample string 6</IBAN>
      <Audit xmlns:d4p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO">
        <d4p1:AddTime>2024-04-26T23:20:39.0044537+00:00</d4p1:AddTime>
        <d4p1:AddUser>1</d4p1:AddUser>
        <d4p1:EditTime>2024-04-26T23:20:39.0044537+00:00</d4p1:EditTime>
        <d4p1:EditUser>1</d4p1:EditUser>
      </Audit>
      <ID>1</ID>
      <LookupText>sample string 5</LookupText>
      <OrganizationalUnitID>1</OrganizationalUnitID>
      <Settings>
        <CompanyAccountSetting>
          <AccountID>2</AccountID>
          <AutomaticFetching>true</AutomaticFetching>
          <COA>sample string 3</COA>
          <CurrencyID>1</CurrencyID>
          <Description>sample string 4</Description>
          <ID>1</ID>
          <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
        </CompanyAccountSetting>
        <CompanyAccountSetting>
          <AccountID>2</AccountID>
          <AutomaticFetching>true</AutomaticFetching>
          <COA>sample string 3</COA>
          <CurrencyID>1</CurrencyID>
          <Description>sample string 4</Description>
          <ID>1</ID>
          <LinkDocument_CategoryID>1</LinkDocument_CategoryID>
        </CompanyAccountSetting>
      </Settings>
    </Account>
    <AccountID>3</AccountID>
    <Available>8</Available>
    <Bank>sample string 1</Bank>
    <BankID>2</BankID>
    <Currency xmlns:d3p1="http://schemas.datacontract.org/2004/07/Pixfin.DTO.Common">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:ID>1</d3p1:ID>
      <d3p1:Lookup>sample string 5</d3p1:Lookup>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:Sign>sample string 4</d3p1:Sign>
    </Currency>
    <CurrencyID>4</CurrencyID>
    <Date>2024-04-26T23:20:39.0044537+00:00</Date>
    <In>6</In>
    <Out>7</Out>
    <Reserved>9</Reserved>
  </Balance>
</ArrayOfBalance>