An Account
represents a category in a company’s ledger in which a financial transaction is recorded against. The aggregation of each Account
object is often referred to as the Chart of Accounts.
An Account
can be classified into one of the following categories, determined through the classification
field:
- Asset: Accounts Receivable and Bank Accounts
- Liability: Accounts Payable and Credit Card Accounts
- Equity: Treasury Accounts and Retained Earnings
- Revenue: Income and Other Income
- Expense: Cost of Goods Sold and Office Expenses
id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)name
Stringdescription
Stringclassification
EnumASSET
, EQUITY
, EXPENSE
, LIABILITY
, REVENUE
. In cases where there is no clear mapping, the original value passed through will be returned.type
Stringstatus
EnumACTIVE
, PENDING
, INACTIVE
. In cases where there is no clear mapping, the original value passed through will be returned.current_balance
Numbercurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
. In cases where there is no clear mapping, the original value passed through will be returned.account_number
Stringparent_account
UUIDcompany
UUIDremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/accounting/v1/accounts
Returns a list of Account
objects.
company_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
StringSupported Response Fields
currency
Enumcurrent_balance
Numbername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringclassification
Enumdescription
Stringname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
StringSupported Response Fields
account_number
Stringcompany
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringcurrency
Enumname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcompany
UUIDcurrent_balance
Numbername
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
classification
Enumcurrent_balance
Numbername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
StringSupported Response Fields
account_number
Stringclassification
Enumcompany
UUIDname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
company
UUIDcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
Stringhttps://api.merge.dev/api/accounting/v1/accounts
Creates an Account
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectname
Stringdescription
Stringclassification
EnumASSET
, EQUITY
, EXPENSE
, LIABILITY
, REVENUE
.type
Stringstatus
EnumACTIVE
, PENDING
, INACTIVE
.current_balance
Numbercurrency
EnumXUA
, AFN
, AFA
, ALL
, ALK
, DZD
, ADP
, AOA
, AOK
, AON
, AOR
, ARA
, ARS
, ARM
, ARP
, ARL
, AMD
, AWG
, AUD
, ATS
, AZN
, AZM
, BSD
, BHD
, BDT
, BBD
, BYN
, BYB
, BYR
, BEF
, BEC
, BEL
, BZD
, BMD
, BTN
, BOB
, BOL
, BOV
, BOP
, BAM
, BAD
, BAN
, BWP
, BRC
, BRZ
, BRE
, BRR
, BRN
, BRB
, BRL
, GBP
, BND
, BGL
, BGN
, BGO
, BGM
, BUK
, BIF
, XPF
, KHR
, CAD
, CVE
, KYD
, XAF
, CLE
, CLP
, CLF
, CNX
, CNY
, CNH
, COP
, COU
, KMF
, CDF
, CRC
, HRD
, HRK
, CUC
, CUP
, CYP
, CZK
, CSK
, DKK
, DJF
, DOP
, NLG
, XCD
, DDM
, ECS
, ECV
, EGP
, GQE
, ERN
, EEK
, ETB
, EUR
, XBA
, XEU
, XBB
, XBC
, XBD
, FKP
, FJD
, FIM
, FRF
, XFO
, XFU
, GMD
, GEK
, GEL
, DEM
, GHS
, GHC
, GIP
, XAU
, GRD
, GTQ
, GWP
, GNF
, GNS
, GYD
, HTG
, HNL
, HKD
, HUF
, IMP
, ISK
, ISJ
, INR
, IDR
, IRR
, IQD
, IEP
, ILS
, ILP
, ILR
, ITL
, JMD
, JPY
, JOD
, KZT
, KES
, KWD
, KGS
, LAK
, LVL
, LVR
, LBP
, LSL
, LRD
, LYD
, LTL
, LTT
, LUL
, LUC
, LUF
, MOP
, MKD
, MKN
, MGA
, MGF
, MWK
, MYR
, MVR
, MVP
, MLF
, MTL
, MTP
, MRU
, MRO
, MUR
, MXV
, MXN
, MXP
, MDC
, MDL
, MCF
, MNT
, MAD
, MAF
, MZE
, MZN
, MZM
, MMK
, NAD
, NPR
, ANG
, TWD
, NZD
, NIO
, NIC
, NGN
, KPW
, NOK
, OMR
, PKR
, XPD
, PAB
, PGK
, PYG
, PEI
, PEN
, PES
, PHP
, XPT
, PLN
, PLZ
, PTE
, GWE
, QAR
, XRE
, RHD
, RON
, ROL
, RUB
, RUR
, RWF
, SVC
, WST
, SAR
, RSD
, CSD
, SCR
, SLL
, XAG
, SGD
, SKK
, SIT
, SBD
, SOS
, ZAR
, ZAL
, KRH
, KRW
, KRO
, SSP
, SUR
, ESP
, ESA
, ESB
, XDR
, LKR
, SHP
, XSU
, SDD
, SDG
, SDP
, SRD
, SRG
, SZL
, SEK
, CHF
, SYP
, STN
, STD
, TVD
, TJR
, TJS
, TZS
, XTS
, THB
, XXX
, TPE
, TOP
, TTD
, TND
, TRY
, TRL
, TMT
, TMM
, USD
, USN
, USS
, UGX
, UGS
, UAH
, UAK
, AED
, UYW
, UYU
, UYP
, UYI
, UZS
, VUV
, VES
, VEB
, VEF
, VND
, VNN
, CHE
, CHW
, XOF
, YDD
, YER
, YUN
, YUD
, YUM
, YUR
, ZWN
, ZRN
, ZRZ
, ZMW
, ZMK
, ZWD
, ZWR
, ZWL
.account_number
Stringparent_account
UUIDid
field in the Parent_account object.company
UUIDid
field in the Company object.integration_params
Objectlinked_account_params
ObjectSupported POST Model Parameters
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringparent_account
UUIDremote_id
Stringstatus
Enumtype
StringSupported POST Model Parameters
account_number
Stringclassification
Enumcurrency
Enumname
Stringremote_id
Stringstatus
Enumtype
Stringhttps://api.merge.dev/api/accounting/v1/accounts/{id}
Returns an Account
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
StringSupported Response Fields
currency
Enumcurrent_balance
Numbername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringclassification
Enumdescription
Stringname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
StringSupported Response Fields
account_number
Stringcompany
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
StringSupported Response Fields
account_number
Stringcurrency
Enumname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcompany
UUIDcurrent_balance
Numbername
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringparent_account
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
classification
Enumcurrent_balance
Numbername
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtype
StringSupported Response Fields
account_number
Stringclassification
Enumcompany
UUIDname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
account_number
Stringclassification
Enumcurrency
Enumdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
StringSupported Response Fields
company
UUIDcurrent_balance
Numberdescription
Stringname
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumtype
Stringhttps://api.merge.dev/api/accounting/v1/accounts/meta/post
Returns metadata for Account
POSTs.
Supported POST Model Parameters
account_number
Stringclassification
Enumcurrency
Enumcurrent_balance
Numberdescription
Stringname
Stringparent_account
UUIDremote_id
Stringstatus
Enumtype
StringSupported POST Model Parameters
account_number
Stringclassification
Enumcurrency
Enumname
Stringremote_id
Stringstatus
Enumtype
String