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 )

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

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