Invoice Ingestion Configuration
Defines how invoice-related field data is received, updated, and processed during ingestion through APIs.
This API is used to retrieve all the Invoice Ingestion Configuration Policy details.
Responses
200
Get Order Ingestion Configuration Policy
application/json
compliance_idstringRequired
A system-generated compliance ID to retrieve the Invoice 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 invoices
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/invoices
GET /apis/policy-sets/v1/policy/invoices HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200
Get Order Ingestion Configuration Policy
[
{
"compliance_id": "3189805c-dc91-4e25-bea0-04fd50731770",
"compliance_name": "Default Invoice Ingestion Policy",
"compliance_spec": [
{
"columns": [
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": "Name of the source system where data pulled into RightRev. Example: Oracle, Workday, etc",
"guid": "07eb1157-c736-4cce-9aff-60342909e374",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": "Type of the transaction data. Valid values are: Invoice / Invoices (case in-sensitive)",
"guid": "d708a539-faf6-49db-9aeb-96925528ec17",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "6a5666d1-0a58-4396-9dd2-80572323c92f",
"is_user_defined": false,
"label_caption": "Bill Number",
"label_default": "Bill Number",
"mandatory": false,
"maps_to": "bill_number",
"name": "bill_number",
"searchable": "false",
"type": "string",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "a7cdbf9a-04df-43fe-bf71-880b210b7609",
"is_user_defined": false,
"label_caption": "Bill Date",
"label_default": "Bill Date",
"mandatory": true,
"maps_to": "bill_date",
"name": "bill_date",
"searchable": "false",
"type": "date",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": "Unique identifier number of each Invoice line transaction data. Can have Alphanumeric values",
"guid": "75652945-5012-4967-bf98-58e914f7d047",
"is_user_defined": false,
"label_caption": "Invoice Financial ID",
"label_default": "Invoice Financial ID",
"mandatory": true,
"maps_to": "bill_financial_id",
"name": "bill_financial_id",
"searchable": "false",
"type": "string",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "3683cfd8-4949-492d-ae04-8e3c1626280a",
"is_user_defined": false,
"label_caption": "Bill Quantity",
"label_default": "Bill Quantity",
"mandatory": true,
"maps_to": "bill_qty",
"name": "bill_qty",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "84de17e3-2f19-4510-b473-dbf53a06e780",
"is_user_defined": false,
"label_caption": "Bill Amount",
"label_default": "Bill Amount",
"mandatory": true,
"maps_to": "bill_amount",
"name": "bill_amount",
"searchable": "false",
"type": "decimal",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "470ed6fa-ff98-49d4-96d8-c0410ab9fbfa",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "933afacd-3ff0-4e86-a202-b8df65217c4b",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": "The currency of the transaction of this order with the customer. Should be an valid currency code.",
"guid": "ab72f2d7-a912-4eeb-9015-94a7081a21b8",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "d3ea41b7-5a13-422a-aa74-6b863bf1b068",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "141a90e1-580f-4496-b4d6-99656d62f2a5",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "9169db5b-e2b1-4e10-b361-e546278fd51b",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": null,
"guid": "fa54015a-5b87-4f8e-a81e-96db79e508fc",
"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": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
},
{
"can_delete": false,
"created_at": 1748007318,
"created_by": "RIGHTREV",
"field_desc": "This field needs to have valid corresponding order line financial id of this Invoice line",
"guid": "efca8d16-23d4-411f-9dd6-21b2c40fad88",
"is_user_defined": false,
"label_caption": "Reference Financial ID",
"label_default": "Reference Financial ID",
"mandatory": true,
"maps_to": "reference_financial_id",
"name": "reference_financial_id",
"searchable": "true",
"type": "string",
"updated_at": 1748007318,
"updated_by": "RIGHTREV",
"usedin_policies": false
}
],
"description": "Ingestion template data",
"name": "Ingestion_Data"
}
],
"created_by": "rightrev",
"created_on": 1771849304,
"last_modified_by": "rightrev",
"last_modified_on": 1771849304,
"last_used": 1771849304,
"policy_type": "invoices",
"status": "Active",
"unique_key": "columns/guid",
"version_id": null
}
]This API is used to create new fields or update existing fields in the Invoice 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
Update invoices 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/invoices/{compliance_id}
PATCH /apis/policy-sets/v1/policy/invoices/{compliance_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: application/json
Accept: */*
Content-Length: 468
{
"compliance_spec": [
{
"columns": [
{
"name": "Test_Invoice_Field",
"type": "string",
"maps_to": "",
"label_caption": "string",
"label_default": "",
"field_desc": "Test Invoice Field",
"searchable": false,
"usedin_policies": null,
"mandatory": false,
"can_delete": true,
"is_user_defined": true,
"guid": "da5475ce-384d-4842-9574-daf8c29b526a"
}
],
"name": "Ingestion_Data",
"description": "Ingestion template data"
}
],
"format_type": "json",
"compliance_name": "Policy invoices",
"unique_key": "columns/guid"
}200
Update invoices Policy
{
"compliance_details": [
{
"error": [],
"message": "created successfully",
"unique_key": "1fd71e9b-a9b2-4bbb-a435-0291f4d06106"
}
],
"compliance_id": "9b001e28-e83d-409e-9245-06a312c389e1",
"error": []
}Delete Invoices Policy
delete/apis/policy-sets/v1/policy/invoices/{compliance_id}/{object_unique_value}
This API is used to delete the fields in the Invoice Ingestion Configuration Policy.
Path parameters
compliance_idstringRequired
Provide compliance id to delete an invoice 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 invoices 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/invoices/{compliance_id}/{object_unique_value}
DELETE /apis/policy-sets/v1/policy/invoices/{compliance_id}/{object_unique_value} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*
200
Delete invoices policy
{
"compliance_details": [],
"compliance_id": "3eace16d-00d3-40cc-98eb-4abc847da8b0",
"error": []
}PreviousOrder Ingestion Configuration
NextTransaction Ingestion (Order, Invoices, Events & Bulk Uploads)
Last updated
Was this helpful?