GET PlanCare2Api/DynamicData/AgreementProducts?supplierCode={supplierCode}&referenceDate={referenceDate}

Fetch available products and debtors for the given supplier based on the product information on the agreement.

Request Information

URI Parameters

Name Description Type Additional information
supplierCode

The code of the supplier to obtain the product information for

string

Required

referenceDate

The date to obtain product agreement information for

date

Required

Body Parameters

None.

Response Information

Resource Description

Displays a list of debtors, productcodes and productdescriptions based on the agreement

Collection of AgreementProductsResult
Name Description Type Additional information
Suppliercode

The code of the supplier based on the agreement

string

-

Supplier

The name of the supplier based on the agreement

string

-

Debtorcode

The code of the debtor based on the agreement

string

-

Debtor

The name of the debtor based on the agreement

string

-

Productid

The identifier of the product based on the agreement

integer

Nullable

Productcode

The code of the product based on the agreement

string

-

Productdescription

The description of the product based on the agreement

string

-

Declarationunit

The unit in which the product is declared

string

-

Financialcontractid

The identifier of the agreement

integer

Nullable

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Suppliercode": "sample string 1",
    "Supplier": "sample string 2",
    "Debtorcode": "sample string 3",
    "Debtor": "sample string 4",
    "Productid": 1,
    "Productcode": "sample string 5",
    "Productdescription": "sample string 6",
    "Declarationunit": "sample string 7",
    "Financialcontractid": 1
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDynamicDataController.AgreementProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.AgreementProductsResult>
    <Debtor>sample string 4</Debtor>
    <Debtorcode>sample string 3</Debtorcode>
    <Declarationunit>sample string 7</Declarationunit>
    <Financialcontractid>1</Financialcontractid>
    <Productcode>sample string 5</Productcode>
    <Productdescription>sample string 6</Productdescription>
    <Productid>1</Productid>
    <Supplier>sample string 2</Supplier>
    <Suppliercode>sample string 1</Suppliercode>
  </DynamicDataController.AgreementProductsResult>
  <DynamicDataController.AgreementProductsResult>
    <Debtor>sample string 4</Debtor>
    <Debtorcode>sample string 3</Debtorcode>
    <Declarationunit>sample string 7</Declarationunit>
    <Financialcontractid>1</Financialcontractid>
    <Productcode>sample string 5</Productcode>
    <Productdescription>sample string 6</Productdescription>
    <Productid>1</Productid>
    <Supplier>sample string 2</Supplier>
    <Suppliercode>sample string 1</Suppliercode>
  </DynamicDataController.AgreementProductsResult>
</ArrayOfDynamicDataController.AgreementProductsResult>