> For the complete documentation index, see [llms.txt](https://apis.rightrev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/transaction-ingestion-order-invoices-events-and-bulk-uploads/events-ingestion-via-json-file.md).

# Events Ingestion via JSON file

This API is to upload and collect Events data in JSON file format

Method - POST

API End Point

```
/apis/oingest/v1/events
```

**Sample API End Point ( Events )**

<div data-with-frame="true"><figure><img src="https://3364757261-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F193S0RVwbPrcp6u9CoPJ%2Fuploads%2FBvjnZJqZTv5boT7joMJt%2Fimage.png?alt=media&amp;token=83a72079-53c9-4aac-af59-56ae5dd71a30" alt=""><figcaption></figcaption></figure></div>

**Payload**

```
"  {
    ""event_name"": ""Event_Percent"",
    ""action"": ""release"",
    ""percentage"": 25,
    ""amount"": """",
    ""quantity"": """",
    ""formula_value"": """",
    ""remaining_balance"": """",
    ""cost_functional_exchange_rate"": """",
    ""cost_reporting_exchange_rate"": """",
    ""transaction_identifier1"": """",
    ""transaction_identifier2"": """",
    ""transaction_identifier3"": """",
    ""transaction_identifier4"": """",
    ""transaction_identifier5"": """",
    ""order_financial_id"": ""ofid_001"",
    ""created_on"": """",
    ""start_date"": """",
    ""end_date"": """",
    ""gl_account"": """",
    ""user_comments"": ""release 25% revenue""
  }"	

```

**Response**

```
{
    "file_id": "9d0924c1-45c7-4488-bec5-d71495f4be93",
    "message": "File successfully uploaded"
}
```

**Description of the fields**

<table><thead><tr><th width="203">Fields</th><th width="516">Description</th><th width="176">Example</th><th width="137">Required</th></tr></thead><tbody><tr><td>event_name</td><td>Name of the revenue event being triggered.</td><td>Event_Percent</td><td>TRUE</td></tr><tr><td>action</td><td>Action performed by the event -  release or defer.</td><td>release</td><td>TRUE</td></tr><tr><td>percentage</td><td>Percentage used for release or calculation for the event.</td><td>25</td><td>FALSE</td></tr><tr><td>amount</td><td>Fixed monetary amount associated with the event.</td><td>10000</td><td>FALSE</td></tr><tr><td>quantity</td><td>Quantity used for event-based calculations.</td><td>50</td><td>FALSE</td></tr><tr><td>formula_value</td><td>Value derived from formula-based events.</td><td>total_list_price*0.25</td><td>FALSE</td></tr><tr><td>remaining_balance</td><td>Boolean Field - Remaining amount/quantity after applying previous events. True will release remaining amount/quantity revenue.</td><td>True</td><td>FALSE</td></tr><tr><td>cost_functional_exchange_rate</td><td>Exchange rate used for converting cost to functional currency.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>cost_reporting_exchange_rate</td><td>Exchange rate used for converting cost to reporting/global currency.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>transaction_identifier1</td><td>Additional transaction identifier used for event.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>transaction_identifier2</td><td>Additional transaction identifier used for event.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>transaction_identifier3</td><td>Additional transaction identifier used for event.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>transaction_identifier4</td><td>Additional transaction identifier used for event.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>transaction_identifier5</td><td>Additional transaction identifier used for event.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>order_financial_id</td><td>Order Financial ID associated with this event.</td><td>ofid_001</td><td>TRUE</td></tr><tr><td>created_on</td><td>Date when the event record was created.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>start_date</td><td>Event start date. this will override dates on the order line</td><td>(blank)</td><td>FALSE</td></tr><tr><td>end_date</td><td>Event end date. this will override dates on the order line</td><td>(blank)</td><td>FALSE</td></tr><tr><td>gl_account</td><td>GL account assocciated by this event if any.</td><td>(blank)</td><td>FALSE</td></tr><tr><td>user_comments</td><td>Any comments added by the user for the event.</td><td>release 25% revenue</td><td>FALSE</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apis.rightrev.com/rightrev-rest-api/transactions-ingestion/transaction-ingestion-order-invoices-events-and-bulk-uploads/events-ingestion-via-json-file.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.