POST api/PurchaseOrder/ListPurchaseOrder

Request Information

URI Parameters

None.

Body Parameters

SearchPurchaseOrderRequest
NameDescriptionTypeAdditional information
From

date

None.

To

date

None.

Status

integer

None.

CreatedId

globally unique identifier

None.

ImporterId

globally unique identifier

None.

SupplierId

integer

None.

KeySearch

string

None.

PageSize

integer

None.

PageIndex

integer

None.

ProductId

globally unique identifier

None.

UnpaidSuppliers

boolean

None.

IsSearchError

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "From": "2025-10-26T13:01:26.1071016+07:00",
  "To": "2025-10-26T13:01:26.1071016+07:00",
  "Status": 1,
  "CreatedId": "dd455a88-e265-4fc6-99c3-66843e6f3dc2",
  "ImporterId": "4ed8572c-bcc3-4e0f-b6aa-f9659fd9ec30",
  "SupplierId": 1,
  "KeySearch": "sample string 1",
  "PageSize": 1,
  "PageIndex": 1,
  "ProductId": "edef2749-e036-48b6-86b5-18645c637568",
  "UnpaidSuppliers": true,
  "IsSearchError": true
}

application/xml, text/xml

Sample:
<SearchPurchaseOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Model.Request.PurchaseOrder">
  <CreatedId>dd455a88-e265-4fc6-99c3-66843e6f3dc2</CreatedId>
  <From>2025-10-26T13:01:26.1071016+07:00</From>
  <ImporterId>4ed8572c-bcc3-4e0f-b6aa-f9659fd9ec30</ImporterId>
  <IsSearchError>true</IsSearchError>
  <KeySearch>sample string 1</KeySearch>
  <PageIndex>1</PageIndex>
  <PageSize>1</PageSize>
  <ProductId>edef2749-e036-48b6-86b5-18645c637568</ProductId>
  <Status>1</Status>
  <SupplierId>1</SupplierId>
  <To>2025-10-26T13:01:26.1071016+07:00</To>
  <UnpaidSuppliers>true</UnpaidSuppliers>
</SearchPurchaseOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaginatorResponseOfListPurchaseOrderResponse
NameDescriptionTypeAdditional information
Count

integer

None.

TotalMoney

decimal number

None.

PayingAmount

decimal number

None.

TotalIncome

decimal number

None.

TotalSpend

decimal number

None.

TotalDebt

decimal number

None.

TotalOrderAmount

decimal number

None.

TotalPaid

decimal number

None.

Items

Collection of ListPurchaseOrderResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "Count": 1,
  "TotalMoney": 2.0,
  "PayingAmount": 3.0,
  "TotalIncome": 4.0,
  "TotalSpend": 5.0,
  "TotalDebt": 6.0,
  "TotalOrderAmount": 7.0,
  "TotalPaid": 8.0,
  "Items": [
    {
      "Code": "sample string 1",
      "CreatedId": "beeaca42-3be9-48f3-a9c6-8a2237b7ae73",
      "CreatedTime": "2025-10-26T13:01:26.1549149+07:00",
      "Status": 0,
      "StatusStr": "Phiếu tạm",
      "TotalOrder": 4.0,
      "Note": "sample string 5",
      "Discount": 1.0,
      "DiscountType": 1,
      "SupplierId": 1,
      "SupplierName": "sample string 6",
      "Debt": 1.0,
      "PayingAmount": 7.0,
      "RemainingDebt": 8.0,
      "PurchaseOrderDateTime": "2025-10-26T13:01:26.1587017+07:00",
      "Id": "91ef2a7a-10a9-4d35-b35e-5940e63d8aa2",
      "ImporterId": "577c5ba1-deb9-4944-934c-0e4315dd2c0b",
      "UpdatedId": "380c309d-4110-47c8-a54e-9076977ac065",
      "UpdatedTime": "2025-10-26T13:01:26.1587017+07:00",
      "ProductIds": [
        "fafdf397-ed74-4cad-8898-011ec0e6d41a",
        "3c85cbe3-17f5-45dd-99f0-3f49e950c476"
      ],
      "PaymentType": 12,
      "PurchaseOrderItemDtos": [
        {
          "Id": 1,
          "ProductId": "e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3",
          "Quantity": 3,
          "UnitPrice": 4.0,
          "Discount": 5.0,
          "DiscountType": 6,
          "TotalPrice": 7.0,
          "Note": "sample string 8",
          "PurchaseOrderId": "12a2f9ee-c240-4b67-9273-089a1c43f5b5",
          "ProductCode": "sample string 10",
          "ProductName": "sample string 11",
          "SupplierName": "sample string 12"
        },
        {
          "Id": 1,
          "ProductId": "e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3",
          "Quantity": 3,
          "UnitPrice": 4.0,
          "Discount": 5.0,
          "DiscountType": 6,
          "TotalPrice": 7.0,
          "Note": "sample string 8",
          "PurchaseOrderId": "12a2f9ee-c240-4b67-9273-089a1c43f5b5",
          "ProductCode": "sample string 10",
          "ProductName": "sample string 11",
          "SupplierName": "sample string 12"
        }
      ]
    },
    {
      "Code": "sample string 1",
      "CreatedId": "beeaca42-3be9-48f3-a9c6-8a2237b7ae73",
      "CreatedTime": "2025-10-26T13:01:26.1549149+07:00",
      "Status": 0,
      "StatusStr": "Phiếu tạm",
      "TotalOrder": 4.0,
      "Note": "sample string 5",
      "Discount": 1.0,
      "DiscountType": 1,
      "SupplierId": 1,
      "SupplierName": "sample string 6",
      "Debt": 1.0,
      "PayingAmount": 7.0,
      "RemainingDebt": 8.0,
      "PurchaseOrderDateTime": "2025-10-26T13:01:26.1587017+07:00",
      "Id": "91ef2a7a-10a9-4d35-b35e-5940e63d8aa2",
      "ImporterId": "577c5ba1-deb9-4944-934c-0e4315dd2c0b",
      "UpdatedId": "380c309d-4110-47c8-a54e-9076977ac065",
      "UpdatedTime": "2025-10-26T13:01:26.1587017+07:00",
      "ProductIds": [
        "fafdf397-ed74-4cad-8898-011ec0e6d41a",
        "3c85cbe3-17f5-45dd-99f0-3f49e950c476"
      ],
      "PaymentType": 12,
      "PurchaseOrderItemDtos": [
        {
          "Id": 1,
          "ProductId": "e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3",
          "Quantity": 3,
          "UnitPrice": 4.0,
          "Discount": 5.0,
          "DiscountType": 6,
          "TotalPrice": 7.0,
          "Note": "sample string 8",
          "PurchaseOrderId": "12a2f9ee-c240-4b67-9273-089a1c43f5b5",
          "ProductCode": "sample string 10",
          "ProductName": "sample string 11",
          "SupplierName": "sample string 12"
        },
        {
          "Id": 1,
          "ProductId": "e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3",
          "Quantity": 3,
          "UnitPrice": 4.0,
          "Discount": 5.0,
          "DiscountType": 6,
          "TotalPrice": 7.0,
          "Note": "sample string 8",
          "PurchaseOrderId": "12a2f9ee-c240-4b67-9273-089a1c43f5b5",
          "ProductCode": "sample string 10",
          "ProductName": "sample string 11",
          "SupplierName": "sample string 12"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<PaginatorResponseOfListPurchaseOrderResponsezelsgFU8 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Model.Generics">
  <Count>1</Count>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Common.Model.Response.PurchaseOrder">
    <d2p1:ListPurchaseOrderResponse>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:CreatedId>beeaca42-3be9-48f3-a9c6-8a2237b7ae73</d2p1:CreatedId>
      <d2p1:CreatedTime>2025-10-26T13:01:26.1549149+07:00</d2p1:CreatedTime>
      <d2p1:Debt>1</d2p1:Debt>
      <d2p1:Discount>1</d2p1:Discount>
      <d2p1:DiscountType>1</d2p1:DiscountType>
      <d2p1:Id>91ef2a7a-10a9-4d35-b35e-5940e63d8aa2</d2p1:Id>
      <d2p1:ImporterId>577c5ba1-deb9-4944-934c-0e4315dd2c0b</d2p1:ImporterId>
      <d2p1:Note>sample string 5</d2p1:Note>
      <d2p1:PayingAmount>7</d2p1:PayingAmount>
      <d2p1:PaymentType>12</d2p1:PaymentType>
      <d2p1:ProductIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>fafdf397-ed74-4cad-8898-011ec0e6d41a</d4p1:guid>
        <d4p1:guid>3c85cbe3-17f5-45dd-99f0-3f49e950c476</d4p1:guid>
      </d2p1:ProductIds>
      <d2p1:PurchaseOrderDateTime>2025-10-26T13:01:26.1587017+07:00</d2p1:PurchaseOrderDateTime>
      <d2p1:PurchaseOrderItemDtos xmlns:d4p1="http://schemas.datacontract.org/2004/07/Common.Model.Dto.PurchaseOrder">
        <d4p1:PurchaseOrderItemDto>
          <d4p1:Discount>5</d4p1:Discount>
          <d4p1:DiscountType>6</d4p1:DiscountType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Note>sample string 8</d4p1:Note>
          <d4p1:ProductCode>sample string 10</d4p1:ProductCode>
          <d4p1:ProductId>e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3</d4p1:ProductId>
          <d4p1:ProductName>sample string 11</d4p1:ProductName>
          <d4p1:PurchaseOrderId>12a2f9ee-c240-4b67-9273-089a1c43f5b5</d4p1:PurchaseOrderId>
          <d4p1:Quantity>3</d4p1:Quantity>
          <d4p1:SupplierName>sample string 12</d4p1:SupplierName>
          <d4p1:TotalPrice>7</d4p1:TotalPrice>
          <d4p1:UnitPrice>4</d4p1:UnitPrice>
        </d4p1:PurchaseOrderItemDto>
        <d4p1:PurchaseOrderItemDto>
          <d4p1:Discount>5</d4p1:Discount>
          <d4p1:DiscountType>6</d4p1:DiscountType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Note>sample string 8</d4p1:Note>
          <d4p1:ProductCode>sample string 10</d4p1:ProductCode>
          <d4p1:ProductId>e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3</d4p1:ProductId>
          <d4p1:ProductName>sample string 11</d4p1:ProductName>
          <d4p1:PurchaseOrderId>12a2f9ee-c240-4b67-9273-089a1c43f5b5</d4p1:PurchaseOrderId>
          <d4p1:Quantity>3</d4p1:Quantity>
          <d4p1:SupplierName>sample string 12</d4p1:SupplierName>
          <d4p1:TotalPrice>7</d4p1:TotalPrice>
          <d4p1:UnitPrice>4</d4p1:UnitPrice>
        </d4p1:PurchaseOrderItemDto>
      </d2p1:PurchaseOrderItemDtos>
      <d2p1:RemainingDebt>8</d2p1:RemainingDebt>
      <d2p1:Status>DRAFT</d2p1:Status>
      <d2p1:SupplierId>1</d2p1:SupplierId>
      <d2p1:SupplierName>sample string 6</d2p1:SupplierName>
      <d2p1:TotalOrder>4</d2p1:TotalOrder>
      <d2p1:UpdatedId>380c309d-4110-47c8-a54e-9076977ac065</d2p1:UpdatedId>
      <d2p1:UpdatedTime>2025-10-26T13:01:26.1587017+07:00</d2p1:UpdatedTime>
    </d2p1:ListPurchaseOrderResponse>
    <d2p1:ListPurchaseOrderResponse>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:CreatedId>beeaca42-3be9-48f3-a9c6-8a2237b7ae73</d2p1:CreatedId>
      <d2p1:CreatedTime>2025-10-26T13:01:26.1549149+07:00</d2p1:CreatedTime>
      <d2p1:Debt>1</d2p1:Debt>
      <d2p1:Discount>1</d2p1:Discount>
      <d2p1:DiscountType>1</d2p1:DiscountType>
      <d2p1:Id>91ef2a7a-10a9-4d35-b35e-5940e63d8aa2</d2p1:Id>
      <d2p1:ImporterId>577c5ba1-deb9-4944-934c-0e4315dd2c0b</d2p1:ImporterId>
      <d2p1:Note>sample string 5</d2p1:Note>
      <d2p1:PayingAmount>7</d2p1:PayingAmount>
      <d2p1:PaymentType>12</d2p1:PaymentType>
      <d2p1:ProductIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>fafdf397-ed74-4cad-8898-011ec0e6d41a</d4p1:guid>
        <d4p1:guid>3c85cbe3-17f5-45dd-99f0-3f49e950c476</d4p1:guid>
      </d2p1:ProductIds>
      <d2p1:PurchaseOrderDateTime>2025-10-26T13:01:26.1587017+07:00</d2p1:PurchaseOrderDateTime>
      <d2p1:PurchaseOrderItemDtos xmlns:d4p1="http://schemas.datacontract.org/2004/07/Common.Model.Dto.PurchaseOrder">
        <d4p1:PurchaseOrderItemDto>
          <d4p1:Discount>5</d4p1:Discount>
          <d4p1:DiscountType>6</d4p1:DiscountType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Note>sample string 8</d4p1:Note>
          <d4p1:ProductCode>sample string 10</d4p1:ProductCode>
          <d4p1:ProductId>e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3</d4p1:ProductId>
          <d4p1:ProductName>sample string 11</d4p1:ProductName>
          <d4p1:PurchaseOrderId>12a2f9ee-c240-4b67-9273-089a1c43f5b5</d4p1:PurchaseOrderId>
          <d4p1:Quantity>3</d4p1:Quantity>
          <d4p1:SupplierName>sample string 12</d4p1:SupplierName>
          <d4p1:TotalPrice>7</d4p1:TotalPrice>
          <d4p1:UnitPrice>4</d4p1:UnitPrice>
        </d4p1:PurchaseOrderItemDto>
        <d4p1:PurchaseOrderItemDto>
          <d4p1:Discount>5</d4p1:Discount>
          <d4p1:DiscountType>6</d4p1:DiscountType>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:Note>sample string 8</d4p1:Note>
          <d4p1:ProductCode>sample string 10</d4p1:ProductCode>
          <d4p1:ProductId>e02410e2-abf5-4ea6-9ec9-21b4b9bd38b3</d4p1:ProductId>
          <d4p1:ProductName>sample string 11</d4p1:ProductName>
          <d4p1:PurchaseOrderId>12a2f9ee-c240-4b67-9273-089a1c43f5b5</d4p1:PurchaseOrderId>
          <d4p1:Quantity>3</d4p1:Quantity>
          <d4p1:SupplierName>sample string 12</d4p1:SupplierName>
          <d4p1:TotalPrice>7</d4p1:TotalPrice>
          <d4p1:UnitPrice>4</d4p1:UnitPrice>
        </d4p1:PurchaseOrderItemDto>
      </d2p1:PurchaseOrderItemDtos>
      <d2p1:RemainingDebt>8</d2p1:RemainingDebt>
      <d2p1:Status>DRAFT</d2p1:Status>
      <d2p1:SupplierId>1</d2p1:SupplierId>
      <d2p1:SupplierName>sample string 6</d2p1:SupplierName>
      <d2p1:TotalOrder>4</d2p1:TotalOrder>
      <d2p1:UpdatedId>380c309d-4110-47c8-a54e-9076977ac065</d2p1:UpdatedId>
      <d2p1:UpdatedTime>2025-10-26T13:01:26.1587017+07:00</d2p1:UpdatedTime>
    </d2p1:ListPurchaseOrderResponse>
  </Items>
  <PayingAmount>3</PayingAmount>
  <TotalDebt>6</TotalDebt>
  <TotalIncome>4</TotalIncome>
  <TotalMoney>2</TotalMoney>
  <TotalOrderAmount>7</TotalOrderAmount>
  <TotalPaid>8</TotalPaid>
  <TotalSpend>5</TotalSpend>
</PaginatorResponseOfListPurchaseOrderResponsezelsgFU8>