Journal entry lines represent transactions. They can be posted right away, submitted for approval if Approvals are enabled, or saved as a draft.
You create and update journal entry lines by creating or updating the journal-entry objects that contain those lines.
Returns up to 100 journal entry lines from the collection with a key, ID, and link for each entry. This operation is mostly for use in testing; use the query service to find journal entry lines that meet certain criteria and to specify the properties that are returned.
Subscription | General Ledger |
---|---|
User type | Business user, Employee, Payment Approver |
Permissions | List, View Journal Entries |
OK
Bad Request
{- "ia::result": [
- {
- "key": "2503",
- "id": "2503",
- "href": "/objects/general-ledger/journal-entry-line/2503"
}, - {
- "key": "2499",
- "id": "2499",
- "href": "/objects/general-ledger/journal-entry-line/2499"
}, - {
- "key": "2497",
- "id": "2497",
- "href": "/objects/general-ledger/journal-entry-line/2497"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Returns detailed information for a specified journal entry line.
Subscription | General Ledger |
---|---|
User type | Business user, Employee, Payment Approver |
Permissions | List, View Journal Entries |
key required | string System-assigned key for the journal entry line. Example: 2647 |
OK
Bad Request
{- "ia::result": {
- "id": "18",
- "key": "18",
- "lines": [
- {
- "id": "6",
- "key": "6",
- "lineNumber": 1,
- "txnType": "debit",
- "entryDate": "2023-12-18",
- "txnAmount": "5000",
- "baseAmount": "8562.13",
- "exchangeRate": {
- "date": "2023-12-17",
- "typeId": "EUR-Rate",
- "rate": 2.15
}, - "glAccount": {
- "key": "207",
- "id": "6280",
- "name": "Professional Fees",
- "href": "/objects/general-ledger/account/207"
}, - "dimensions": {
- "department": {
- "key": "1",
- "id": "01",
- "name": "Sales",
- "href": "/objects/company-config/department/1"
}, - "location": {
- "key": "1",
- "id": "CA",
- "name": "California",
- "href": "/objects/company-config/location/1"
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": "4",
- "id": "SVC01-01",
- "name": "Implementation Services",
- "href": "/objects/inventory-control/item/4"
}, - "customer": {
- "key": "14",
- "id": "C-00003",
- "name": "Burlington Textiles Corp of America",
- "href": "/objects/accounts-receivable/customer/14"
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "documentId": null,
- "description": null,
- "numberOfUnits": null,
- "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRateDate": null,
- "exchangeRateType": null,
- "exchangeRate": 1
}, - "reconciliationGroup": {
- "cleared": "false",
- "clearingDate": null,
- "reconciliationDate": null
}, - "accountingPeriod": null,
- "allocation": {
- "allocation": null,
- "allocationKey": null
}, - "audit": {
- "createdDateTime": "1970-01-01T00:00:00Z",
- "modifiedDateTime": "2015-07-21T07:40:24Z",
- "createdBy": null,
- "modifiedBy": null
}, - "state": "posted",
- "isBillable": null,
- "isBilled": null,
- "href": "/objects/general-ledger/journal-entry-line/6"
}, - {
- "id": 7,
- "key": 7,
- "lineNumber": 2,
- "txnType": "credit",
- "entryDate": "2009-12-18",
- "txnAmount": "5000",
- "baseAmount": "8562.13",
- "exchangeRate": {
- "date": "2009-12-17",
- "typeId": "EUR-Rate",
- "rate": 2.15
}, - "glAccount": {
- "key": "207",
- "id": "6280",
- "name": "Professional Fees",
- "href": "/objects/general-ledger/account/207"
}, - "dimensions": {
- "department": {
- "key": "1",
- "id": "01",
- "name": "Sales",
- "href": "/objects/company-config/department/1"
}, - "location": {
- "key": "1",
- "id": "CA",
- "name": "California",
- "href": "/objects/company-config/location/1"
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": "4",
- "id": "SVC01-01",
- "name": "Implementation Services",
- "href": "/objects/inventory-control/item/4"
}, - "customer": {
- "key": "14",
- "id": "C-00003",
- "name": "Burlington Textiles Corp of America",
- "href": "/objects/accounts-receivable/customer/14"
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "documentId": null,
- "description": null,
- "numberOfUnits": null,
- "currency": {
- "baseCurrency": "USD",
- "txnCurrency": "USD",
- "exchangeRateDate": null,
- "exchangeRateType": null,
- "exchangeRate": 1
}, - "reconciliationGroup": {
- "cleared": "false",
- "clearingDate": null,
- "reconciliationDate": null
}, - "accountingPeriod": null,
- "allocation": {
- "allocation": null,
- "allocationKey": null
}, - "audit": {
- "createdDateTime": "1970-01-01T00:00:00Z",
- "modifiedDateTime": "2015-07-21T07:40:24Z",
- "createdBy": null,
- "modifiedBy": null
}, - "state": "posted",
- "isBillable": null,
- "isBilled": null,
- "href": "/objects/general-ledger/journal-entry-line/7"
}
]
}, - "href": "/objects/general-ledger/journal-entry/6",
- "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes a journal entry line.
Subscription | General Ledger |
---|---|
User type | Business user |
Permissions | Delete Journal Entries |
key required | string System-assigned key for the journal entry line. Example: 2647 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "general-ledger/journal-entry-line" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "general-ledger/journal-entry-line",
- "filters": [
- {
- "$eq": {
- "journalEntry.key": "18"
}
}
], - "fields": [
- "key",
- "id",
- "href",
- "transactionType"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "99",
- "id": "99",
- "href": "/objects/general-ledger/journal-entry-line/99",
- "transactionType": "Credit"
}, - {
- "key": "100",
- "id": "100",
- "href": "/objects/general-ledger/journal-entry-line/100",
- "transactionType": "Debit"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}