General Ledger

Get general ledger

get/accounting/generalLedger

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/generalLedger
  • Auth: OAuth 2 (authorization code, authorization URL https://secure.clearbooks.co.uk/account/action/oauth/, token URL https://api.clearbooks.co.uk/oauth/token, scopes: accounting.transactions:read)

Query parameters

transactionIdinteger

Filter by this transaction ID

accountCodeIdinteger

Filter by this account code ID

accountingDateFromstring date

Return results from this accounting date. Date format 'YYYY-MM-DD'

accountingDateTostring date

Return results to this accounting date. Date format 'YYYY-MM-DD'

sortBy'transactionId' | 'accountingDate' | 'accountCodeId' | 'amount'

The field to sort results by. Default value 'transactionId'

sortDirection'ascending' | 'descending'

The direction to sort the results

limitinteger

The number of results to return

pageinteger

The page of results to return

Headers

X-Business-IDinteger

ID of the business to use (required for multi-business authorisations only)

Response

An array of general ledger lines

transactionIdinteger
accountingDatestring date
accountCodeIdinteger
amountnumber float

Changes

No recorded changes to this operation across all 1 revision of this API.