logo

Retrieve journal records

Retrieves a list of journal records.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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 of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

List of journal records retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array
type
required
string
Enum: "automated" "manual"
journalEntryId
required
string

ID of the journal entry.

customerId
required
string <= 50 characters

ID of the customer.

invoiceId
required
string

ID of the invoice.

invoiceItemId
required
string

ID of the invoice item.

debitAccountId
required
string or null

ID of the debit journal account.

creditAccountId
required
string or null

ID of the credit journal account.

id
string (ResourceId) <= 50 characters

Unique resource ID. Defaults to UUID v4.

estimatedAmount
number or null <double>

Amount of revenue estimated to be recognized at the schedule date. This value is ignored when updating a journal record with a type of automated.

recognizedAmount
number or null <double>

Amount of revenue recognized at the journal period end.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object

Embedded objects that are requested by the expand query parameter.

customer
object
invoice
object
invoiceItem
object
debitAccount
object
creditAccount
object
Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "customer" "invoice" "invoiceItem" "journalEntry" "creditAccount" "debitAccount"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/journal-entries/{id}/records
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Create a journal record