POST SupplierAgeing/GetSummary

Gets the specified Supplier Ageing Summary statement based on the request.

Request Information

URI Parameters

None.

Body Parameters

The request.

Supplier Ageing Request Model
NameTypeAdditional informationDescription
SupplierId integer

None.

ToDate date

None.

Gets or sets To Date.

Summary bool

None.

AgeingPeriod integer

None.

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.

BasedOnDueDate bool

None.

ExcludeZeroBalance bool

None.

UseForeignCurrency bool

None.

Request Formats

application/json, text/json

Sample:
{
  "SupplierId": 1,
  "ToDate": "2021-10-16",
  "Summary": true,
  "AgeingPeriod": 4,
  "FromSupplier": "sample string 5",
  "ToSupplier": "sample string 6",
  "FromCategory": "sample string 7",
  "ToCategory": "sample string 8",
  "IncludeActive": true,
  "IncludeInactive": true,
  "BasedOnDueDate": true,
  "ExcludeZeroBalance": true,
  "UseForeignCurrency": true
}

Response Information

Resource Description

Supplier Ageing
NameTypeAdditional informationDescription
Total decimal

None.

Current decimal

None.

Days30 decimal

None.

Days60 decimal

None.

Days90 decimal

None.

Days120Plus decimal

None.

Supplier Supplier

None.

Date date

None.

AgeingTransactions Collection of Ageing Transaction

None.

Response Formats

application/json, text/json

Sample:
{
  "Supplier": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-16",
      "Created": "2021-10-16"
    },
    "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-16",
    "DateField2": "2021-10-16",
    "DateField3": "2021-10-16",
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2021-10-16",
    "Created": "2021-10-16",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-16",
    "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-16",
      "Modified": "2021-10-16",
      "TaxTypeDefaultUID": "9496cd55-0b63-4bed-a3b8-2b0b84699bc8",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "ID": 37
  },
  "Date": "2021-10-16T00:00:00Z",
  "AgeingTransactions": [
    {
      "DocumentHeaderId": 1,
      "DocumentTypeId": 2,
      "DocumentNumber": "sample string 3",
      "Reference": "sample string 4",
      "DocumentType": 2,
      "Comment": "sample string 5",
      "Date": "2021-10-16T00:00:00Z",
      "DueDate": "2021-10-16",
      "Total": 45.0,
      "Current": 7.0,
      "Days30": 8.0,
      "Days60": 9.0,
      "Days90": 10.0,
      "Days120Plus": 11.0
    },
    {
      "DocumentHeaderId": 1,
      "DocumentTypeId": 2,
      "DocumentNumber": "sample string 3",
      "Reference": "sample string 4",
      "DocumentType": 2,
      "Comment": "sample string 5",
      "Date": "2021-10-16T00:00:00Z",
      "DueDate": "2021-10-16",
      "Total": 45.0,
      "Current": 7.0,
      "Days30": 8.0,
      "Days60": 9.0,
      "Days90": 10.0,
      "Days120Plus": 11.0
    }
  ],
  "Total": 20.0,
  "Current": 2.0,
  "Days30": 3.0,
  "Days60": 4.0,
  "Days90": 5.0,
  "Days120Plus": 6.0
}