POST OutstandingCustomerDocument/Get

Gets a list of Outstanding Customer Documents based on the request.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

The Outstanding Customer Document Request Model.

Outstanding Customer Document Request Model
NameTypeAdditional informationDescription
CustomerId integer

None.

IncludePaidInvoices bool

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": 1,
  "IncludePaidInvoices": true
}

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Outstanding Customer Document
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Outstanding Customer Document

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "DocumentTypeId": 1,
      "DueDate": "2021-10-19",
      "ExpectedPaymentDate": "2021-10-19",
      "CustomerId": 2,
      "CustomerName": "sample string 3",
      "Customer": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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-19",
          "Modified": "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,
        "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": "82206b0c-15db-4a7c-973e-ecde8b532813",
        "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-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "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": "eb14bac8-3b48-40c8-8420-cdbed5f97466",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "CityId": 1,
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "OutstandingInvoices": true,
        "OverdueInvoices": true,
        "OnHold": true,
        "ExcludeFromDebtorsManager": true,
        "ID": 39
      },
      "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-19",
        "Modified": "2021-10-19"
      },
      "StatusId": 1,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "Customer_CurrencyId": 1,
      "Customer_ExchangeRate": 1.0,
      "ID": 5,
      "Date": "2021-10-19",
      "Inclusive": true,
      "DiscountPercentage": 7.1,
      "TaxReference": "sample string 8",
      "DocumentNumber": "sample string 9",
      "Reference": "sample string 10",
      "Message": "sample string 11",
      "Discount": 12.0,
      "Exclusive": 13.0,
      "Tax": 14.0,
      "Rounding": 15.0,
      "Total": 16.0,
      "AmountDue": 17.0,
      "PostalAddress01": "sample string 18",
      "PostalAddress02": "sample string 19",
      "PostalAddress03": "sample string 20",
      "PostalAddress04": "sample string 21",
      "PostalAddress05": "sample string 22",
      "DeliveryAddress01": "sample string 23",
      "DeliveryAddress02": "sample string 24",
      "DeliveryAddress03": "sample string 25",
      "DeliveryAddress04": "sample string 26",
      "DeliveryAddress05": "sample string 27",
      "Printed": true,
      "TaxPeriodId": 1,
      "Editable": true,
      "HasAttachments": true,
      "HasNotes": true,
      "HasAnticipatedDate": true,
      "AnticipatedDate": "2021-10-19",
      "ExternalReference": "sample string 31",
      "UID": "672c3983-b2c6-4314-ad49-9b0cb24f8d2e",
      "Lines": [
        {
          "SelectionId": 1,
          "TaxTypeId": 1,
          "ID": 1,
          "Description": "sample string 2",
          "LineType": 0,
          "Quantity": 1.0,
          "UnitPriceExclusive": 3.0,
          "Unit": "sample string 4",
          "UnitPriceInclusive": 5.0,
          "TaxPercentage": 6.1,
          "DiscountPercentage": 7.1,
          "Exclusive": 8.0,
          "Discount": 9.0,
          "Tax": 10.0,
          "Total": 11.0,
          "Comments": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "$TrackingCode": "sample string 13",
          "CurrencyId": 1,
          "UnitCost": 1.0,
          "UID": "dc1fa2d0-298d-4a04-8132-31a5b05f50f8"
        },
        {
          "SelectionId": 1,
          "TaxTypeId": 1,
          "ID": 1,
          "Description": "sample string 2",
          "LineType": 0,
          "Quantity": 1.0,
          "UnitPriceExclusive": 3.0,
          "Unit": "sample string 4",
          "UnitPriceInclusive": 5.0,
          "TaxPercentage": 6.1,
          "DiscountPercentage": 7.1,
          "Exclusive": 8.0,
          "Discount": 9.0,
          "Tax": 10.0,
          "Total": 11.0,
          "Comments": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "$TrackingCode": "sample string 13",
          "CurrencyId": 1,
          "UnitCost": 1.0,
          "UID": "dc1fa2d0-298d-4a04-8132-31a5b05f50f8"
        }
      ]
    },
    {
      "DocumentTypeId": 1,
      "DueDate": "2021-10-19",
      "ExpectedPaymentDate": "2021-10-19",
      "CustomerId": 2,
      "CustomerName": "sample string 3",
      "Customer": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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-19",
          "Modified": "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,
        "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": "82206b0c-15db-4a7c-973e-ecde8b532813",
        "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-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "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": "eb14bac8-3b48-40c8-8420-cdbed5f97466",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "CityId": 1,
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "OutstandingInvoices": true,
        "OverdueInvoices": true,
        "OnHold": true,
        "ExcludeFromDebtorsManager": true,
        "ID": 39
      },
      "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-19",
        "Modified": "2021-10-19"
      },
      "StatusId": 1,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "Customer_CurrencyId": 1,
      "Customer_ExchangeRate": 1.0,
      "ID": 5,
      "Date": "2021-10-19",
      "Inclusive": true,
      "DiscountPercentage": 7.1,
      "TaxReference": "sample string 8",
      "DocumentNumber": "sample string 9",
      "Reference": "sample string 10",
      "Message": "sample string 11",
      "Discount": 12.0,
      "Exclusive": 13.0,
      "Tax": 14.0,
      "Rounding": 15.0,
      "Total": 16.0,
      "AmountDue": 17.0,
      "PostalAddress01": "sample string 18",
      "PostalAddress02": "sample string 19",
      "PostalAddress03": "sample string 20",
      "PostalAddress04": "sample string 21",
      "PostalAddress05": "sample string 22",
      "DeliveryAddress01": "sample string 23",
      "DeliveryAddress02": "sample string 24",
      "DeliveryAddress03": "sample string 25",
      "DeliveryAddress04": "sample string 26",
      "DeliveryAddress05": "sample string 27",
      "Printed": true,
      "TaxPeriodId": 1,
      "Editable": true,
      "HasAttachments": true,
      "HasNotes": true,
      "HasAnticipatedDate": true,
      "AnticipatedDate": "2021-10-19",
      "ExternalReference": "sample string 31",
      "UID": "672c3983-b2c6-4314-ad49-9b0cb24f8d2e",
      "Lines": [
        {
          "SelectionId": 1,
          "TaxTypeId": 1,
          "ID": 1,
          "Description": "sample string 2",
          "LineType": 0,
          "Quantity": 1.0,
          "UnitPriceExclusive": 3.0,
          "Unit": "sample string 4",
          "UnitPriceInclusive": 5.0,
          "TaxPercentage": 6.1,
          "DiscountPercentage": 7.1,
          "Exclusive": 8.0,
          "Discount": 9.0,
          "Tax": 10.0,
          "Total": 11.0,
          "Comments": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "$TrackingCode": "sample string 13",
          "CurrencyId": 1,
          "UnitCost": 1.0,
          "UID": "dc1fa2d0-298d-4a04-8132-31a5b05f50f8"
        },
        {
          "SelectionId": 1,
          "TaxTypeId": 1,
          "ID": 1,
          "Description": "sample string 2",
          "LineType": 0,
          "Quantity": 1.0,
          "UnitPriceExclusive": 3.0,
          "Unit": "sample string 4",
          "UnitPriceInclusive": 5.0,
          "TaxPercentage": 6.1,
          "DiscountPercentage": 7.1,
          "Exclusive": 8.0,
          "Discount": 9.0,
          "Tax": 10.0,
          "Total": 11.0,
          "Comments": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "$TrackingCode": "sample string 13",
          "CurrencyId": 1,
          "UnitCost": 1.0,
          "UID": "dc1fa2d0-298d-4a04-8132-31a5b05f50f8"
        }
      ]
    }
  ]
}