DocumentGetEvents Method Overview

The DocumentGetEvents method allows you to retrieve events associated with an electronic document—whether it is a commercial event or a RADIAN event— using its CUFE or its global or local identifiers as reference points. This method offers flexible search options but also includes important restrictions that must be considered.

Usage restriction:

Each client is limited to 52 queries per month. Once this limit is reached, the method cannot be used again until the next monthly cycle begins.

Key functionality:

The method supports:

• Querying a single CUFE: Retrieves all events recorded for a specific document using its CUFE.
• Querying a single Commercial or RADIAN event, or all associated events: You may limit the query to a specific event or request the entire event history for the document.

Document identification parameters:

The method can receive two types of identifiers:

• GlobalDocumentId: the global identifier within the platform.
• CountryDocumentId: the country’s local fiscal identifier.

The logic used to determine which identifier is applied follows these rules:

Use of GlobalDocumentId

• If only GlobalDocumentId is sent → GlobalDocumentId is used.
• If both GlobalDocumentId and CountryDocumentId are sent → CountryDocumentId takes precedence.

Use of CountryDocumentId

• If only CountryDocumentId is sent → CountryDocumentId is used.
• If both are sent → CountryDocumentId again takes precedence.

In summary: whenever CountryDocumentId is provided, it will always be the identifier used for the query.

Status parameter:

The status parameter determines which event(s) to retrieve. Its rules are:

• Querying a single event: A 3-character event code must be provided (e.g., 030).
• Querying all events: If the value all is sent, the method will return all events associated with the CUFE.
• Error for empty status: If status is submitted empty, the method will return an error indicating that the parameter is mandatory.

Summary:

• Allows querying a CUFE, a specific event, or a full event history.
• Enforces a limit of 52 queries per month per client.
• Uses the following identifier priority: CountryDocumentId overrides GlobalDocumentId whenever both are provided.
• Uses the status parameter to determine whether to fetch a single event or all events.
• Does not accept an empty status parameter.