APapaleo
SubLedger

Aggregates transactions by timestamp for all accounts and a given period.

Returns credited and debited amounts aggregated by transactions' timestamp for all accounts and a given period. Stores an entry in the export audit log.<br>You must have at least one of these scopes: 'subledger.read, accounting.read'.<br>For fine-grained clients, you must have this permission: 'core.subledger_aggregate.create'.

post/finance/v0-nsfw/accounts/aggregate

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/finance/v0-nsfw/accounts/aggregate
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: subledger.read, accounting.read, admin

Query parameters

propertyIdstring required

Specifies the property for which transactions will be exported

fromstring date-time required

The inclusive start time of the posting date. Either posting date or business date interval should be specified.<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time required

The exclusive end time of the posting date. Either posting date or business date interval should be specified.<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

accountNumberstring

Filter transactions by account number

accountType'Revenues' | 'Payments' | 'Liabilities' | 'Receivables' | 'Vat' | 'House' | 'AccountsReceivable' | 'CityTaxes' | 'TransitoryItems' | 'VatOnLiabilities' | 'LossOfAccountsReceivable' | 'SecondCityTax' | 'GuestLevies'

Filter transactions by type

accountingSchema'Simple' | 'Extended'

Allows to override the default accounting schema. Only specify this, when you know what you are doing.

languageCodestring

The language for the the report

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Response

Success.

Example response

{
  "aggregations": [
    {
      "account": {
        "name": "Payments",
        "number": "1000",
        "type": "Payments"
      },
      "creditedAmount": {
        "amount": 202,
        "currency": "EUR"
      },
      "debitedAmount": {
        "amount": 170,
        "currency": "EUR"
      },
      "balance": {
        "amount": -32,
        "currency": "EUR"
      }
    },
    {
      "account": {
        "name": "Revenues",
        "number": "5000",
        "type": "Revenues"
      },
      "creditedAmount": {
        "amount": 233,
        "currency": "EUR"
      },
      "debitedAmount": {
        "amount": 265,
        "currency": "EUR"
      },
      "balance": {
        "amount": 32,
        "currency": "EUR"
      }
    }
  ],
  "total": {
    "creditedAmount": {
      "amount": 435,
      "currency": "EUR"
    },
    "debitedAmount": {
      "amount": 435,
      "currency": "EUR"
    },
    "balance": {
      "amount": 0,
      "currency": "EUR"
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.