GET api/PurchaseRequests?Offset={Offset}&Limit={Limit}&Sort={Sort}&Filter={Filter}

List all purchase requests

Request Information

URI Parameters

NameDescriptionTypeAdditional information
See using pagination
Offset

Number of items to skip from the start

integer

Equal or above: 0

Limit

Maximum number of items to return

integer

Equal or above: 1

Sort

Field to sort by

string

None.

Filter

JSON formated filter (see using filters), see PurchaseRequestFilterParams

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PurchaseRequestBasic
NameDescriptionTypeAdditional information
Id

The Purchase Request Id

integer

None.

Title

The Purchase Request Title

string

None.

Date

The Purchase Request Date

date

None.

State

The Purchase Request State

PurchaseRequest.State

None.

Employee

The Purchase Request Employee

BasicDetail

None.

TotalCost

The total cost of the request

decimal number

None.

Notes

The Purchase Request Notes

string

None.

Response Formats

Sample:
[
  {
    "Id": 1,
    "Title": "sample string 2",
    "Date": "2025-06-12T11:04:34.4126477+01:00",
    "State": "Approved",
    "Employee": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "TotalCost": 3.1,
    "Notes": "sample string 4"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Date": "2025-06-12T11:04:34.4126477+01:00",
    "State": "Approved",
    "Employee": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "TotalCost": 3.1,
    "Notes": "sample string 4"
  }
]
Sample:
<ArrayOfPurchaseRequestBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Purchase">
  <PurchaseRequestBasic>
    <Date>2025-06-12T11:04:34.4126477+01:00</Date>
    <Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">
      <d3p1:Code>sample string 1</d3p1:Code>
      <d3p1:Description>sample string 2</d3p1:Description>
    </Employee>
    <Id>1</Id>
    <Notes>sample string 4</Notes>
    <State>Approved</State>
    <Title>sample string 2</Title>
    <TotalCost>3.1</TotalCost>
  </PurchaseRequestBasic>
  <PurchaseRequestBasic>
    <Date>2025-06-12T11:04:34.4126477+01:00</Date>
    <Employee xmlns:d3p1="http://schemas.datacontract.org/2004/07/WebAPI.Models.ManWinWin">
      <d3p1:Code>sample string 1</d3p1:Code>
      <d3p1:Description>sample string 2</d3p1:Description>
    </Employee>
    <Id>1</Id>
    <Notes>sample string 4</Notes>
    <State>Approved</State>
    <Title>sample string 2</Title>
    <TotalCost>3.1</TotalCost>
  </PurchaseRequestBasic>
</ArrayOfPurchaseRequestBasic>
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Title"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Date"

2025-06-12T11:04:34.4126477+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].State"

Approved
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Employee.Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Employee.Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].TotalCost"

3.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Title"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Date"

2025-06-12T11:04:34.4126477+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].State"

Approved
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Employee.Code"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Employee.Description"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].TotalCost"

3.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file