/api/network/v1/enterprises/{enterpriseId}/clients/allocations/{allocationId}
Returns an allocation or deallocation. For use only by OES clients.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or incomplete.
Examples: Invalid UUID format for allocationId, invalid enterpriseId format.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated partner doesn't have access to the requested allocation
Examples: Enterprise does not have OES license.
404: Not Found Error
Occurs when the requested allocation does not exist for this client
Examples: Allocation with specified ID doesn't exist, allocation exists but belongs to different client
500: Internal Server Error
Occurs when there's an unexpected error processing the request
Examples: Database connection failure, currency mapping error, error transforming allocation data for response
allocationId
stringRequiredenterpriseId
stringRequired>= 1 characters
allocation
object required id
string required amount
One ofrequired connectionId
string required clientExternalId
string required >= 1 characters
partnerExternalId
string >= 1 characters
initiatedBy
string required >= 1 characters
notes
string >= 1 characters
createdAt
string <date-time>
required updatedAt
string <date-time>
required retriable
boolean required reason
>= 1 characters
status
string required cleared
released
reserved
type
string required allocation
deallocation
error
string required error
string required error
string required error
string required