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 )

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

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