POST SupplierStatement/Get

Gets the specified Supplier Statement based on the Supplier Statement Request Model passed through.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

The Supplier Statements Request Model.

Supplier Statement Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

FromSupplier string

None.

The Supplier Name to start the range at.

ToSupplier string

None.

The Supplier Name to stop the range at.

FromCategory string

None.

The Category Name to start the range at.

ToCategory string

None.

The Category Name to stop the range at.

IncludeActive bool

None.

IncludeInactive bool

None.

ExcludeZeroBalanceAccounts bool

None.

Detailed bool

None.

ExcludeFullyAllocated bool

None.

ShowBalanceBroughtForward bool

None.

ExcludeNegativeBalance bool

None.

UseMinimumBalance bool

None.

MinimumBalance decimal

None.

UseForeignCurrency bool

None.

Request Formats

application/json, text/json

Sample:
{
  "FromSupplier": "sample string 1",
  "ToSupplier": "sample string 2",
  "FromCategory": "sample string 3",
  "ToCategory": "sample string 4",
  "IncludeActive": true,
  "IncludeInactive": true,
  "ExcludeZeroBalanceAccounts": true,
  "Detailed": true,
  "ExcludeFullyAllocated": true,
  "ShowBalanceBroughtForward": true,
  "ExcludeNegativeBalance": true,
  "UseMinimumBalance": true,
  "MinimumBalance": 13.0,
  "UseForeignCurrency": true,
  "FromDate": "2021-10-19",
  "ToDate": "2021-10-19"
}

Response Information

Resource Description

Returns the Supplier Statement.

This collection is wrapped in a paging response object.

Paging response of Supplier Statement
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Supplier Statement

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "Supplier": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "sample string 33",
        "RMCDApprovalNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-19",
        "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-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "b75019f0-5c74-470f-91c5-ed8be176d951",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "ID": 37
      },
      "StatementLines": [
        {
          "DocumentHeaderId": 1,
          "DocumentTypeId": 2,
          "Date": "2021-10-19",
          "DocumentNumber": "sample string 4",
          "Reference": "sample string 6",
          "Comment": "sample string 8"
        },
        {
          "DocumentHeaderId": 1,
          "DocumentTypeId": 2,
          "Date": "2021-10-19",
          "DocumentNumber": "sample string 4",
          "Reference": "sample string 6",
          "Comment": "sample string 8"
        }
      ],
      "Date": "2021-10-19",
      "TotalDue": 0.0,
      "TotalPaid": 0.0,
      "Current": 2.0,
      "Days30": 3.0,
      "Days60": 4.0,
      "Days90": 5.0,
      "Days120Plus": 6.0
    },
    {
      "Supplier": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "sample string 33",
        "RMCDApprovalNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-19",
        "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-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "b75019f0-5c74-470f-91c5-ed8be176d951",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "ID": 37
      },
      "StatementLines": [
        {
          "DocumentHeaderId": 1,
          "DocumentTypeId": 2,
          "Date": "2021-10-19",
          "DocumentNumber": "sample string 4",
          "Reference": "sample string 6",
          "Comment": "sample string 8"
        },
        {
          "DocumentHeaderId": 1,
          "DocumentTypeId": 2,
          "Date": "2021-10-19",
          "DocumentNumber": "sample string 4",
          "Reference": "sample string 6",
          "Comment": "sample string 8"
        }
      ],
      "Date": "2021-10-19",
      "TotalDue": 0.0,
      "TotalPaid": 0.0,
      "Current": 2.0,
      "Days30": 3.0,
      "Days60": 4.0,
      "Days90": 5.0,
      "Days120Plus": 6.0
    }
  ]
}