Get Partner Client Revenue Status

Processing Status

The response contains a top level property status
This property indicates the condition of the overall processing of all items sent in an original request to the Create Partner Client Revenue endpoint.

The following values are valid for status:

• Pending : It indicates processing of all items in a request is waiting to start OR is in progress
• Completed : Processing of all items has finished

Understanding result Property

The top level property status, when Completed only indicates the overall processing of all items in the original request payload has finished. It does not indicate if any errors were found in the original request payload.

The result property contains and array of objects, each consisting of two child properties:

• data : The original item sent as part of a POST request to Create Partner Client Revenue
• status : The processing result which indicates the condition of the associated data item and contains state and validation_errors properties that describe the outcome of processing

To verify that all items in the original request payload were successfully processed and saved to our datastore, a check against each item state is required.

Valid state Values

There are several statuses that the state property can be:

• Pending : The associated data item is waiting to be processed
• Duplicate : The associated data item has been deemed a duplicate
• Conflict : The associated data item has been deemed a conflict with another data item in the original request
• Failed : The associated data item has failed validation
• Completed : The associated data item has passed validation and was saved to our data store

result[index].status.state Failure Statuses

Any data item which has a state of Duplicate, Conflict or Failed will not be saved to our data stores.

Duplicate

When a state has a value of Duplicate, it indicates one of two conditions has been met:

1. The associated data item is a perfect duplicate of another item in the original request, the first item in the original request was processed as unique and will provide its own state to indicate if Completed successfully and saved
2. The associated data item is a duplicate of a record we have already seen and saved to our data store

The validation_errors property will contain a string error which describes which one of the above conditions was met.

Conflict

When a state has a value of Conflict, it indicates:

The associated data item is a duplicate of another data item in the original request by the unique key unique_reference - however the data differs in the duplicates.

When this condition is met, those data items that are deemed duplicates by unique key unique_reference will all have a state of Conflict as we are unable to determine which one is valid to process and save.

Failed

When a state has a value of Failed, it indicates:

The associated data item failed our validation routines and was not saved.

The validation_errors property will contain a string error which describes which one of the above conditions was met.

It is recommended a client logs this information as it could indicate the data in the data item contains malformed values and as such invalid.

A retry of the failed data item can be actioned once the validation_errors have been addressed.