> 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/order-ingestion-via-json-file.md).

# Order Ingestion via JSON file

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

Method - POST

API End Point

```
/apis/oingest/v1/json-upload
```

**Sample API End Point ( Orders )** 

<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%2F8zhsT1PgQiu0Y71cDpYg%2Fimage.png?alt=media&amp;token=60c62353-ba09-491b-b0b2-ec5dd0fab1bd" alt=""><figcaption></figcaption></figure></div>

**Payload**

```
"  {
    ""source_system"": ""NetSuite"",
    ""transaction_type"": ""Orders"",
    ""order_number"": ""order_n_01"",
    ""order_financial_id"": ""ofid_01"",
    ""order_date"": ""2021-01-01"",
    ""customer_name"": ""abc ltd"",
    ""customer_id"": ""abc ltd_1"",
    ""product_name"": ""software"",
    ""order_quantity"": 5,
    ""po_number"": """",
    ""unit_list_price"": ""6000"",
    ""unit_sell_price"": ""5000"",
    ""total_list_price"": 30000,
    ""total_sell_price"": 25000,
    ""discount_percent"": """",
    ""discount_amount"": """",
    ""revenue_start_date"": ""2021-01-01"",
    ""revenue_end_date"": ""2021-12-31"",
    ""transaction_currency"": ""USD"",
    ""functional_currency"": ""USD"",
    ""global_currency"": ""USD"",
    ""functional_exchange_rate"": 1,
    ""global_exchange_rate"": 1,
    ""amendment_reason"": ""New"",
    ""parent_order_reference"": """",
    ""ssp_date"": """",
    ""carves_eligible"": ""TRUE"",
    ""contract_liability_segment"": ""QC002-S20-CL"",
    ""contract_revenue_segment"": ""QC002-S20-REV"",
    ""carves_liability_segment"": ""QC002-S20-CV-CL"",
    ""carves_revenue_segment"": ""QC002-S20-CV-REV"",
    ""legal_entity"": ""LE_02"",
    ""usage_bookings"": ""FALSE"",
    ""billing_revenue_accrual"": ""FALSE"",
    ""product_id"": ""software_01"",
    ""qc_custom_string"": ""ord-015-rc1"",
    ""qc_custom_boolean"": """",
    ""qc_custom_date"": """",
    ""qc_custom_decimal"": """",
    ""qc_custom_integer"": """",
    ""contract_asset_segment"": """",
    ""bundle_config_key"": """",
    ""deferred_cost_account"": """"
  }"	

```

**Response**

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

**Description of the fields**

<table><thead><tr><th width="230">Fields</th><th width="461">Description</th><th width="163">Example</th><th width="105">Required</th></tr></thead><tbody><tr><td>source_system</td><td>The system or application from which the order originated.</td><td>NetSuite</td><td>TRUE</td></tr><tr><td>transaction_type</td><td>The type/category of the transaction – Orders.</td><td>Orders</td><td>TRUE</td></tr><tr><td>order_number</td><td>Identifier for the order.</td><td>Order_N_01</td><td>TRUE</td></tr><tr><td>order_financial_id</td><td>Unique Financial identifier of the order.</td><td>OFID_01</td><td>TRUE</td></tr><tr><td>order_date</td><td>The date when the order was created.</td><td>01/01/2021</td><td>TRUE</td></tr><tr><td>customer_name</td><td>Name of the customer.</td><td>ABC Ltd</td><td>TRUE</td></tr><tr><td>customer_id</td><td>Unique customer identifier.</td><td>ABC Ltd _ 1</td><td>TRUE</td></tr><tr><td>product_name</td><td>Name of the product purchased.</td><td>Software</td><td>TRUE</td></tr><tr><td>order_quantity</td><td>Quantity of product ordered.</td><td>1</td><td>TRUE</td></tr><tr><td>po_number</td><td>Purchase order number.</td><td>PO_001</td><td>FALSE</td></tr><tr><td>unit_list_price</td><td>List price per unit of the product.</td><td>6000</td><td>FALSE</td></tr><tr><td>unit_sell_price</td><td>Selling price per unit after discounts.</td><td>5000</td><td>FALSE</td></tr><tr><td>total_list_price</td><td>Total list price for the order.</td><td>30000</td><td>TRUE</td></tr><tr><td>total_sell_price</td><td>Total selling price for the order.</td><td>25000</td><td>TRUE</td></tr><tr><td>discount_percent</td><td>Discount percentage applied to the order.</td><td>10</td><td>FALSE</td></tr><tr><td>discount_amount</td><td>Total discount amount.</td><td>3000</td><td>FALSE</td></tr><tr><td>revenue_start_date</td><td>Date when revenue recognition begins.</td><td>01/01/2021</td><td>TRUE</td></tr><tr><td>revenue_end_date</td><td>Date when revenue recognition ends.</td><td>12/31/2021</td><td>TRUE</td></tr><tr><td>transaction_currency</td><td>Transaction currency in which the order was recorded.</td><td>USD</td><td>TRUE</td></tr><tr><td>functional_currency</td><td>Reporting currency of the company.</td><td>USD</td><td>TRUE</td></tr><tr><td>global_currency</td><td>Standardized currency used for global reporting.</td><td>USD</td><td>TRUE</td></tr><tr><td>functional_exchange_rate</td><td>Exchange rate from transaction to functional currency.</td><td>1</td><td>TRUE</td></tr><tr><td>global_exchange_rate</td><td>Exchange rate from transaction to global currency.</td><td>1</td><td>TRUE</td></tr><tr><td>amendment_reason</td><td>Reason for order amendment (if any). For 1st time order collection it will always be NEW<br>In Case of amendment, reason can be provided what is configured in contract amendments policy.</td><td>New<br></td><td>FALSE</td></tr><tr><td>parent_order_reference</td><td>Reference to the parent order in case of amendments. Order Financial ID of parent order line.</td><td>Provide Parent Order Financial ID</td><td>FALSE</td></tr><tr><td>ssp_date</td><td>Date used for SSP determination.</td><td>(01/01/2021</td><td>FALSE</td></tr><tr><td>carves_eligible</td><td>Indicates if carve apply to this order.</td><td>TRUE</td><td>FALSE</td></tr><tr><td>contract_liability_segment</td><td>GL segment for contract liability.</td><td>QC002-S20-CL</td><td>FALSE</td></tr><tr><td>contract_revenue_segment</td><td>GL segment for contract revenue.</td><td>QC002-S20-REV</td><td>FALSE</td></tr><tr><td>carves_liability_segment</td><td>GL segment for carve liability.</td><td>QC002-S20-CV-CL</td><td>FALSE</td></tr><tr><td>carves_revenue_segment</td><td>GL segment for carve revenue.</td><td>QC002-S20-CV-REV</td><td>FALSE</td></tr><tr><td>legal_entity</td><td>Legal entity associated with the order.</td><td>LE_02</td><td>TRUE</td></tr><tr><td>usage_bookings</td><td>Indicates if the order is usage‑based.</td><td>FALSE</td><td>FALSE</td></tr><tr><td>billing_revenue_accrual</td><td>Indicates if billing accrual applies.</td><td>FALSE</td><td>FALSE</td></tr><tr><td>product_id</td><td>Product identifier.</td><td>software_01</td><td>TRUE</td></tr><tr><td>Custom_Field-String</td><td>Custom string field. ( This custom fields provided for reference. user can add custom fields according to business need )</td><td>Custom_Data</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/order-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.