# Upsert a journal entry

Creates or updates (upsert) a journal entry.

Endpoint: PUT /journal-entries/{id}
Version: latest
Security: SecretApiKey, JWT

## Path parameters:

  - `id` (string, required)
    ID of the resource.

## Request fields (application/json):

  - `period` (object, required)

  - `period.startDate` (string)
    Example: "2022-09-01"

  - `period.endDate` (string)
    Example: "2022-09-30"

  - `label` (string)
    Custom label that can be used to filter entries.
Annual orders are created with the label .
Monthly orders are created with the label .

  - `currency` (string, required)
    Currency code in ISO 4217 format.
    Example: "USD"

  - `description` (string)

## Response 200 fields (application/json):

  - `id` (string)
    ID of the journal entry.
    Example: "jrn_ent_0YVCXSFCF2DJX99NBBSJCEVETB"

  - `period` (object, required)

  - `period.startDate` (string)
    Example: "2022-09-01"

  - `period.endDate` (string)
    Example: "2022-09-30"

  - `label` (string)
    Custom label that can be used to filter entries.
Annual orders are created with the label .
Monthly orders are created with the label .

  - `currency` (string, required)
    Currency code in ISO 4217 format.
    Example: "USD"

  - `description` (string)

  - `totalRecognizedAmount` (number)
    Total amount of all revenue recognized at the end of the journal period.

  - `totalEstimatedAmount` (number)
    Total amount of all revenue estimated at the end of the journal period.

  - `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.

  - `_links` (array)
    Related links.

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

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

## Response 201 fields (application/json):

  - `id` (string)
    ID of the journal entry.
    Example: "jrn_ent_0YVCXSFCF2DJX99NBBSJCEVETB"

  - `period` (object, required)

  - `period.startDate` (string)
    Example: "2022-09-01"

  - `period.endDate` (string)
    Example: "2022-09-30"

  - `label` (string)
    Custom label that can be used to filter entries.
Annual orders are created with the label .
Monthly orders are created with the label .

  - `currency` (string, required)
    Currency code in ISO 4217 format.
    Example: "USD"

  - `description` (string)

  - `totalRecognizedAmount` (number)
    Total amount of all revenue recognized at the end of the journal period.

  - `totalEstimatedAmount` (number)
    Total amount of all revenue estimated at the end of the journal period.

  - `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.

  - `_links` (array)
    Related links.

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

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

## 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.

## Response 404 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 422 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.

  - `invalidFields` (array)
    Invalid field details.
    Example: [{"field":"field1","message":"field1 is invalid"},{"field":"subObject.field2","message":"field2 is invalid"},{"field":"subObject.field2","message":"another error in the field2"}]

  - `invalidFields.field` (string)
    Name of the field.
Dot notation is used for nested object field names.

  - `invalidFields.message` (string)
    Message field.

## Response 429 fields (application/json):

  - `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".
    Example: "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.
    Example: "Rate Limit Exceeded"

  - `status` (integer)
    HTTP status code.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.
    Example: "A request cannot be executed because the user has sent too many requests within a certain period of time"

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