Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB
Ledger Accounts

Create Ledger Account

Create Ledger Account

post/accounting/ledger-accounts

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Request body

idstring

A unique identifier for an object.

display_idstring

The human readable display ID used when displaying the account

nominal_codestring nullable

The nominal code of the ledger account.

codestring nullable

The code assigned to the account.

classification'asset' | 'equity' | 'expense' | 'liability' | 'revenue' | 'income' | 'other_income' | 'other_expense' | 'costs_of_sales' | 'other' nullable

The classification of account.

type'accounts_payable' | 'accounts_receivable' | 'balancesheet' | 'bank' | 'costs_of_sales' | 'credit_card' | 'current_asset' | 'current_liability' | 'equity' | 'expense' | 'fixed_asset' | 'non_current_asset' | 'non_current_liability' | 'other_asset' | 'other_expense' | 'other_income' | 'other_liability' | 'revenue' | 'sales' | 'other'

The type of account.

sub_typestring nullable

The sub type of account.

namestring nullable

The name of the account.

fully_qualified_namestring nullable

The fully qualified name of the account.

descriptionstring nullable

The description of the account.

opening_balancenumber nullable

The opening balance of the account.

current_balancenumber nullable

The current balance of the account.

currency'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' nullable

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

tax_typestring nullable

The tax type of the account.

levelnumber nullable
activeboolean nullable

Whether the account is active or not.

status'active' | 'inactive' | 'archived' nullable

The status of the account.

headerboolean nullable

Whether the account is a header or not.

sub_accountboolean nullable

Whether the account is a sub account or not.

last_reconciliation_datestring date nullable

Reconciliation Date means the last calendar day of each Reconciliation Period.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

row_versionstring nullable

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.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "display_id": "1-12345",
  "nominal_code": "N091",
  "code": "453",
  "classification": "asset",
  "type": "bank",
  "sub_type": "CHECKING_ACCOUNT",
  "name": "Bank account",
  "fully_qualified_name": "Asset.Bank.Checking_Account",
  "description": "Main checking account",
  "opening_balance": 75000,
  "current_balance": 20000,
  "currency": "USD",
  "tax_type": "NONE",
  "tax_rate": {
    "id": "123456",
    "code": "N-T",
    "name": "GST on Purchases",
    "rate": 10
  },
  "level": 1,
  "active": true,
  "status": "active",
  "header": true,
  "bank_account": {
    "bank_name": "Chase Bank",
    "account_number": "123465",
    "account_name": "Main Operating Account",
    "account_type": "credit_card",
    "iban": "GB33BUKB20201555555555",
    "bic": "CHASUS33",
    "routing_number": "021000021",
    "bsb_number": "062-001",
    "branch_identifier": "001",
    "bank_code": "BNH",
    "currency": "USD",
    "country": "US"
  },
  "categories": [
    {
      "id": "12345",
      "name": "Finance Charges Expense"
    }
  ],
  "parent_account": {
    "id": "12345",
    "name": "Bank Accounts",
    "display_id": "1-1100"
  },
  "sub_accounts": [
    {
      "id": "12345",
      "account_sub_name": "Petty Cash"
    }
  ],
  "last_reconciliation_date": "2020-09-30",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "row_version": "1-12345",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

LedgerAccount created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "xero",
  "resource": "ledger-accounts",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}