TAG LINE
TAG LINE
SMALL TITLE
This entity represents the user defined GL codes used within the system.
identity READ-ONLY | "identity": 4 Type: Number This is the unique numeric identifier for the GeneralLedger |
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": 1 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. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format. |
isDeleted READ-ONLY | "isDeleted": true Type: Boolean Whether or not this record has been marked as deleted but is retained for audit purposes. |
deletedByUserId | "deletedByUserId": 22 Type: Number Unique identifier for the associated User object. |
deletedByUserName | "deletedByUserName": "Sample Name" Type: String The name of the object associated with the deletedByUserId property. |
name | "name": "Canadian Taxes" Type: String User defined GL Code name. |
| DELETE | GeneralLedger/{id} |
| Delete an instance of the GeneralLedger object. Upon successful delete, this API will return a record of all of the related 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 GeneralLedger/{id}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"
}
]
}
} | |
| GET | GeneralLedger/ |
| Retrieve all of the GeneralLedger objects. | |
Retrieve all of the GeneralLedger objects. GET GeneralLedger/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"ownerId": 11,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 22,
"deletedByUserName": "Sample Text Data",
"name": "Canadian Taxes"
}
]
} | |
| GET | 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 GeneralLedger/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"ownerId": 25,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 11,
"deletedByUserName": "Sample Text Data",
"name": "Canadian Taxes"
}
]
}
} | |
| GET | 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 GeneralLedger/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"ownerId": 21,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 12,
"deletedByUserName": "Sample Text Data",
"name": "Canadian Taxes"
}
} | |
| POST | GeneralLedger/ |
| Create a new instance of the GeneralLedger object. | |
Create a new instance of the GeneralLedger object. POST GeneralLedger/
{
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 3,
"name": "Canadian Taxes"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"ownerId": 13,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 1,
"deletedByUserName": "Sample Text Data",
"name": "Canadian Taxes"
}
]
}
} | |
| PUT | GeneralLedger/{id} |
| Update an existing instance of the GeneralLedger object. | |
Update an existing instance of the GeneralLedger object. PUT GeneralLedger/{id}
{
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 13,
"name": "Canadian Taxes"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"glDebit": "cad-debit",
"glCredit": "cad-credit",
"ownerId": 12,
"ownerName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"isDeleted": true,
"deletedByUserId": 5,
"deletedByUserName": "Sample Text Data",
"name": "Canadian Taxes"
}
]
}
} | |