Get client allocation or deallocation

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the allocation to retrieve. This is a UUID that uniquely identifies the allocation record.

string
required
length ≥ 1

The enterprise identifier of the client. This identifies the client enterprise that owns the allocation.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json