---
title: "Lusid.Allocation"
slug: "lusidallocation"
tags: ["luminesce ", "provider", "oms"]
updated: 2024-08-29T10:47:05Z
published: 2024-08-29T10:47:05Z
canonical: "support.lusid.com/lusidallocation"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.lusid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lusid.Allocation

| **Type** | **Read/write** | **Author** | **Availability** |
| --- | --- | --- | --- |
| [Data provider](/v1/docs/what-are-a-data-provider-and-a-direct-provider) | Read | FINBOURNE | Provided with LUSID |

Providing you have sufficient [access control permissions](/v1/docs/creating-policies-to-control-access-to-providers-for-different-luminesce-end-users), the `Lusid.Allocation` provider enables you to write a [Luminesce SQL query](/v1/docs/understanding-the-luminesce-sql-query-syntax) that retrieves [allocations](/v1/docs/what-is-an-allocation-in-lusid) stored in LUSID.

> **Note**: By default, `Lusid.Allocation` cannot retrieve properties for allocations. To do this, you must first configure `Lusid.Allocation` to 'inline' properties. [See how to do this](/v1/docs/how-do-i-configure-luminesce-entity-providers-to-readwrite-properties).

**See also**: [Lusid.Allocation.Writer](/v1/docs/lusidallocationwriter)

## Basic usage

```sql
select * from Lusid.Allocation where <filter-expression>
```

## Query parameters

`Lusid.Allocation` has parameters that enable you to filter or refine a query.

To list available parameters, their data types, default values, and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.Allocation' and FieldType = 'Parameter';
```

## Data fields

By default, `Lusid.Allocation` returns a table of data populated with particular fields (columns). You can return a subset of these fields.

To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a [suitable tool](/v1/docs/what-tools-are-available-to-write-luminesce-queries):

```sql
select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.Allocation' and FieldType = 'Column';
```

> **Note:** Fields marked 'main' are returned by queries that select a caret character, for example `select ^ from Lusid.Allocation`.

## Examples

> **Note:** For more example Luminesce SQL queries, visit our [Github repo](https://github.com/finbourne/luminesce-examples/tree/master/examples).

### Example 1: Retrieve first ten allocations

```sql
select * from Lusid.Allocation limit 10;
```

### Example 2: Retrieve a particular allocation

```sql
select * from Lusid.Allocation where AllocationScope = 'Finbourne-Examples' and AllocationCode = 'ALLOCATION-123';
```

### Example 3: Retrieve allocations for a portfolio on a particular day

```sql
select * from Lusid.Allocation 
where PortfolioScope = 'Finbourne-Examples' 
and PortfolioCode = 'UK-Equities'
and AllocationDate between #2023-07-12# and #2023-07-13#;
```

### Example 4: Retrieve allocations and other information for a particular instrument

```sql
select ^ from Lusid.Allocation a
join Lusid.Instrument i
  on a.LusidInstrumentId = i.LusidInstrumentId;
```