Journal entry lines

Journal entry lines represent individual debit or credit line items within a journal-entry. You can create or update line items by modifying the journal entry.

When adding a line item to the journal entry, you can post it immediately or save it as a draft, which can be edited and posted later.

List journal entry lines

get/objects/general-ledger/journal-entry-line

Returns a collection of journal entry lines with a key, ID, and link for each entry line. 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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "18",
      • "id": "18",
      • "href": "/objects/general-ledger/journal-entry-line/18"
      },
    • {
      • "key": "21",
      • "id": "21",
      • "href": "/objects/general-ledger/journal-entry-line/21"
      },
    • {
      • "key": "41",
      • "id": "41",
      • "href": "/objects/general-ledger/journal-entry-line/41"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a journal entry line
get/objects/general-ledger/journal-entry-line/{key}
Returns detailed information for a specified journal entry line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the journal entry line.


 
 Example:  132
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "18",
    • "key": "18",
    • "journalEntry": {
      • "id": "132",
      • "key": "132",
      • "href": "/objects/general-ledger/journal-entry/132"
      },
    • "lineNumber": 18,
    • "txnType": "credit",
    • "entryDate": "2024-01-14",
    • "baseAmount": "49.31",
    • "txnAmount": "80.00",
    • "glAccount": {
      • "key": "194",
      • "id": "40238561",
      • "name": "Sales",
      • "href": "/objects/general-ledger/account/194"
      },
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "contract": {
        },
      • "project": {
        },
      • "class": {
        }
      },
    • "documentId": "CalOil_Credit_01-24",
    • "description": "CalOil Credit entries January 2024",
    • "numberOfUnits": 2,
    • "currency": {
      • "baseCurrency": "GBP",
      • "txnCurrency": "USD",
      • "exchangeRateDate": "2024-01-14",
      • "exchangeRateTypeId": "Company Daily Rate",
      • "exchangeRate": 0.6164
      },
    • "reconciliationGroup": {
      • "cleared": "matched",
      • "clearingDate": "2024-01-14",
      • "reconciliationDate": "2024-01-14"
      },
    • "accountingPeriod": 1,
    • "allocation": {
      • "id": "21",
      • "key": "FA_ALLOC",
      • "href": "/objects/general-ledger/txn-allocation-template/21"
      },
    • "interEntityTxnType": "p",
    • "parent": {
      • "id": "40",
      • "key": "40",
      • "href": "/objects/general-ledger/journal-entry-line/40"
      },
    • "audit": {
      • "createdDateTime": "2024-01-14T18:13:29Z",
      • "modifiedDateTime": "2024-01-14T18:13:29Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "state": "posted",
    • "isBillable": false,
    • "isBilled": false,
    • "taxEntries": [ ],
    • "href": "/objects/general-ledger/journal-entry-line/18"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a Journal entry line
delete/objects/general-ledger/journal-entry-line/{key}
Deletes a journal entry line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the journal entry line.


 
 Example:  132
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}