TAG LINE
SMALL TITLE

General Ledger

(API Version v4)


This entity represents the user defined GL codes used within the system.


What can you do with GeneralLedger?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the GeneralLedger
name
"name": "Canadian Taxes"
Type: String
User defined GL Code name.
glDebit
"glDebit": "cad-debit"
Type: String
User defined code for your debit code.
glCredit
"glCredit": "cad-credit"
Type: String
User defined code for your credit code.
ownerId
READ-ONLY
"ownerId": 27
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.


End Points

DELETEapi/v4/GeneralLedger/{id}
Delete an instance of the GeneralLedger object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the GeneralLedger object.
Delete an instance of the GeneralLedger object.
DELETE api/v4/GeneralLedger/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "generalLedger"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/GeneralLedger/
Retrieve all of the GeneralLedger objects.
Retrieve all of the GeneralLedger objects.
GET api/v4/GeneralLedger/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Canadian Taxes",
            "glDebit": "cad-debit",
            "glCredit": "cad-credit",
            "ownerId": 8,
            "ownerName": "Sample Text Data"
        }
    ]
}
GETapi/v4/GeneralLedger/Paged
Retrieve all of the GeneralLedger objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the GeneralLedger objects in a paged fashion.
GET api/v4/GeneralLedger/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Canadian Taxes",
                "glDebit": "cad-debit",
                "glCredit": "cad-credit",
                "ownerId": 9,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/GeneralLedger/{id}
Retrieve an instance of the GeneralLedger object by its ID.
{id}Unique identifier for the GeneralLedger object.
Retrieve an instance of the GeneralLedger object by its ID.
GET api/v4/GeneralLedger/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Canadian Taxes",
        "glDebit": "cad-debit",
        "glCredit": "cad-credit",
        "ownerId": 19,
        "ownerName": "Sample Text Data"
    }
}
POSTapi/v4/GeneralLedger/
Create a new instance of the GeneralLedger object.
Create a new instance of the GeneralLedger object.
POST api/v4/GeneralLedger/

{
    "name": "Canadian Taxes",
    "glDebit": "cad-debit",
    "glCredit": "cad-credit"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Canadian Taxes",
                "glDebit": "cad-debit",
                "glCredit": "cad-credit",
                "ownerId": 20,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/GeneralLedger/Search
Retreive a list of GeneralLedger objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of GeneralLedger objects based on search criteria.
POST api/v4/GeneralLedger/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Canadian Taxes",
            "glDebit": "cad-debit",
            "glCredit": "cad-credit",
            "ownerId": 5,
            "ownerName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/GeneralLedger/{id}
Update an existing instance of the GeneralLedger object.
Update an existing instance of the GeneralLedger object.
PUT api/v4/GeneralLedger/{id}

{
    "identity": 1,
    "name": "Canadian Taxes",
    "glDebit": "cad-debit",
    "glCredit": "cad-credit"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Canadian Taxes",
                "glDebit": "cad-debit",
                "glCredit": "cad-credit",
                "ownerId": 15,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}