Fields

accountNumber : String

The account number provided to the exception.
apiCalls : [APICallType]

The API calls associated with this exception if any.
assignedUser : AssignedUserType

The user assigned to handle this exception if any.
category : APIExceptionCategories

Category associated with this exception.
channel : String! required

Free field for the API caller to categorise a channel. This could be (but not limited to) the client's team that calleded the API, the name of the 'flow' the call belongs to, etc.
context : JSONString

Storage for the API client to submit any contextual information.
createdAt : DateTime! required
customerContact : String

The customer contact provided to the exception.
events : [APIExceptionEventType]

The events associated with this exception if any.
externalIdentifier : String! required

External identifier submitted by the API client to track this exception on their end.
id : ID! required
keyDate : Date

The key date associated with the exception, if available.
notes : [APIExceptionNoteType]

Notes associated with this exception if any.
operationsTeam : OperationsTeamType

The operations team assigned to this exception if any.
priority : APIExceptionPriority! required

The current priority for the API exception.
resolutionStatus : APIExceptionResolutionStatus! required

The current resolution status for the API exception.
resolutionType : APIExceptionResolutionType! required

The current resolution type for the API exception.
supplyPointIdentifier : String

The supply point identifier provided to the exception.
tags : [APIExceptionTags]

Tags associated with this exception if any.
userId : BigInt

The user id provided to the exception.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-4A8C0B61", "apiCalls": [APICallType], "assignedUser": AssignedUserType, "category": "UNKNOWN", "channel": "far-others-last-finish-as", "context": {"key": "value"}, "createdAt": "2021-09-06T15:36:11.388575+00:00", "customerContact": "wide-wide-born-Democrat-pay", "events": [APIExceptionEventType], "externalIdentifier": "82868575", "id": "72937390", "keyDate": "2007-06-13", "notes": [APIExceptionNoteType], "operationsTeam": OperationsTeamType, "priority": "LOW", "resolutionStatus": "ASSIGNED", "resolutionType": "AUTOMATIC", "supplyPointIdentifier": "44773933", "tags": "MOVE_IN", "userId": 1 }