> For the complete documentation index, see [llms.txt](https://api-docs.realfinity.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.realfinity.io/api/api-reference/loan-query.md).

# Loan Query

Custom, whitelisted queries returning one row per loan - for when the fixed report filters are not enough. Scoped to the calling application's company.

## Custom whitelisted loan query

> Not raw SQL. Fields come from a fixed whitelist (see GET loans/query/fields) and values are
> \
> bound as parameters, so an unknown field key is rejected rather than interpolated. Read-only.

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Loan Query","description":"Custom, whitelisted queries returning one row per loan - for when the fixed report filters are not\r\nenough. Scoped to the calling application's company."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/loans/query":{"post":{"tags":["Loan Query"],"summary":"Custom whitelisted loan query","description":"Not raw SQL. Fields come from a fixed whitelist (see GET loans/query/fields) and values are\r\nbound as parameters, so an unknown field key is rejected rather than interpolated. Read-only.","requestBody":{"content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto"}}}},"responses":{"200":{"description":"Matching loans","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse"}}}},"400":{"description":"Unknown field, operator, or malformed value"},"401":{"description":"Unauthorized"},"403":{"description":"The client application is not authorized to access this resource"},"500":{"description":"Internal Server Error","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}}}}}},"components":{"schemas":{"Realfinity.Public.Api.Models.Reports.QueryLoansRequestDto":{"type":"object","properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Public.Api.Models.Reports.LoanQueryConditionDto"},"description":"WHERE conditions, AND'd. Fields come from a fixed whitelist (GET /loans/query/fields) and values are bound as parameters.","nullable":true},"select":{"type":"array","items":{"type":"string"},"description":"Field keys to return. Defaults to a standard loan summary.","nullable":true},"orderBy":{"type":"string","nullable":true},"orderDescending":{"type":"boolean"},"skip":{"type":"integer","format":"int32"},"top":{"type":"integer","description":"1-50, default 20.","format":"int32"}},"additionalProperties":false,"description":"A custom, whitelisted query returning one row per loan."},"Realfinity.Public.Api.Models.Reports.LoanQueryConditionDto":{"type":"object","properties":{"field":{"type":"string","description":"Whitelisted field key. An unknown key is rejected, never interpolated.","nullable":true},"operator":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryOperator"},"value":{"type":"string","nullable":true},"values":{"type":"array","items":{"type":"string"},"description":"Values for the In operator.","nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Pos.Reporting.LoanQueryOperator":{"enum":["Eq","Ne","Gt","Gte","Lt","Lte","Contains","StartsWith","In"],"type":"string"},"Realfinity.Common.Models.Pos.Reporting.QueryLoansResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"skip":{"type":"integer","format":"int32"},"top":{"type":"integer","format":"int32"},"fields":{"type":"array","items":{"type":"string"},"nullable":true},"rows":{"type":"array","items":{"type":"object","additionalProperties":{}},"nullable":true}},"additionalProperties":false},"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## GET /loans/query/fields

> Fields available to the custom loan query

```json
{"openapi":"3.0.4","info":{"title":"HomeDashboard","version":"v1.2"},"tags":[{"name":"Loan Query","description":"Custom, whitelisted queries returning one row per loan - for when the fixed report filters are not\r\nenough. Scoped to the calling application's company."}],"servers":[{"url":"/homedashboard"}],"security":[{}],"paths":{"/loans/query/fields":{"get":{"tags":["Loan Query"],"summary":"Fields available to the custom loan query","responses":{"200":{"description":"Field whitelist","content":{"application/json;odata.metadata=minimal;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=minimal;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=full;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.metadata=none;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=true;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;odata.streaming=false;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;IEEE754Compatible=false":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/json;IEEE754Compatible=true":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"The client application is not authorized to access this resource"}}}}},"components":{"schemas":{"Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldsResponse":{"type":"object","properties":{"operators":{"type":"array","items":{"type":"string"},"nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldInfo"},"nullable":true}},"additionalProperties":false},"Realfinity.Common.Models.Pos.Reporting.LoanQueryFieldInfo":{"type":"object","properties":{"field":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"canSelect":{"type":"boolean"},"filterOnly":{"type":"boolean"},"requiresUserDataAccess":{"type":"boolean"}},"additionalProperties":false}}}}
```