/api/network/v1/enterprises/{enterpriseId}/clients/allocations
This API call allows clients to get a list of allocations and deallocations for any connected network account. or "deallocation" to view deallocations.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed.
Examples: Empty string provided for enterpriseId, invalid UUID format for allocationId. invalid date format for createdOnOrAfter/createdBefore, invalid pagination parameters.
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 specified enterprise cannot be found.
Examples: Enterprise ID doesn't exist or doesn't belong to the client.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues, error retrieving allocations data, error transforming allocation data for response.
enterpriseId
stringRequired>= 1 characters
allocationIds
array[string]types
array[string]allocation
deallocation
statuses
array[string]cleared
released
reserved
currencies
array[string]connectionIds
array[string]partnerIds
array[string]createdOnOrAfter
string<date-time>
createdBefore
string<date-time>
pageNumber
string<integer>
pageSize
stringsortField
stringid
updatedAt
quantity
currency
sortDirection
stringASC
DESC
allocations
array[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