Retrieve Error Transactions

This API retrieves a filtered list of remediable or discarded error transactions (orders, invoices, events, or MJEs) based on the criteria provided in the request payload.

Method - POST

API End Point

/apis/errortransactions/v1/

Payload

  { "transaction_type": "order", 
    "error_warning_type": "remediable",
    "error_warning_code": "ERR-00015", 
    "error_request_id": "95847f5d-44d9-4da4-bc29-cb6f886704e2", 
    "financial_id": "SO_OFID_SNOW_1310_AE_87", 
    "error_from_date": "2025-07-31", 
    "error_to_date": "2025-12-06"
    "legal_entity" : "LE_18"
    }

• NOTE: The API for fetching Remediable and Discarded Error Transactions supports multiple request parameters. All fields provided in the request payload function as filters to narrow down the error records returned in the response. This design allows customers to retrieve only the relevant error transactions based on their operational or audit needs, without requiring all fields to be mandatorily populated.

Screenshot for reference

Response

[
    {
        "compliance_id": "8147084f-9246-49ac-ba3b-771e190e0d7e",
        "compliance_name": "error_transactions",
        "compliance_spec": [
            {
                "bg_run_id": "pi-snow-kri##123366a5-832e-49b3-b8a5-8b89aeec1455",
                "document_details": {
                    "BUNDLE_CONFIG_KEY": "",
                    "Cost_Amount": "",
                    "Deferred_Cost_Account": "",
                    "Recognized_Cost_Account": "",
                    "amendment_reason": "New",
                    "billing_revenue_accrual": false,
                    "carves_eligible": true,
                    "carves_liability_segment": "1111",
                    "carves_revenue_segment": "2222",
                    "contract_liability_segment": "1111",
                    "contract_revenue_segment": "2222",
                    "customer_id": "No Revenue Rule",
                    "customer_name": "KJ_SNOW_1310",
                    "discount_amount": "",
                    "discount_percent": "",
                    "functional_currency": "USD",
                    "functional_exchange_rate": "1",
                    "global_currency": "USD",
                    "global_exchange_rate": "1",
                    "legal_entity": "LE_14",
                    "order_date": "01/01/2021",
                    "order_financial_id": "SO_OFID_SNOW_1310_AE_87",
                    "order_number": "SO_ON_SNOW_1310_AE_1",
                    "order_quantity": "1",
                    "parent_order_reference": "",
                    "po_number": "",
                    "product_id": "",
                    "product_name": "Product_Event_AA",
                    "revenue_end_date": "06/30/2021",
                    "revenue_start_date": "01/01/2021",
                    "source_system": "SFDC",
                    "ssp_date": "",
                    "total_list_price": "14500",
                    "total_sell_price": "11000",
                    "transaction_currency": "USD",
                    "transaction_type": "Order",
                    "unit_list_price": "",
                    "unit_sell_price": "",
                    "usage_bookings": false
                },
                "document_identifier": "SO_OFID_SNOW_1310_AE_87",
                "error_date": "2025-07-31",
                "error_id": "97446309-a14a-4769-bddd-88bb69954996",
                "error_warning_code": "ERR-00015",
                "error_warning_field": "REVENUE_RULE_GUID",
                "error_warning_message": "No valid Revenue Rule Policy available in the system",
                "error_warning_type": "remediable",
                "request_id": "95847f5d-44d9-4da4-bc29-cb6f886704e2",
                "suggestions": "Check and create appropriate revenue rule policy and try re-processing",
                "transaction_type": "ORDER"
            }
        ],
        "total_records": "1"
    }
]

Payload fields description

Field Name	Description	Example
transaction_type	Indicates the type of transaction for which error records are requested. Supported values are order, invoice, event, and mje. This is a mandatory field.	order
error_warning_type	Specifies the category of the error. remediable – errors that can be corrected and reprocessed. discarded – errors that resulted in transaction rejection. Supported values are remediable or discarded	remediable
error_warning_code	Unique code representing the specific error condition encountered during processing.	ERR_00015
error_request_id	Unique identifier assigned to the error occurrence for tracking and audit purposes. This is the request ID of transaction file processed for collection	95847f5d-44d9-4da4-bc29-cb6f886704e2
financial_id	Unique identifier of the impacted transaction. This can be an order financial ID or bill financial ID depending on the transaction type.	GL_Int_RR600.01.01
error_from_date	Start date of the date range for which error transactions should be fetched. Format: YYYY-MM-DD.	2025-01-05
error_to_date	End date of the date range for which error transactions should be fetched. Format: YYYY-MM-DD.	2025-02-05
legal_entity	Users can retrieve error transactions by applying a legal entity filter, which returns errors specific to the selected legal entity.	LE_01