Skip to main content
GuidesAPI Reference

Create Account

POST 
/accounting/accounts

Create an Account.

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    accountName stringrequired

    The unique name or title used to identify the account.

    accountType stringrequired

    Specifies the kind of account. Possible values: BANK, OTHER_CURRENT_ASSET, FIXED_ASSET, OTHER_ASSET, ACCOUNTS_RECEIVABLE, EQUITY, EXPENSE, OTHER_EXPENSE, COST_OF_GOODS_SOLD, ACCOUNTS_PAYABLE, CREDIT_CARD, LONG_TERM_LIABILITY, OTHER_CURRENT_LIABILITY, INCOME, OTHER_INCOME

    accountDescription string

    A brief overview or explanation detailing the purpose or nature of the account.

    classification string

    The category or grouping to which the account belongs, aiding in organizing and analyzing accounts. Possible values: ASSET, EQUITY, EXPENSE, LIABILITY, REVENUE

    currentBalance string

    The present amount or value held in the account.

    currency string

    The type of currency used for transactions and balances in the account. Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, 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, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, 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, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

    accountStatus string

    The current state of the account. Possible values: ACTIVE, INACTIVE

    accountNumber string

    A unique identifier or code assigned to the account for reference and transactions.

    parentAccountId string

    ID of the parent Account.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    account

    object

    remoteId string
    accountName string
    accountDescription
    classification string
    accountType string
    accountStatus string
    currentBalance
    currency string
    accountNumber
    parentAccountId
    companyId
    id string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...