/
Create a journal entry

Create a journal entry

Request

Creates a journal entry.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Journal entry resource.

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
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/journal-entries \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "period": {
      "startDate": "2022-09-01",
      "endDate": "2022-09-30"
    },
    "label": "monthly",
    "currency": "USD",
    "description": "string"
  }'

Responses

Journal entry created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
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": {
    "startDate": "2022-09-01",
    "endDate": "2022-09-30"
  },
  "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": [
    { … }
  ]
}