POST SupplierPurchaseHistory/Get

Gets a list of Supplier Purchase History.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

Supplier Purchase History Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

SupplierId integer

None.

IncludeSupplierReturns bool

None.

GroupingType integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SupplierId": 1,
  "IncludeSupplierReturns": true,
  "GroupingType": 3,
  "FromDate": "2021-10-23",
  "ToDate": "2021-10-23"
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Supplier Purchase History
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Supplier Purchase History

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "Date": "2021-10-23",
      "Supplier": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-23",
          "Created": "2021-10-23"
        },
        "TaxReference": "sample string 2",
        "ContactName": "sample string 3",
        "Telephone": "sample string 4",
        "Fax": "sample string 5",
        "Mobile": "sample string 6",
        "Email": "sample string 7",
        "WebAddress": "sample string 8",
        "Active": true,
        "IsObfuscated": true,
        "Balance": 11.0,
        "CreditLimit": 12.0,
        "PostalAddress01": "sample string 13",
        "PostalAddress02": "sample string 14",
        "PostalAddress03": "sample string 15",
        "PostalAddress04": "sample string 16",
        "PostalAddress05": "sample string 17",
        "DeliveryAddress01": "sample string 18",
        "DeliveryAddress02": "sample string 19",
        "DeliveryAddress03": "sample string 20",
        "DeliveryAddress04": "sample string 21",
        "DeliveryAddress05": "sample string 22",
        "AutoAllocateToOldestInvoice": true,
        "TextField1": "sample string 23",
        "TextField2": "sample string 24",
        "TextField3": "sample string 25",
        "NumericField1": 1.0,
        "NumericField2": 1.0,
        "NumericField3": 1.0,
        "YesNoField1": true,
        "YesNoField2": true,
        "YesNoField3": true,
        "DateField1": "2021-10-23",
        "DateField2": "2021-10-23",
        "DateField3": "2021-10-23",
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "Modified": "2021-10-23",
        "Created": "2021-10-23",
        "BusinessRegistrationNumber": "sample string 33",
        "RMCDApprovalNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-23",
        "CurrencyId": 1,
        "CurrencySymbol": "sample string 35",
        "HasActivity": true,
        "DefaultDiscountPercentage": 1.0,
        "DefaultTaxTypeId": 1,
        "DefaultTaxType": {
          "ID": 1,
          "Name": "sample string 2",
          "Percentage": 3.1,
          "IsDefault": true,
          "HasActivity": true,
          "IsManualTax": true,
          "Active": true,
          "Created": "2021-10-23",
          "Modified": "2021-10-23",
          "TaxTypeDefaultUID": "9422acb3-8958-461b-938d-8110301f49ed",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "ID": 37
      },
      "Exclusive": 2.0
    },
    {
      "Date": "2021-10-23",
      "Supplier": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-23",
          "Created": "2021-10-23"
        },
        "TaxReference": "sample string 2",
        "ContactName": "sample string 3",
        "Telephone": "sample string 4",
        "Fax": "sample string 5",
        "Mobile": "sample string 6",
        "Email": "sample string 7",
        "WebAddress": "sample string 8",
        "Active": true,
        "IsObfuscated": true,
        "Balance": 11.0,
        "CreditLimit": 12.0,
        "PostalAddress01": "sample string 13",
        "PostalAddress02": "sample string 14",
        "PostalAddress03": "sample string 15",
        "PostalAddress04": "sample string 16",
        "PostalAddress05": "sample string 17",
        "DeliveryAddress01": "sample string 18",
        "DeliveryAddress02": "sample string 19",
        "DeliveryAddress03": "sample string 20",
        "DeliveryAddress04": "sample string 21",
        "DeliveryAddress05": "sample string 22",
        "AutoAllocateToOldestInvoice": true,
        "TextField1": "sample string 23",
        "TextField2": "sample string 24",
        "TextField3": "sample string 25",
        "NumericField1": 1.0,
        "NumericField2": 1.0,
        "NumericField3": 1.0,
        "YesNoField1": true,
        "YesNoField2": true,
        "YesNoField3": true,
        "DateField1": "2021-10-23",
        "DateField2": "2021-10-23",
        "DateField3": "2021-10-23",
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "Modified": "2021-10-23",
        "Created": "2021-10-23",
        "BusinessRegistrationNumber": "sample string 33",
        "RMCDApprovalNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-23",
        "CurrencyId": 1,
        "CurrencySymbol": "sample string 35",
        "HasActivity": true,
        "DefaultDiscountPercentage": 1.0,
        "DefaultTaxTypeId": 1,
        "DefaultTaxType": {
          "ID": 1,
          "Name": "sample string 2",
          "Percentage": 3.1,
          "IsDefault": true,
          "HasActivity": true,
          "IsManualTax": true,
          "Active": true,
          "Created": "2021-10-23",
          "Modified": "2021-10-23",
          "TaxTypeDefaultUID": "9422acb3-8958-461b-938d-8110301f49ed",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "ID": 37
      },
      "Exclusive": 2.0
    }
  ]
}