GET api/Purchases/Materials?Filter={Filter}

List all Materials in all Purchase Orders

Request Information

URI Parameters

Name	Description	Type	Additional information
Filter	JSON formated filter (see using filters), see PurchaseMaterialFilterParams	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Purchase.Material

Name	Type	Additional information
PurchaseId	integer	None.
Code	string	None.
Description	string	None.
Quantity	decimal number	None.
Unit	string	None.
Store	BasicDetail	None.
Entity	BasicDetail	None.
UnitCost	decimal number	None.
Discount	decimal number	None.
Supplier	BasicDetail	None.
VAT	decimal number	None.
Account	BasicDetail	None.
QuantityReceived	decimal number	None.
Index	integer	None.
State	MaterialState	None.
Modified	date	None.

Response Formats

Sample:

[
  {
    "PurchaseId": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "Quantity": 4.1,
    "Unit": "sample string 5",
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Entity": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "UnitCost": 6.1,
    "Discount": 7.1,
    "Supplier": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "VAT": 8.1,
    "Account": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "QuantityReceived": 9.1,
    "Index": 10,
    "State": "Pending",
    "Modified": "2025-11-04T23:08:41.4105675+00:00"
  },
  {
    "PurchaseId": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "Quantity": 4.1,
    "Unit": "sample string 5",
    "Store": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Entity": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "UnitCost": 6.1,
    "Discount": 7.1,
    "Supplier": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "VAT": 8.1,
    "Account": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "QuantityReceived": 9.1,
    "Index": 10,
    "State": "Pending",
    "Modified": "2025-11-04T23:08:41.4105675+00:00"
  }
]

Sample:

<ArrayOfMaterial xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Encomendas">
  <Material>
    <Account 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>
    </Account>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Discount>7.1</Discount>
    <Entity 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>
    </Entity>
    <Index>10</Index>
    <Modified>2025-11-04T23:08:41.4105675+00:00</Modified>
    <PurchaseId>1</PurchaseId>
    <Quantity>4.1</Quantity>
    <QuantityReceived>9.1</QuantityReceived>
    <State>Pending</State>
    <Store 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>
    </Store>
    <Supplier 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>
    </Supplier>
    <Unit>sample string 5</Unit>
    <UnitCost>6.1</UnitCost>
    <VAT>8.1</VAT>
  </Material>
  <Material>
    <Account 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>
    </Account>
    <Code>sample string 2</Code>
    <Description>sample string 3</Description>
    <Discount>7.1</Discount>
    <Entity 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>
    </Entity>
    <Index>10</Index>
    <Modified>2025-11-04T23:08:41.4105675+00:00</Modified>
    <PurchaseId>1</PurchaseId>
    <Quantity>4.1</Quantity>
    <QuantityReceived>9.1</QuantityReceived>
    <State>Pending</State>
    <Store 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>
    </Store>
    <Supplier 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>
    </Supplier>
    <Unit>sample string 5</Unit>
    <UnitCost>6.1</UnitCost>
    <VAT>8.1</VAT>
  </Material>
</ArrayOfMaterial>

Sample:

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

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

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

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

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Unit"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Store.Code"

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

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

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

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

6.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Discount"

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

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

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

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

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

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

9.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Index"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].State"

Pending
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Modified"

2025-11-04T23:08:41.4105675+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].PurchaseId"

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

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

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

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Store.Code"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2025-11-04T23:08:41.4105675+00:00
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file