POST CustomerStatement/Get

Gets a Customer Statement based on the request model.

Request Information

URI Parameters

None.

Body Parameters

A Customer Statement request model.

Customer Statement Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

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.

CommunicationMethod Communication Method Type

None.

Gets or sets the communication method. Optional. None = 0, Print = 1, Email = 2, Print and Email = 3 All = -1

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:
{
  "FromCustomer": "sample string 1",
  "ToCustomer": "sample string 2",
  "FromCategory": "sample string 3",
  "ToCategory": "sample string 4",
  "IncludeActive": true,
  "IncludeInactive": true,
  "CommunicationMethod": 0,
  "ExcludeZeroBalanceAccounts": true,
  "Detailed": true,
  "ExcludeFullyAllocated": true,
  "ShowBalanceBroughtForward": true,
  "ExcludeNegativeBalance": true,
  "UseMinimumBalance": true,
  "MinimumBalance": 13.0,
  "UseForeignCurrency": true,
  "FromDate": "2021-10-16",
  "ToDate": "2021-10-16"
}

Response Information

Resource Description

Collection of Customer Statement
NameTypeAdditional informationDescription
Customer Customer

None.

StatementLines Collection of Customer Statement Line

None.

Date date

None.

TotalDue decimal

None.

TotalPaid decimal

None.

Current decimal

None.

Days30 decimal

None.

Days60 decimal

None.

Days90 decimal

None.

Days120Plus decimal

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Customer": {
      "Name": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2021-10-16",
        "Created": "2021-10-16"
      },
      "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": "2021-10-16",
        "Modified": "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,
      "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": "e7598814-b48f-4407-9efe-481990ee1a5a",
      "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": "2021-10-16",
      "DateField2": "2021-10-16",
      "DateField3": "2021-10-16",
      "DefaultPriceListId": 1,
      "DefaultPriceList": {
        "ID": 1,
        "Description": "sample string 2",
        "IsDefault": true
      },
      "DefaultPriceListName": "sample string 2",
      "AcceptsElectronicInvoices": true,
      "Modified": "2021-10-16",
      "Created": "2021-10-16",
      "BusinessRegistrationNumber": "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": "ef9f6639-b20d-411e-ada3-6f512762608c",
        "CompanyId": 9
      },
      "DueDateMethodId": 1,
      "DueDateMethodValue": 1,
      "CityId": 1,
      "HasSpecialCountryTax": true,
      "AccountingAgreement": true,
      "HasSpecialCountryTaxActivity": true,
      "OutstandingInvoices": true,
      "OverdueInvoices": true,
      "OnHold": true,
      "ExcludeFromDebtorsManager": true,
      "ID": 39
    },
    "StatementLines": [
      {
        "DocumentHeaderId": 1,
        "DocumentTypeId": 2,
        "Date": "2021-10-16",
        "DocumentNumber": "sample string 4",
        "Reference": "sample string 6",
        "Description": "sample string 7 - sample string 6",
        "Comment": "sample string 8"
      },
      {
        "DocumentHeaderId": 1,
        "DocumentTypeId": 2,
        "Date": "2021-10-16",
        "DocumentNumber": "sample string 4",
        "Reference": "sample string 6",
        "Description": "sample string 7 - sample string 6",
        "Comment": "sample string 8"
      }
    ],
    "Date": "2021-10-16",
    "TotalDue": 0.0,
    "TotalPaid": 0.0,
    "Current": 2.0,
    "Days30": 3.0,
    "Days60": 4.0,
    "Days90": 5.0,
    "Days120Plus": 6.0
  },
  {
    "Customer": {
      "Name": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2021-10-16",
        "Created": "2021-10-16"
      },
      "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": "2021-10-16",
        "Modified": "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,
      "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": "e7598814-b48f-4407-9efe-481990ee1a5a",
      "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": "2021-10-16",
      "DateField2": "2021-10-16",
      "DateField3": "2021-10-16",
      "DefaultPriceListId": 1,
      "DefaultPriceList": {
        "ID": 1,
        "Description": "sample string 2",
        "IsDefault": true
      },
      "DefaultPriceListName": "sample string 2",
      "AcceptsElectronicInvoices": true,
      "Modified": "2021-10-16",
      "Created": "2021-10-16",
      "BusinessRegistrationNumber": "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": "ef9f6639-b20d-411e-ada3-6f512762608c",
        "CompanyId": 9
      },
      "DueDateMethodId": 1,
      "DueDateMethodValue": 1,
      "CityId": 1,
      "HasSpecialCountryTax": true,
      "AccountingAgreement": true,
      "HasSpecialCountryTaxActivity": true,
      "OutstandingInvoices": true,
      "OverdueInvoices": true,
      "OnHold": true,
      "ExcludeFromDebtorsManager": true,
      "ID": 39
    },
    "StatementLines": [
      {
        "DocumentHeaderId": 1,
        "DocumentTypeId": 2,
        "Date": "2021-10-16",
        "DocumentNumber": "sample string 4",
        "Reference": "sample string 6",
        "Description": "sample string 7 - sample string 6",
        "Comment": "sample string 8"
      },
      {
        "DocumentHeaderId": 1,
        "DocumentTypeId": 2,
        "Date": "2021-10-16",
        "DocumentNumber": "sample string 4",
        "Reference": "sample string 6",
        "Description": "sample string 7 - sample string 6",
        "Comment": "sample string 8"
      }
    ],
    "Date": "2021-10-16",
    "TotalDue": 0.0,
    "TotalPaid": 0.0,
    "Current": 2.0,
    "Days30": 3.0,
    "Days60": 4.0,
    "Days90": 5.0,
    "Days120Plus": 6.0
  }
]