GET api/Purchases?Filter={Filter}

List all purchase orders

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Collection of Purchase

Name	Type	Additional information
Id	integer	None.
Code	string	None.
Description	string	None.
State	Purchase.State	None.
Date	date	None.
NecessaryDate	date	None.
Manager	BasicDetail	None.
Supplier	BasicDetail	None.
DeliveryLocation	BasicDetail	None.
PaymentCondition	BasicDetail	None.
Amount	decimal number	None.
AdditionalExpensesDiscounts	decimal number	None.
SpecialConditions	string	None.
Notes	string	None.
UserCode1	string	None.
UserCode2	string	None.
Reference	string	None.
Modified	date	None.

Response Formats

Sample:

[
  {
    "Id": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "State": "Issued",
    "Date": "2025-11-05T01:43:37.8623969+00:00",
    "NecessaryDate": "2025-11-05T01:43:37.8623969+00:00",
    "Manager": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Supplier": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "DeliveryLocation": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "PaymentCondition": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Amount": 6.1,
    "AdditionalExpensesDiscounts": 7.1,
    "SpecialConditions": "sample string 8",
    "Notes": "sample string 9",
    "UserCode1": "sample string 10",
    "UserCode2": "sample string 11",
    "Reference": "sample string 12",
    "Modified": "2025-11-05T01:43:37.8623969+00:00"
  },
  {
    "Id": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "State": "Issued",
    "Date": "2025-11-05T01:43:37.8623969+00:00",
    "NecessaryDate": "2025-11-05T01:43:37.8623969+00:00",
    "Manager": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Supplier": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "DeliveryLocation": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "PaymentCondition": {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    "Amount": 6.1,
    "AdditionalExpensesDiscounts": 7.1,
    "SpecialConditions": "sample string 8",
    "Notes": "sample string 9",
    "UserCode1": "sample string 10",
    "UserCode2": "sample string 11",
    "Reference": "sample string 12",
    "Modified": "2025-11-05T01:43:37.8623969+00:00"
  }
]

Sample:

<ArrayOfPurchase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models.Encomendas">
  <Purchase>
    <AdditionalExpensesDiscounts>7.1</AdditionalExpensesDiscounts>
    <Amount>6.1</Amount>
    <Code>sample string 2</Code>
    <Date>2025-11-05T01:43:37.8623969+00:00</Date>
    <DeliveryLocation 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>
    </DeliveryLocation>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Manager 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>
    </Manager>
    <Modified>2025-11-05T01:43:37.8623969+00:00</Modified>
    <NecessaryDate>2025-11-05T01:43:37.8623969+00:00</NecessaryDate>
    <Notes>sample string 9</Notes>
    <PaymentCondition 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>
    </PaymentCondition>
    <Reference>sample string 12</Reference>
    <SpecialConditions>sample string 8</SpecialConditions>
    <State>Issued</State>
    <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>
    <UserCode1>sample string 10</UserCode1>
    <UserCode2>sample string 11</UserCode2>
  </Purchase>
  <Purchase>
    <AdditionalExpensesDiscounts>7.1</AdditionalExpensesDiscounts>
    <Amount>6.1</Amount>
    <Code>sample string 2</Code>
    <Date>2025-11-05T01:43:37.8623969+00:00</Date>
    <DeliveryLocation 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>
    </DeliveryLocation>
    <Description>sample string 3</Description>
    <Id>1</Id>
    <Manager 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>
    </Manager>
    <Modified>2025-11-05T01:43:37.8623969+00:00</Modified>
    <NecessaryDate>2025-11-05T01:43:37.8623969+00:00</NecessaryDate>
    <Notes>sample string 9</Notes>
    <PaymentCondition 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>
    </PaymentCondition>
    <Reference>sample string 12</Reference>
    <SpecialConditions>sample string 8</SpecialConditions>
    <State>Issued</State>
    <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>
    <UserCode1>sample string 10</UserCode1>
    <UserCode2>sample string 11</UserCode2>
  </Purchase>
</ArrayOfPurchase>

Sample:

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

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].State"

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

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].NecessaryDate"

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Manager.Code"

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

sample string 2
--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].DeliveryLocation.Code"

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

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

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

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

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

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

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

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

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

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

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

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Id"

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].State"

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

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].NecessaryDate"

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Manager.Code"

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

sample string 2
--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].DeliveryLocation.Code"

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

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

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

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

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

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

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

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

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

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

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

2025-11-05T01:43:37.8623969+00:00
--MultipartDataMediaFormatterBoundary1q2w3e--

Sample:

Returns an excel file