/
Retrieve journal record

Retrieve journal record

Request

Retrieves a journal record with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/journal-records/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Journal record retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

Unique resource ID.

Example:"jrn_rec_0YVCXV2HE5DBT89QV7RXSJEZQ4"
journalEntryIdstring, <= 50 charactersrequired

ID of the journal entry.

Example:"jrn_ent_01JXJ8EF9WVR0W187QZ6WF5703"
customerIdstring, <= 50 charactersread-only

ID of the customer.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
invoiceIdstring, <= 50 charactersread-only

ID of the invoice.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
invoiceItemIdstring, <= 50 charactersrequired

ID of the invoice item.

Example:"ii_0YVFDEQS2KCFTBN9HXWJFY55GV"
typestringread-only
Enum:"automated""manual"
estimatedAmountnumber 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.

recognizedAmountnumber or null, (double)

Amount of revenue recognized at the journal period end.

debitAccountIdstring or null, <= 50 charactersrequired

ID of the debit journal account.

Example:"jrn_acc_01JXJ8S97PTMYX8W01SQ72FSWC"
creditAccountIdstring or null, <= 50 charactersrequired

ID of the credit journal account.

Example:"jrn_acc_01JXJ8RW7AWMVAH7DP3VXYQC1W"
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.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "jrn_rec_0YVCXV2HE5DBT89QV7RXSJEZQ4",
  "journalEntryId": "jrn_ent_01JXJ8EF9WVR0W187QZ6WF5703",
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
  "invoiceItemId": "ii_0YVFDEQS2KCFTBN9HXWJFY55GV",
  "type": "automated",
  "estimatedAmount": 0,
  "recognizedAmount": 0,
  "debitAccountId": "jrn_acc_01JXJ8S97PTMYX8W01SQ72FSWC",
  "creditAccountId": "jrn_acc_01JXJ8RW7AWMVAH7DP3VXYQC1W",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_embedded": {
    "customer": {},
    "invoice": {},
    "invoiceItem": {},
    "debitAccount": {},
    "creditAccount": {},
    "journalEntry": {}
  },
  "_links": [
    { … }
  ]
}