Codat Get Create Chartofaccounts Model Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-create-chartOfAccounts-model",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts",
"summary": "Get create account model",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Exact (Netherlands)",
"example": {
"type": "Object",
"displayName": "Nominal Account",
"description": "Nominal Accounts are the categories a business uses to record transactions",
"properties": {
"nominalCode": {
"type": "String",
"displayName": "Nominal Code",
"description": "The external reference given to each nominal account for a business",
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "NominalCode",
"details": "Must be provided."
}
]
}
},
"name": {
"type": "String",
"displayName": "Name",
"description": "Name of the account",
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Name",
"details": "Must be provided."
}
]
}
},
"fullyQualifiedCategory": {
"type": "String",
"displayName": "Fully Qualified Category",
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"options": [
{
"value": "Asset.Assets.Cash",
"type": "String",
"displayName": "Asset.Assets.Cash",
"required": false
},
{
"value": "Asset.Assets.Bank",
"type": "String",
"displayName": "Asset.Assets.Bank",
"required": false
},
{
"value": "Asset.Assets.PaymentServices",
"type": "String",
"displayName": "Asset.Assets.PaymentServices",
"required": false
},
{
"value": "Asset.Assets.AccountsReceivable",
"type": "String",
"displayName": "Asset.Assets.AccountsReceivable",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.AccountsPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.AccountsPayable",
"required": false
},
{
"value": "Asset.Assets.VAT",
"type": "String",
"displayName": "Asset.Assets.VAT",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.EmployeesPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.EmployeesPayable",
"required": false
},
{
"value": "Asset.Assets.PrepaidExpenses",
"type": "String",
"displayName": "Asset.Assets.PrepaidExpenses",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.AccruedExpenses",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.AccruedExpenses",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"required": false
},
{
"value": "Asset.Assets.FixedAssets",
"type": "String",
"displayName": "Asset.Assets.FixedAssets",
"required": false
},
{
"value": "Asset.Assets.OtherAssets",
"type": "String",
"displayName": "Asset.Assets.OtherAssets",
"required": false
},
{
"value": "Asset.Assets.AccumulatedDeprecation",
"type": "String",
"displayName": "Asset.Assets.AccumulatedDeprecation",
"required": false
},
{
"value": "Asset.Assets.Inventory",
"type": "String",
"displayName": "Asset.Assets.Inventory",
"required": false
},
{
"value": "Equity.EquityAndLiabilities.CapitalStock",
"type": "String",
"displayName": "Equity.EquityAndLiabilities.CapitalStock",
"required": false
},
{
"value": "Equity.EquityAndLiabilities.RetainedEarnings",
"type": "String",
"displayName": "Equity.EquityAndLiabilities.RetainedEarnings",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.LongTermDebt",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.LongTermDebt",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"required": false
},
{
"value": "Unknown.EquityAndLiabilities.Intercompany",
"type": "String",
"displayName": "Unknown.EquityAndLiabilities.Intercompany",
"required": false
},
{
"value": "Unknown.General.General",
"type": "String",
"displayName": "Unknown.General.General",
"required": false
},
{
"value": "Income.NetIncome.Revenue",
"type": "String",
"displayName": "Income.NetIncome.Revenue",
"required": false
},
{
"value": "Expense.NetIncome.CostOfGoods",
"type": "String",
"displayName": "Expense.NetIncome.CostOfGoods",
"required": false
},
{
"value": "Expense.NetIncome.OtherCosts",
"type": "String",
"displayName": "Expense.NetIncome.OtherCosts",
"required": false
},
{
"value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"type": "String",
"displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"required": false
},
{
"value": "Expense.NetIncome.DeprecationCosts",
"type": "String",
"displayName": "Expense.NetIncome.DeprecationCosts",
"required": false
},
{
"value": "Expense.NetIncome.ResearchAndDevelopment",
"type": "String",
"displayName": "Expense.NetIncome.ResearchAndDevelopment",
"required": false
},
{
"value": "Expense.NetIncome.EmployeeCosts",
"type": "String",
"displayName": "Expense.NetIncome.EmployeeCosts",
"required": false
},
{
"value": "Expense.NetIncome.EmploymentCosts",
"type": "String",
"displayName": "Expense.NetIncome.EmploymentCosts",
"required": false
},
{
"value": "Expense.ExceptionalIncome.ExceptionalCosts",
"type": "String",
"displayName": "Expense.ExceptionalIncome.ExceptionalCosts",
"required": false
},
{
"value": "Income.ExceptionalIncome.ExceptionalIncome",
"type": "String",
"displayName": "Income.ExceptionalIncome.ExceptionalIncome",
"required": false
},
{
"value": "Expense.ExceptionalIncome.IncomeTaxes",
"type": "String",
"displayName": "Expense.ExceptionalIncome.IncomeTaxes",
"required": false
},
{
"value": "Income.ExceptionalIncome.InterestIncome",
"type": "String",
"displayName": "Income.ExceptionalIncome.InterestIncome",
"required": false
}
],
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "FullyQualifiedCategory",
"details": "Must be provided."
}
]
}
},
"status": {
"type": "String",
"displayName": "Account Status",
"description": "The status of the account",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Pending",
"type": "String",
"displayName": "Pending",
"required": false
},
{
"value": "Unknown",
"type": "String",
"displayName": "Unknown",
"required": false
}
],
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Status",
"details": "Must be provided."
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Exact (UK)",
"example": {
"type": "Object",
"displayName": "Nominal Account",
"description": "Nominal Accounts are the categories a business uses to record transactions",
"properties": {
"nominalCode": {
"type": "String",
"displayName": "Nominal Code",
"description": "The external reference given to each nominal account for a business",
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "NominalCode",
"details": "Must be provided."
}
]
}
},
"name": {
"type": "String",
"displayName": "Name",
"description": "Name of the account",
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Name",
"details": "Must be provided."
}
]
}
},
"fullyQualifiedCategory": {
"type": "String",
"displayName": "Fully Qualified Category",
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"options": [
{
"value": "Asset.Assets.Cash",
"type": "String",
"displayName": "Asset.Assets.Cash",
"required": false
},
{
"value": "Asset.Assets.Bank",
"type": "String",
"displayName": "Asset.Assets.Bank",
"required": false
},
{
"value": "Asset.Assets.PaymentServices",
"type": "String",
"displayName": "Asset.Assets.PaymentServices",
"required": false
},
{
"value": "Asset.Assets.AccountsReceivable",
"type": "String",
"displayName": "Asset.Assets.AccountsReceivable",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.AccountsPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.AccountsPayable",
"required": false
},
{
"value": "Asset.Assets.VAT",
"type": "String",
"displayName": "Asset.Assets.VAT",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.EmployeesPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.EmployeesPayable",
"required": false
},
{
"value": "Asset.Assets.PrepaidExpenses",
"type": "String",
"displayName": "Asset.Assets.PrepaidExpenses",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.AccruedExpenses",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.AccruedExpenses",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.IncomeTaxesPayable",
"required": false
},
{
"value": "Asset.Assets.FixedAssets",
"type": "String",
"displayName": "Asset.Assets.FixedAssets",
"required": false
},
{
"value": "Asset.Assets.OtherAssets",
"type": "String",
"displayName": "Asset.Assets.OtherAssets",
"required": false
},
{
"value": "Asset.Assets.AccumulatedDeprecation",
"type": "String",
"displayName": "Asset.Assets.AccumulatedDeprecation",
"required": false
},
{
"value": "Asset.Assets.Inventory",
"type": "String",
"displayName": "Asset.Assets.Inventory",
"required": false
},
{
"value": "Equity.EquityAndLiabilities.CapitalStock",
"type": "String",
"displayName": "Equity.EquityAndLiabilities.CapitalStock",
"required": false
},
{
"value": "Equity.EquityAndLiabilities.RetainedEarnings",
"type": "String",
"displayName": "Equity.EquityAndLiabilities.RetainedEarnings",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.LongTermDebt",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.LongTermDebt",
"required": false
},
{
"value": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"type": "String",
"displayName": "Liability.EquityAndLiabilities.CurrentPortionOfDebt",
"required": false
},
{
"value": "Unknown.EquityAndLiabilities.Intercompany",
"type": "String",
"displayName": "Unknown.EquityAndLiabilities.Intercompany",
"required": false
},
{
"value": "Unknown.General.General",
"type": "String",
"displayName": "Unknown.General.General",
"required": false
},
{
"value": "Income.NetIncome.Revenue",
"type": "String",
"displayName": "Income.NetIncome.Revenue",
"required": false
},
{
"value": "Expense.NetIncome.CostOfGoods",
"type": "String",
"displayName": "Expense.NetIncome.CostOfGoods",
"required": false
},
{
"value": "Expense.NetIncome.OtherCosts",
"type": "String",
"displayName": "Expense.NetIncome.OtherCosts",
"required": false
},
{
"value": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"type": "String",
"displayName": "Expense.NetIncome.SalesGeneralAdministrativeExpenses",
"required": false
},
{
"value": "Expense.NetIncome.DeprecationCosts",
"type": "String",
"displayName": "Expense.NetIncome.DeprecationCosts",
"required": false
},
{
"value": "Expense.NetIncome.ResearchAndDevelopment",
"type": "String",
"displayName": "Expense.NetIncome.ResearchAndDevelopment",
"required": false
},
{
"value": "Expense.NetIncome.EmployeeCosts",
"type": "String",
"displayName": "Expense.NetIncome.EmployeeCosts",
"required": false
},
{
"value": "Expense.NetIncome.EmploymentCosts",
"type": "String",
"displayName": "Expense.NetIncome.EmploymentCosts",
"required": false
},
{
"value": "Expense.ExceptionalIncome.ExceptionalCosts",
"type": "String",
"displayName": "Expense.ExceptionalIncome.ExceptionalCosts",
"required": false
},
{
"value": "Income.ExceptionalIncome.ExceptionalIncome",
"type": "String",
"displayName": "Income.ExceptionalIncome.ExceptionalIncome",
"required": false
},
{
"value": "Expense.ExceptionalIncome.IncomeTaxes",
"type": "String",
"displayName": "Expense.ExceptionalIncome.IncomeTaxes",
"required": false
},
{
"value": "Income.ExceptionalIncome.InterestIncome",
"type": "String",
"displayName": "Income.ExceptionalIncome.InterestIncome",
"required": false
}
],
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "FullyQualifiedCategory",
"details": "Must be provided."
}
]
}
},
"status": {
"type": "String",
"displayName": "Account Status",
"description": "The status of the account",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Pending",
"type": "String",
"displayName": "Pending",
"required": false
},
{
"value": "Unknown",
"type": "String",
"displayName": "Unknown",
"required": false
}
],
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Status",
"details": "Must be provided."
}
]
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "MYOB AccountRight and Essentials",
"example": {
"type": "Object",
"displayName": "Nominal Account",
"description": "Nominal Accounts are the categories a business uses to record transactions",
"properties": {
"nominalCode": {
"type": "String",
"displayName": "Nominal Code",
"description": "The external reference given to each nominal account for a business",
"required": true,
"validation": {
"warnings": [
{
"field": "NominalCode",
"details": "If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx"
}
],
"information": []
}
},
"name": {
"type": "String",
"displayName": "Name",
"description": "Name of the account",
"required": false,
"validation": {
"warnings": [
{
"field": "Name",
"details": "Must have a length between 1 and 60 characters"
}
],
"information": []
}
},
"description": {
"type": "String",
"displayName": "Description",
"description": "Description of the account",
"required": false,
"validation": {
"warnings": [
{
"field": "Description",
"details": "Must have a length between 1 and 255 characters"
}
],
"information": []
}
},
"fullyQualifiedCategory": {
"type": "String",
"displayName": "Fully Qualified Category",
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"options": [
{
"value": "Asset.Bank",
"type": "String",
"displayName": "Bank",
"required": false
},
{
"value": "Asset.AccountReceivable",
"type": "String",
"displayName": "Accounts Receivable",
"required": false
},
{
"value": "Asset.OtherCurrentAsset",
"type": "String",
"displayName": "Other Current Asset",
"required": false
},
{
"value": "Asset.FixedAsset",
"type": "String",
"displayName": "Fixed Asset",
"required": false
},
{
"value": "Asset.OtherAsset",
"type": "String",
"displayName": "Other Asset",
"required": false
},
{
"value": "Asset.CashAndBank",
"type": "String",
"displayName": "Cash",
"required": false
},
{
"value": "Asset.Property Plant and Equipment",
"type": "String",
"displayName": "Equipment Machinery",
"required": false
},
{
"value": "Liability.CreditCard",
"type": "String",
"displayName": "Credit Card",
"required": false
},
{
"value": "Liability.AccountsPayable",
"type": "String",
"displayName": "Accounts Payable",
"required": false
},
{
"value": "Liability.OtherCurrentLiability",
"type": "String",
"displayName": "Other Current Liability",
"required": false
},
{
"value": "Liability.LongTermLiability",
"type": "String",
"displayName": "Long Term Liability",
"required": false
},
{
"value": "Liability.OtherLiability",
"type": "String",
"displayName": "Other Liability",
"required": false
},
{
"value": "Equity",
"type": "String",
"displayName": "Equity",
"required": false
},
{
"value": "Equity.Equity",
"type": "String",
"displayName": "Retained Earnings",
"required": false
},
{
"value": "Equity.Equity.RetainedEarnings",
"type": "String",
"displayName": "Retained Earnings",
"required": false
},
{
"value": "Equity.Owner's Equity",
"type": "String",
"displayName": "Retained Earnings",
"required": false
},
{
"value": "Income",
"type": "String",
"displayName": "Income",
"required": false
},
{
"value": "OtherIncome",
"type": "String",
"displayName": "Other Income",
"required": false
},
{
"value": "Expense",
"type": "String",
"displayName": "Expense",
"required": false
},
{
"value": "Expense.Expense",
"type": "String",
"displayName": "Sales Marketing",
"required": false
},
{
"value": "Expense.Expense.Insurance",
"type": "String",
"displayName": "General Administrative",
"required": false
},
{
"value": "Expense.Overhead",
"type": "String",
"displayName": "General Administrative",
"required": false
},
{
"value": "Expense.Expense.RepairMaintenance",
"type": "String",
"displayName": "Repairs Maintenance",
"required": false
},
{
"value": "OtherExpense",
"type": "String",
"displayName": "Other Expense",
"required": false
},
{
"value": "CostOfSales",
"type": "String",
"displayName": "Cost of Sales",
"required": false
},
{
"value": "Cost Of Goods Sold.Cost of Sales",
"type": "String",
"displayName": "Other",
"required": false
}
],
"required": true
},
"status": {
"type": "String",
"displayName": "Account Status",
"description": "The status of the account",
"options": [
{
"value": "Active",
"type": "String",
"displayName": "Active",
"required": false
},
{
"value": "Archived",
"type": "String",
"displayName": "Archived",
"required": false
}
],
"required": true
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "QuickBooks Desktop",
"example": {
"type": "Object",
"displayName": "Nominal Account",
"description": "Nominal Accounts are the categories a business uses to record transactions",
"properties": {
"nominalCode": {
"type": "String",
"displayName": "Nominal Code",
"description": "The external reference given to each nominal account for a business",
"required": true,
"validation": {
"warnings": [
{
"field": "NominalCode",
"details": "Max length of 7 characters."
}
],
"information": []
}
},
"name": {
"type": "String",
"displayName": "Name",
"description": "Name of the account",
"required": true,
"validation": {
"warnings": [
{
"field": "Name",
"details": "Max length of 31 characters."
}
],
"information": []
}
},
"description": {
"type": "String",
"displayName": "Description",
"description": "Description of the account",
"required": false,
"validation": {
"warnings": [
{
"field": "Description",
"details": "Max length of 200 characters."
}
],
"information": []
}
},
"currency": {
"type": "String",
"displayName": "Currency",
"description": "The currency of the account",
"required": false,
"validation": {
"warnings": [
{
"field": "Currency",
"details": "The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is 'Asset.AccountsReceivable','Liability.AccountsPayable' or 'Liability.CreditCard'"
},
{
"field": "Currency",
"details": "Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company"
},
{
"field": "Currency",
"details": "Can only be set if the QuickBooks Desktop company has Multicurrency enabled."
}
],
"information": [
{
"field": "Currency",
"details": "If not set, will default to the base currency of the QuickBooks Desktop company"
}
]
}
},
"fullyQualifiedCategory": {
"type": "String",
"displayName": "Fully Qualified Category",
"description": "The full category of the account e.g. Liability.Current or Income.Revenue",
"options": [
{
"value": "Asset.AccountsReceivable",
"type": "String",
"displayName": "Account Receivable",
"required": false
},
{
"value": "Asset.FixedAsset",
"type": "String",
"displayName": "Fixed Asset",
"required": false
},
{
"value": "Asset.OtherCurrentAsset",
"type": "String",
"displayName": "Other Current Asset",
"required": false
},
{
"value": "Asset.OtherAsset",
"type": "String",
"displayName": "Other Asset",
"
# --- truncated at 32 KB (178 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/examples/codat-get-create-chartofaccounts-model-example.json