/
Retrieve journal entries

Retrieve journal entries

Request

Retrieves a list of journal entries.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/journal-entries?limit=1000&offset=1000&filter=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of journal entries retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the journal entry.

Example:"jrn_ent_0YVCXSFCF2DJX99NBBSJCEVETB"
periodobjectrequired
labelstring, <= 255 characters

Custom label that can be used to filter entries. Annual orders are created with the label Annual. Monthly orders are created with the label Monthly.

Default:"monthly"
currencystring, = 3 characters(CurrencyCode)required

Currency of the journal record revenue.

Example:"USD"
descriptionstring
totalRecognizedAmountnumber, (double)read-only

Total amount of all revenue recognized at the end of the journal period.

totalEstimatedAmountnumber, (double)read-only

Total amount of all revenue estimated at the end of the journal period.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "jrn_ent_0YVCXSFCF2DJX99NBBSJCEVETB",
    "period": { … },
    "label": "monthly",
    "currency": "USD",
    "description": "string",
    "totalRecognizedAmount": 0.1,
    "totalEstimatedAmount": 0.1,
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]