POST api/account/landlordincome/csv

Generate a landlord income report Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The landlord income list data contract supplied with the request.

LandlordIncomeListDataContract

Name	Description	Type	Additional information
FromDate	The from date, expressed as a date and time.	date	None.
ToDate	The to date, expressed as a date and time.	date	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "FromDate": "2026-07-23T08:26:04.0815002Z",
  "ToDate": "2026-07-23T08:26:04.0815002Z"
}

Response Information

Resource Description

The response returned after the operation completes.

StatementDataContract

Name	Description	Type	Additional information
OpeningBalance	The opening balance value.	decimal number	None.
ClosingBalance	The closing balance value.	decimal number	None.
StartDate	The start date, expressed as a date and time.	date	None.
EndDate	The end date, expressed as a date and time.	date	None.
StatementType	The statement type value.	string	None.
Items	The collection of items.	Collection of LedgerItemDataContract	None.
RelatedProperties	The collection of related properties.	Collection of string	None.
Credits	The credits value.	decimal number	None.
Debits	The debits value.	decimal number	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
TotalCount	The total count value.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OpeningBalance": 1.0,
  "ClosingBalance": 2.0,
  "StartDate": "2026-07-23T08:26:04.0815002Z",
  "EndDate": "2026-07-23T08:26:04.0815002Z",
  "StatementType": "sample string 5",
  "Items": [
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2026-07-23T08:26:04.0815002Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "InvoiceSubType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "ClearedStatus": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "LedgerEntryId": 7,
      "InvoiceId": 1,
      "RefundId": 1,
      "IsCrPositive": true,
      "FromTo": "sample string 9",
      "FromToGroupId": 10,
      "From": "sample string 11",
      "FromGroupId": 12,
      "To": "sample string 13",
      "ToGroupId": 14,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 18.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "PaymentId": 20,
      "PaymentItemId": 1,
      "PaymentReziDocumentIds": [
        1,
        2
      ],
      "TenantRoleId": 1,
      "PropertyId": 1,
      "RelatedProperty": "sample string 21",
      "IsInReversedPayment": true,
      "IsProtected": true,
      "IsReleased": true,
      "RefundedTotal": 25.0,
      "InvoiceAllocationsTotal": 26.0,
      "Batch": {
        "IsProcessed": true,
        "Id": 2
      },
      "CreatedById": 27,
      "Id": 28
    },
    {
      "Amount": 1.0,
      "Description": "sample string 2",
      "Balance": 3.0,
      "DrCr": "sample string 4",
      "DateTime": "2026-07-23T08:26:04.0815002Z",
      "AccountId": 6,
      "AccountType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "InvoiceSubType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "ClearedStatus": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "LedgerEntryId": 7,
      "InvoiceId": 1,
      "RefundId": 1,
      "IsCrPositive": true,
      "FromTo": "sample string 9",
      "FromToGroupId": 10,
      "From": "sample string 11",
      "FromGroupId": 12,
      "To": "sample string 13",
      "ToGroupId": 14,
      "IsAdjustment": true,
      "IsReversal": true,
      "IsUnsuspended": true,
      "OriginalTotal": 18.0,
      "PaymentType": 0,
      "IsReconciled": true,
      "PaymentId": 20,
      "PaymentItemId": 1,
      "PaymentReziDocumentIds": [
        1,
        2
      ],
      "TenantRoleId": 1,
      "PropertyId": 1,
      "RelatedProperty": "sample string 21",
      "IsInReversedPayment": true,
      "IsProtected": true,
      "IsReleased": true,
      "RefundedTotal": 25.0,
      "InvoiceAllocationsTotal": 26.0,
      "Batch": {
        "IsProcessed": true,
        "Id": 2
      },
      "CreatedById": 27,
      "Id": 28
    }
  ],
  "RelatedProperties": [
    "sample string 1",
    "sample string 2"
  ],
  "Credits": 6.0,
  "Debits": 7.0,
  "PageSize": 8,
  "PageNumber": 9,
  "TotalCount": 10
}