POST CustomerAgeing/GetSummary

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

Request Information

URI Parameters

None.

Body Parameters

The request.

Name	Type	Additional information	Description
CustomerId	integer	None.
ToDate	date	None.	Gets or sets To Date.
Summary	bool	None.
AgeingPeriod	integer	None.
FromCustomer	string	None.	The Customer Name to start the range at.
ToCustomer	string	None.	The Customer 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:

{
  "CustomerId": 1,
  "ToDate": "2024-11-15",
  "Summary": true,
  "AgeingPeriod": 4,
  "FromCustomer": "sample string 5",
  "ToCustomer": "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

Customer Ageing

Name	Type	Additional information
Total	decimal	None.
Current	decimal	None.
Days30	decimal	None.
Days60	decimal	None.
Days90	decimal	None.
Days120Plus	decimal	None.
Customer	Customer	None.
Date	date	None.
AgeingTransactions	Collection of Ageing Transaction	None.

Response Formats

application/json, text/json

Sample:

{
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2024-11-15",
      "Created": "2024-11-15"
    },
    "SalesRepresentativeId": 1,
    "SalesRepresentative": {
      "ID": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Name": "sample string 2 sample string 3",
      "Active": true,
      "Email": "sample string 6",
      "Mobile": "sample string 7",
      "Telephone": "sample string 8",
      "Created": "2024-11-15",
      "Modified": "2024-11-15"
    },
    "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,
    "CommunicationMethod": 1,
    "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,
    "EnableCustomerZone": true,
    "CustomerZoneGuid": "06f92f37-34ea-4e0f-8a0d-9a8ae007c7cc",
    "CashSale": true,
    "TextField1": "sample string 25",
    "TextField2": "sample string 26",
    "TextField3": "sample string 27",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2024-11-15",
    "DateField2": "2024-11-15",
    "DateField3": "2024-11-15",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2024-11-15",
    "Created": "2024-11-15",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2024-11-15",
    "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": "2024-11-15",
      "Modified": "2024-11-15",
      "TaxTypeDefaultUID": "1f34b85f-e885-4641-9a29-1e66919598fb",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "SubjectToDRCVat": true,
    "ID": 40
  },
  "Date": "2024-11-15T00:00:00Z",
  "AgeingTransactions": [
    {
      "DocumentHeaderId": 1,
      "DocumentTypeId": 2,
      "DocumentNumber": "sample string 3",
      "Reference": "sample string 4",
      "DocumentType": 2,
      "Comment": "sample string 5",
      "Date": "2024-11-15T00:00:00Z",
      "DueDate": "2024-11-15",
      "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": "2024-11-15T00:00:00Z",
      "DueDate": "2024-11-15",
      "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
}