Back to top

Ajera API

message for Ajera API general doc

For additional api methods see the following below:
Home
Clients API
Contacts API
Employees API
Vendors API
Expense Reports API
Various List Methods

Messages

Group of all messages-related resources.

API Endpoint

id is an Ajera API specific id that is required to access the API for any given API server call. This id and specific url can be obtained from the Ajera 8 Menu Utility -> Setup Integrations -> API Settings

Get GL Accounts
POST/AjeraAPI.ashx?{id}

NOTE: GetGLAccounts requires that the API user be setup with an Authorized Ajera User.

GetGLAccounts at a minimum takes no arguments, but can be filtered or have amounts reflected by not including

close year entries or filter amounts by setting an as of date. Since this method is built from the GL Account Base

from widgets, as of date operates as it would in widgets.

Related methods ListAccountGroups

Example URI

POST /AjeraAPI.ashx?ew0KICAiRGF0YWJhc2VOYW1lIjogIkFqZXJhX01haW4iDQp9
URI Parameters
HideShow
id
string (required) Example: ew0KICAiRGF0YWJhc2VOYW1lIjogIkFqZXJhX01haW4iDQp9

An unique identifier required for api access.

Request  GetGLAccounts
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
    Method: "GetGLAccounts",
    SessionToken: "",
    MethodArguments: {
        RequestedGLAccounts: [1, 2, 3],
        ExcludeCloseYearEntries: "false",
        AsOfDate: "03/14/2019",
        FilterByAccountGroup: [1,2,3],
        FilterByStatus: ["Active"],
        FilterByType: ["Income", "Expense"]
    }
}
Schema
{
    Method: "string, required",
    SessionToken: "string",
    MethodArguments: { //this object is required but can be just {} an empty object
        RequestedGLAccounts: "int array, optional, list of GL Account keys, See ListGLAccounts",
        ExcludeCloseYearEntries: "boolean, optional, If true totals on GL Balance and GL Cash Basis Balance will not reflect close year entries",
        AsOfDate: "string, optional, A Date string will operate similar to how widget use as of date format is variable if your not sure or are getting errors try MM/DD/YYYY",
        FitlerByAccountGroup: "integer array, optional, 1,2 See method ListAccountGroups for keys",
        FilterByStatus: "string array, optional, Active, Inactive",
        FilterByType: "string array, optional, Income, BillableCost, NonBillableCost, Expense, OtherIncome"
    }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    Content: {
        GLAccounts: [
            {
                "GLAccountKey": integer, GL Account Key,
                "AccountGroupKey": integer, 0
                "ID": string, "Account ID",
                "Description": string, "Account Description",
                "AccountGroup Order": integer, sort order,
                "AccountGroup Status": string, "Status string example, Active/Inactive",
                "AccountGroup": string, "",
                "AccountType": string, "String representation of the account type Example (Billable Cost)",
                "AccountTypeValue": integer, Account Type Value, Example (7),
                "Allocated": boolean, false,
                "AllowJournalEntries": boolean, true,
                "IntercompanyAccountType": string, "None",
                "IntercompanyAccountTypeValue": integer, 0,
                "IntercompanyAccount": boolean, false,
                "NormalDebitBalance": boolean, true,
                "Notes": string, "",
                "Order": integer, 89,
                "PrintNetProfitAfterGroup": boolean, false,
                "Status": string, "Active",
                "SummarizeGroupOnFS": boolean, false,
                "Amount": float, -119.53,
                "GLBalance": float, 12803.14,
                "GLBudget": float, 0,
                "GLCashBasisBalance": float, 12803.14,
                "GLCashBasisBudget": float, 0
            }
        ]
    },
    Errors: [],
    Message: "Success",
    ResponseCode: 200,
    UsageKey: "6e983af4-946f-4947-9fbd-a233f796f6b4"
}
Schema
{
    ResponseCode: {
        type: int
    },
    Message: {
        type: "string"
    },
    Errors: {
        type: "array"
    },
    Content: {
        type: "object"
    },
    UsageKey: {
        type: "guid"
    }
}

List GL Accounts
POST/AjeraAPI.ashx?{id}

NOTE: ListGLAccounts requires that the API user be setup with an Authorized Ajera User.

ListGLAccounts at a minimum takes no arguments, but can be filtered.

Related methods ListAccountGroups

Example URI

POST /AjeraAPI.ashx?ew0KICAiRGF0YWJhc2VOYW1lIjogIkFqZXJhX01haW4iDQp9
URI Parameters
HideShow
id
string (required) Example: ew0KICAiRGF0YWJhc2VOYW1lIjogIkFqZXJhX01haW4iDQp9

An unique identifier required for api access.

Request  ListGLAccounts
HideShow
Headers
Content-Type: application/json
Accept: application/json
Body
{
    Method: "ListGLAccounts",
    SessionToken: "",
    MethodArguments: {
        FilterByAccountGroup: [1,2,3],
        FilterByStatus: ["Active"],
        FilterByType: ["Income", "Expense"]
    }
}
Schema
{
    Method: "string, required",
    SessionToken: "string",
    MethodArguments: { //this object is required but can be just {} an empty object
        FitlerByAccountGroup: "integer array, optional, 1,2 See method ListAccountGroups for keys",
        FilterByStatus: "string array, optional, Active, Inactive",
        FilterByType: "string array, optional, Income, BillableCost, NonBillableCost, Expense, OtherIncome"
    }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    Content: {
        GLAccounts: [
            {
                "GLAccountKey": integer, GL Account Key,
                "ID": string, "Account ID",
                "Description": string, "Account Description",
                "AccountType": string, "String representation of the account type Example (Billable Cost)",
                "AccountGroup": string, "Account group description",
                "Order": integer, "Account order",
                "Status": string, "Active, Account Status",
            }
        ]
    },
    Errors: [],
    Message: "Success",
    ResponseCode: 200,
    UsageKey: "6e983af4-946f-4947-9fbd-a233f796f6b4"
}
Schema
{
    ResponseCode: {
        type: int
    },
    Message: {
        type: "string"
    },
    Errors: {
        type: "array"
    },
    Content: {
        type: "object"
    },
    UsageKey: {
        type: "guid"
    }
}

Generated by aglio on 26 Jul 2021