action apideck_ledger_accounts_all { label: "List Ledger Accounts" description: "List Ledger Accounts" provider: apideck method: GET path: "/accounting/ledger-accounts" encoding: json input: { type: "object" properties: { cursor: { type: "string" } fields: { type: "string" } limit: { type: "integer" } pass_through: { type: "object" properties: { example_downstream_property: { type: "string" description: "All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)" } } } raw: { type: "boolean" } "x-apideck-app-id": { type: "string" } "x-apideck-consumer-id": { type: "string" } "x-apideck-service-id": { type: "string" } } required: ["x-apideck-app-id", "x-apideck-consumer-id"] additionalProperties: false } output: { type: "object" required: ["data", "operation", "resource", "service", "status", "status_code"] properties: { data: { type: "array" items: { type: "object" properties: { active: { type: "boolean" description: "Whether the account is active or not." } bank_account: { type: "object" properties: { account_name: { type: "string" description: "The name which you used in opening your bank account." } account_number: { type: "string" description: "A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number." } account_type: { type: "string" description: "The type of bank account." enum: ["bank_account", "credit_card", "other"] } bank_code: { type: "string" description: "A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions." } bic: { type: "string" } branch_identifier: { type: "string" description: "A branch identifier is a unique identifier for a branch of a bank or financial institution." } bsb_number: { type: "string" description: "A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution." } currency: { type: "string" description: "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)." enum: ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "ETH"] } iban: { type: "string" } } additionalProperties: false } categories: { type: "array" description: "The categories of the account." items: { type: "object" properties: { id: { type: "string" } name: { type: "string" description: "The name of the category." } } } } classification: { type: "string" description: "The classification of account." enum: ["asset", "equity", "expense", "liability", "revenue", "income", "other_income", "other_expense", "costs_of_sales"] } code: { type: "string" description: "The code assigned to the account." } created_at: { type: "string" format: "date-time" description: "The date and time when the object was created." } created_by: { type: "string" description: "The user who created the object." } currency: { type: "string" description: "Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)." enum: ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", "ETH"] } current_balance: { type: "number" description: "The current balance of the account." } description: { type: "string" description: "The description of the account." } display_id: { type: "string" description: "The human readable display ID used when displaying the account" } fully_qualified_name: { type: "string" description: "The fully qualified name of the account." } header: { type: "boolean" description: "Whether the account is a header or not." } id: { type: "string" description: "A unique identifier for an object." } last_reconciliation_date: { type: "string" format: "date" description: "Reconciliation Date means the last calendar day of each Reconciliation Period." } level: { type: "number" } name: { type: "string" description: "The name of the account." } nominal_code: { type: "string" description: "The nominal code of the ledger account." } opening_balance: { type: "number" description: "The opening balance of the account." } parent_account: { type: "object" properties: { display_id: { type: "string" description: "The human readable display ID used when displaying the parent account" } id: { type: "string" description: "The ID of the parent account." } name: { type: "string" description: "The name of the parent account." } } } row_version: { type: "string" description: "A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object." } status: { type: "string" description: "The status of the account." enum: ["active", "inactive", "archived"] } sub_account: { type: "boolean" description: "Whether the account is a sub account or not." } sub_accounts: { type: "array" description: "The sub accounts of the account." items: { properties: { account_sub_name: { type: "string" description: "The name of the sub account." } id: { type: "string" description: "The ID of the sub account." } } } } sub_type: { type: "string" description: "The sub type of account." } tax_rate: { type: "object" properties: { code: { type: "string" description: "Tax rate code" } id: { type: "string" description: "The ID of the object." } name: { type: "string" description: "Name of the tax rate" } rate: { type: "number" description: "Rate of the tax rate" } } } tax_type: { type: "string" description: "The tax type of the account." } type: { type: "string" description: "The type of account." enum: ["accounts_receivable", "revenue", "sales", "other_income", "bank", "current_asset", "fixed_asset", "non_current_asset", "other_asset", "balancesheet", "equity", "expense", "other_expense", "costs_of_sales", "accounts_payable", "credit_card", "current_liability", "non_current_liability", "other_liability"] } updated_at: { type: "string" format: "date-time" description: "The date and time when the object was last updated." } updated_by: { type: "string" description: "The user who last updated the object." } } } } links: { type: "object" description: "Links to navigate to previous or next pages through the API" properties: { current: { type: "string" description: "Link to navigate to the current page through the API" } next: { type: "string" description: "Link to navigate to the previous page through the API" } previous: { type: "string" description: "Link to navigate to the previous page through the API" } } } meta: { type: "object" description: "Response metadata" properties: { cursors: { type: "object" description: "Cursors to navigate to previous or next pages through the API" properties: { current: { type: "string" description: "Cursor to navigate to the current page of results through the API" } next: { type: "string" description: "Cursor to navigate to the next page of results through the API" } previous: { type: "string" description: "Cursor to navigate to the previous page of results through the API" } } } items_on_page: { type: "integer" description: "Number of items returned in the data property of the response" } } } operation: { type: "string" description: "Operation performed" } resource: { type: "string" description: "Unified API resource name" } service: { type: "string" description: "Apideck ID of service provider" } status: { type: "string" description: "HTTP Response Status" } status_code: { type: "integer" description: "HTTP Response Status Code" } } } }