Order Ingestion Configuration
Defines how order-related field data is received, updated, and processed during ingestion through APIs.
This API is used to retrieve all the Order Ingestion Configuration Policy details.
Responses
200
Get Order Ingestion Configuration Policy
application/json
compliance_idstringRequired
A system-generated compliance ID to retrieve the Order Ingestion Configuration Policy details.
compliance_namestringRequired
Name of the Policy
created_bystringRequired
ID of the user who created the policy. Example: username@rightrev.com
created_onintegerRequired
Timestamp of the policy created by the user. This is a unix Epoch timestamp format.
last_modified_bystringRequired
ID of the user last modified by.
last_modified_onintegerRequired
Timestamp of the policy last modified on. This is a unix Epoch timestamp format.
last_usedintegerRequired
Timestamp of the policy last used on. This is a unix Epoch timestamp format.
policy_typestringRequired
It should be orders
statusstringRequired
Status of policy.
unique_keystringRequired
It's GUID. Globally unique identifier generated by the system.
version_idnullRequired
Represents the latest version of the policy.
get/apis/policy-sets/v1/policy/orders
GET /apis/policy-sets/v1/policy/orders HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200
Get Order Ingestion Configuration Policy
[
{
"compliance_id": "e352cf4f-cd97-4305-90cd-2b3ba483930d",
"compliance_name": "Default Order Ingestion Policy",
"compliance_spec": [
{
"columns": [
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "Name of the source system where data pulled into RightRev. Example: Oracle, Workday, etc",
"guid": "6355cec2-62d7-4e36-aa34-8f20e5a0e219",
"is_user_defined": false,
"label_caption": "Source System",
"label_default": "Source System",
"mandatory": true,
"maps_to": "source_system",
"name": "source_system",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "Type of the transaction data. Valid values are: Order / Orders (case in-sensitive)",
"guid": "0726fcf2-5f45-48d1-b915-457f619c65f5",
"is_user_defined": false,
"label_caption": "Transaction Type",
"label_default": "Transaction Type",
"mandatory": true,
"maps_to": "transaction_type",
"name": "transaction_type",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "67d10ed4-c608-48df-ad77-faa77ac89e4e",
"is_user_defined": false,
"label_caption": "Order Number",
"label_default": "Order Number",
"mandatory": true,
"maps_to": "order_number",
"name": "order_number",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "Unique identifier number of each order line transaction data. Can have Alphanumeric values",
"guid": "7ef2547b-52dd-4909-ba7c-40f58d026ea3",
"is_user_defined": false,
"label_caption": "Order Financial ID",
"label_default": "Order Financial ID",
"mandatory": true,
"maps_to": "order_financial_id",
"name": "order_financial_id",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "f222c676-abf9-467d-aa33-9c35612671b3",
"is_user_defined": false,
"label_caption": "Order Date",
"label_default": "Order Date",
"mandatory": true,
"maps_to": "order_date",
"name": "order_date",
"searchable": "false",
"type": "date",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "d7851230-6fba-4420-bbe3-1b8a7aaec4b1",
"is_user_defined": false,
"label_caption": "Customer Name",
"label_default": "Customer Name",
"mandatory": true,
"maps_to": "customer_name",
"name": "customer_name",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "5f746432-498d-4393-91c3-fc391ed77b8c",
"is_user_defined": false,
"label_caption": "Customer ID",
"label_default": "Customer ID",
"mandatory": false,
"maps_to": "customer_id",
"name": "customer_id",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "f6e51004-2811-485c-bca8-78ced1ecf8e3",
"is_user_defined": false,
"label_caption": "Product Name",
"label_default": "Product Name",
"mandatory": true,
"maps_to": "product_name",
"name": "product_name",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "379116d7-50be-419b-8c71-504ffe8f4d69",
"is_user_defined": false,
"label_caption": "Order Quantity",
"label_default": "Order Quantity",
"mandatory": true,
"maps_to": "order_quantity",
"name": "order_quantity",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "0e2ad261-8e2e-41ca-96bc-a7cf3635cbd5",
"is_user_defined": false,
"label_caption": "PO Number",
"label_default": "PO Number",
"mandatory": false,
"maps_to": "po_number",
"name": "po_number",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "0638300d-8028-4213-8aae-634f2c240d07",
"is_user_defined": false,
"label_caption": "Unit List Price",
"label_default": "Unit List Price",
"mandatory": false,
"maps_to": "unit_list_price",
"name": "unit_list_price",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "ba2c3a29-0e69-4f07-965e-2c78a54311a6",
"is_user_defined": false,
"label_caption": "Unit Sell Price",
"label_default": "Unit Sell Price",
"mandatory": false,
"maps_to": "unit_sell_price",
"name": "unit_sell_price",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "fc5c3cd7-4019-4b9b-8a68-18358fd5a23c",
"is_user_defined": false,
"label_caption": "Total List Price",
"label_default": "Total List Price",
"mandatory": true,
"maps_to": "total_list_price",
"name": "total_list_price",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "c75e6a1d-a41e-4226-b275-71f9fd17abc7",
"is_user_defined": false,
"label_caption": "Total Sell Price",
"label_default": "Total Sell Price",
"mandatory": true,
"maps_to": "total_sell_price",
"name": "total_sell_price",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "f3b2b28d-174f-4812-94de-140eda2bd381",
"is_user_defined": false,
"label_caption": "Discount Percent",
"label_default": "Discount Percent",
"mandatory": false,
"maps_to": "discount_percent",
"name": "discount_percent",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "6ff53b70-aaa3-4779-aa8e-5b30429b3bc7",
"is_user_defined": false,
"label_caption": "Discount Amount",
"label_default": "Discount Amount",
"mandatory": false,
"maps_to": "discount_amount",
"name": "discount_amount",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "5a31bd1f-af16-4522-9bd5-aeb0412fa564",
"is_user_defined": false,
"label_caption": "Revenue Start Date",
"label_default": "Revenue Start Date",
"mandatory": false,
"maps_to": "revenue_start_date",
"name": "revenue_start_date",
"searchable": "false",
"type": "date",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "fc49257a-44a8-472b-b57c-7dbd9c2fa583",
"is_user_defined": false,
"label_caption": "Revenue End Date",
"label_default": "Revenue End Date",
"mandatory": false,
"maps_to": "revenue_end_date",
"name": "revenue_end_date",
"searchable": "false",
"type": "date",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "The currency of the transaction of this order with the customer. Should be an valid currency code.",
"guid": "3846ec31-1825-4508-a495-242080b2847d",
"is_user_defined": false,
"label_caption": "Transaction Currency",
"label_default": "Transaction Currency",
"mandatory": true,
"maps_to": "transaction_currency",
"name": "transaction_currency",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "942062da-23ee-4287-94a0-ddac0bb554f4",
"is_user_defined": false,
"label_caption": "Functional Currency",
"label_default": "Functional Currency",
"mandatory": true,
"maps_to": "functional_currency",
"name": "functional_currency",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "ea0b445a-58b4-4574-a004-7f56174849dc",
"is_user_defined": false,
"label_caption": "Reporting Currency",
"label_default": "Reporting Currency",
"mandatory": true,
"maps_to": "global_currency",
"name": "global_currency",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "83991bb7-58d9-48c7-88fd-9dab95bef82e",
"is_user_defined": false,
"label_caption": "Functional Exchange Rate",
"label_default": "Functional Exchange Rate",
"mandatory": true,
"maps_to": "functional_exchange_rate",
"name": "functional_exchange_rate",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "522a3ad3-dfa2-4822-aea2-798be692c6c6",
"is_user_defined": false,
"label_caption": "Reporting Exchange Rate",
"label_default": "Reporting Exchange Rate",
"mandatory": true,
"maps_to": "global_exchange_rate",
"name": "global_exchange_rate",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "System will set Value Required as True or False for this field based on Enable Carves Allocation flag in Tenant Configuration. If set as True, then this field needs to have one of the valid value in Contract Amendment Policy",
"guid": "1aff6e58-7b8e-44b0-828d-b4407d1d165d",
"is_user_defined": false,
"label_caption": "Amendment Reason",
"label_default": "Amendment Reason",
"mandatory": true,
"maps_to": "amendment_reason",
"name": "amendment_reason",
"searchable": "false",
"type": "string",
"updated_at": 1748007585,
"updated_by": "raviteja.d@rightrev.com",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "This field needs to have valid order financial id in case of the order line an amendment order",
"guid": "eed1f4ed-86c4-492d-b292-4b60232fc67f",
"is_user_defined": false,
"label_caption": "Parent Order Reference",
"label_default": "Parent Order Reference",
"mandatory": false,
"maps_to": "parent_order_reference",
"name": "parent_order_reference",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "Populate date value if system need to consider this date instead of order date to pick the SSP for this order line",
"guid": "033f6e14-d205-414c-8d39-ebe786d20ec3",
"is_user_defined": false,
"label_caption": "SSP Date",
"label_default": "SSP Date",
"mandatory": false,
"maps_to": "ssp_date",
"name": "ssp_date",
"searchable": "false",
"type": "date",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "This flag is to determine the order line is eligible to include in carves allocation or not. Valid values are True / False (Case in-sensitive)",
"guid": "a378d11f-11a1-4fed-bf81-9b5199540dfc",
"is_user_defined": false,
"label_caption": "Eligible for Carves Allocation",
"label_default": "Eligible for Carves Allocation",
"mandatory": true,
"maps_to": "carves_eligible",
"name": "carves_eligible",
"searchable": "false",
"type": "boolean",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "e596c851-1dcd-43a6-a102-8084df0a646d",
"is_user_defined": false,
"label_caption": "Contract Liability Account",
"label_default": "Contract Liability Account",
"mandatory": true,
"maps_to": "contract_liability_segment",
"name": "contract_liability_segment",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "b15d4c4a-227c-4b59-9048-386715943c63",
"is_user_defined": false,
"label_caption": "Contract Revenue Account",
"label_default": "Contract Revenue Account",
"mandatory": true,
"maps_to": "contract_revenue_segment",
"name": "contract_revenue_segment",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "2d50da4f-939d-4ac3-b526-651155466822",
"is_user_defined": false,
"label_caption": "Carves Liability Account",
"label_default": "Carves Liability Account",
"mandatory": true,
"maps_to": "carves_liability_segment",
"name": "carves_liability_segment",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "65ea4eeb-4612-4c5e-980d-169e58ab81c6",
"is_user_defined": false,
"label_caption": "Carves Revenue Account",
"label_default": "Carves Revenue Account",
"mandatory": true,
"maps_to": "carves_revenue_segment",
"name": "carves_revenue_segment",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "e2be87e3-9b48-4663-ba2b-4a76a67d2bad",
"is_user_defined": false,
"label_caption": "Legal Entity",
"label_default": "Legal Entity",
"mandatory": true,
"maps_to": "legal_entity",
"name": "legal_entity",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "This flag is to determine the order line is usage based booking or not. Valid values are True / False (Case in-sensitive)",
"guid": "a86ae20c-d49d-4e32-8b16-69e3e5fc6238",
"is_user_defined": false,
"label_caption": "Usage Bookings",
"label_default": "Usage Bookings",
"mandatory": true,
"maps_to": "usage_bookings",
"name": "usage_bookings",
"searchable": "false",
"type": "boolean",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": "This flag is to determine the billing for this order line is Accrual basis or not. Valid values are True / False (Case in-sensitive)",
"guid": "07e4a302-0d00-433c-9563-fa015106a3f7",
"is_user_defined": false,
"label_caption": "Usage Billing Revenue Accrual",
"label_default": "Usage Billing Revenue Accrual",
"mandatory": true,
"maps_to": "billing_revenue_accrual",
"name": "billing_revenue_accrual",
"searchable": "false",
"type": "boolean",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007317,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "7fc60f8b-ef1f-4fb7-9df2-b5cf3940d190",
"is_user_defined": false,
"label_caption": "Product ID",
"label_default": "Product ID",
"mandatory": false,
"maps_to": "product_id",
"name": "product_id",
"searchable": "false",
"type": "string",
"updated_at": 1748007317,
"updated_by": "RIGHTREV",
"usedin_policies": false
}
],
"description": "Ingestion template data",
"name": "Ingestion_Data"
}
],
"created_by": "rightrev",
"created_on": 1771847966,
"last_modified_by": "rightrev",
"last_modified_on": 1771847966,
"last_used": 1771847966,
"policy_type": "orders",
"status": "Active",
"unique_key": "columns/guid",
"version_id": null
}
]This API is used to create new fields or update existing fields in the Order Ingestion Configuration Policy.
Path parameters
compliance_idstringRequired
Provide compliance id to retrieve an order ingestion policy details pertaining to that compliance id. Example :abc_123
Body
format_typestringRequired
Format of the data. For e.g. JSON
compliance_namestringRequired
Name of the Policy. Policy Orders
unique_keystringRequired
It's GUID. Globally unique identifier generated by the system.
Responses
200
Create New or Update orders Policy
application/json
compliance_idstringRequired
A system-generated compliance ID on creating or updating the policy.
errorarrayRequired
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
patch/apis/policy-sets/v1/policy/orders/{compliance_id}
PATCH /apis/policy-sets/v1/policy/orders/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 450
{
"compliance_spec": [
{
"columns": [
{
"name": "Test_Field",
"type": "string",
"maps_to": "",
"label_caption": "string",
"label_default": "",
"field_desc": "Test field",
"searchable": false,
"usedin_policies": null,
"mandatory": false,
"can_delete": true,
"is_user_defined": true,
"guid": "1fd71e9b-a9b2-4bbb-a435-0291f4d06106"
}
],
"name": "Ingestion_Data",
"description": "Ingestion template data"
}
],
"format_type": "json",
"compliance_name": "Policy orders",
"unique_key": "columns/guid"
}200
Create New or Update orders Policy
{
"compliance_details": [
{
"error": [],
"message": "created successfully",
"unique_key": "1fd71e9b-a9b2-4bbb-a435-0291f4d06106"
}
],
"compliance_id": "9b001e28-e83d-409e-9245-06a312c389e1",
"error": []
}This API is used to delete the fields in the Order Ingestion Configuration Policy.
Path parameters
compliance_idstringRequired
Provide compliance id to delete an order ingestion policy details pertaining to that compliance id. Example :abc_123
object_unique_valuestringRequired
It's GUID. Globally unique identifier generated by the system
Responses
200
Delete orders Policy
application/json
compliance_detailsarrayRequired
Displays the details of specific rules and standards processed by the system.
compliance_idstringRequired
A system-generated compliance ID on deleting the policy
errorarrayRequired
Displays information about problems that occurred while handling the request. Commonly used to report validation errors, missing or invalid parameters, or other issues related to API processing.
delete/apis/policy-sets/v1/policy/orders/{compliance_id}/{object_unique_value}
DELETE /apis/policy-sets/v1/policy/orders/{compliance_id}/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200
Delete orders Policy
{
"compliance_details": [],
"compliance_id": "3eace16d-00d3-40cc-98eb-4abc847da8b0",
"error": []
}Last updated
Was this helpful?