# Update Event Invoice Cycle

Update Event Invoice Cycle

Endpoint: PUT /rest/2.0/EVENT_INVOICE_CYCLE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.CycleType` (string, required)
    Cycle Type: Indicates the type of event on how invoice details/activities are routed to invoices. The options are: Usage Event (Default) Invoices are closed based on varying conditions and not necessarily tied to normal timed/scheduled intervals. Time Interval - Invoices are closed based on timed/scheduled intervals such as daily, weekly, monthly, etc.

  - `brmObjects.ActiveFlag` (integer)
    Active:  p {margin: 0px 0px 20px 0px;}When checked, the event cycle is evaluated. Otherwise, it is skipped when usage and invoice details are processed.

  - `brmObjects.ManualCloseFlag` (integer)
    Manual Close:  p {margin: 0px 0px 20px 0px;}When checked, invoices will not be closed automatically even if the scheduled interval or close event definition(s) is(are) met.

  - `brmObjects.Name` (string, required)
    Cycle Name

  - `brmObjects.CycleCloseDay` (string)
    Cycle Close Day:  p {margin: 0px 0px 20px 0px;}Indicates the calendar day of the month or a formula to derive the day when the invoice is closed.

  - `brmObjects.CloseEventFilterLogic` (string)
    Filter Logic:  p {margin: 0px 0px 20px 0px;}Indicates the logic by which the conditions listed above will be evaluated. The conditions can be represented by the order they are listed on the table above.Example:1 AND (2 OR 3)

  - `brmObjects.InvoiceApprovalFlag` (integer)
    Approve invoices before delivery: When checked, invoices are not automatically approved. When unchecked, invoices will automatically be set to the APPROVED status and will be sent to the customer's email on file.

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.TimeInterval` (string)
    Time Interval:  p {margin: 0px 0px 20px 0px;}Applicable when the Cycle Type is set to Scheduled Interval. This indicates the cycle when invoices are automatically closed such as Daily, Monthly, Quarterly, etc.

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.OrderNum` (string)
    Evaluation Order:  p {margin: 0px 0px 20px 0px;}Indicates the order by which the event cycle is evaluated. The lower the number, the higher the priority and will be evaluated first.

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.DayOfTheWeek` (string)
    Day Of The Week:  p {margin: 0px 0px 20px 0px;}Indicates the day of the week or a formula to derive the day when the invoice is closed.

  - `brmObjects.Id` (string, required)
    ID

  - `brmObjects.TimeZoneId` (string)
    TimeZoneId

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.CycleType` (string)
    Cycle Type: Indicates the type of event on how invoice details/activities are routed to invoices. The options are: Usage Event (Default) Invoices are closed based on varying conditions and not necessarily tied to normal timed/scheduled intervals. Time Interval - Invoices are closed based on timed/scheduled intervals such as daily, weekly, monthly, etc.

  - `retrieveResponse.ActiveFlag` (integer)
    Active:  p {margin: 0px 0px 20px 0px;}When checked, the event cycle is evaluated. Otherwise, it is skipped when usage and invoice details are processed.

  - `retrieveResponse.ManualCloseFlag` (integer)
    Manual Close:  p {margin: 0px 0px 20px 0px;}When checked, invoices will not be closed automatically even if the scheduled interval or close event definition(s) is(are) met.

  - `retrieveResponse.Name` (string)
    Cycle Name

  - `retrieveResponse.CycleCloseDay` (string)
    Cycle Close Day:  p {margin: 0px 0px 20px 0px;}Indicates the calendar day of the month or a formula to derive the day when the invoice is closed.

  - `retrieveResponse.CloseEventFilterLogic` (string)
    Filter Logic:  p {margin: 0px 0px 20px 0px;}Indicates the logic by which the conditions listed above will be evaluated. The conditions can be represented by the order they are listed on the table above.Example:1 AND (2 OR 3)

  - `retrieveResponse.InvoiceApprovalFlag` (integer)
    Approve invoices before delivery: When checked, invoices are not automatically approved. When unchecked, invoices will automatically be set to the APPROVED status and will be sent to the customer's email on file.

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.TimeInterval` (string)
    Time Interval:  p {margin: 0px 0px 20px 0px;}Applicable when the Cycle Type is set to Scheduled Interval. This indicates the cycle when invoices are automatically closed such as Daily, Monthly, Quarterly, etc.

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.OrderNum` (string)
    Evaluation Order:  p {margin: 0px 0px 20px 0px;}Indicates the order by which the event cycle is evaluated. The lower the number, the higher the priority and will be evaluated first.

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.DayOfTheWeek` (string)
    Day Of The Week:  p {margin: 0px 0px 20px 0px;}Indicates the day of the week or a formula to derive the day when the invoice is closed.

  - `retrieveResponse.Id` (string)
    ID

  - `retrieveResponse.TimeZoneId` (string)
    TimeZoneId

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error