# Retrieve journal records

Retrieves a list of journal records.

Endpoint: GET /journal-records
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `expand` (string)
    Expands a request to include embedded objects within the 
property of the response. This field accepts a comma-separated list of objects.

For more information, see
Expand to include embedded objects.

## Response 200 fields (application/json):

  - `id` (string)
    Unique resource ID.
    Example: "jrn_rec_0YVCXV2HE5DBT89QV7RXSJEZQ4"

  - `journalEntryId` (string, required)
    ID of the journal entry.
    Example: "jrn_ent_01JXJ8EF9WVR0W187QZ6WF5703"

  - `customerId` (string)
    ID of the customer.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `invoiceId` (string)
    ID of the invoice.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoiceItemId` (string, required)
    ID of the invoice item.
    Example: "ii_0YVFDEQS2KCFTBN9HXWJFY55GV"

  - `type` (string)
    Enum: "automated", "manual"

  - `estimatedAmount` (number,null)
    Amount of revenue estimated to be recognized at the schedule date.
This value is ignored when updating a journal record with a  of .

  - `recognizedAmount` (number,null)
    Amount of revenue recognized at the journal period end.

  - `debitAccountId` (string,null, required)
    ID of the debit journal account.
    Example: "jrn_acc_01JXJ8S97PTMYX8W01SQ72FSWC"

  - `creditAccountId` (string,null, required)
    ID of the credit journal account.
    Example: "jrn_acc_01JXJ8RW7AWMVAH7DP3VXYQC1W"

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.customer` (object)

  - `_embedded.invoice` (object)

  - `_embedded.invoiceItem` (object)

  - `_embedded.debitAccount` (object)

  - `_embedded.creditAccount` (object)

  - `_embedded.journalEntry` (object)

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "customer", "invoice", "invoiceItem", "journalEntry", "creditAccount", "debitAccount"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.