POST api/invoice/find?pageSize={pageSize}&pageNumber={pageNumber}

Get filtered list of invoices This endpoint is deprecated, avoid using unless absolutely necesary

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

Body Parameters

Dezrez.Core.DataContracts.Accounts.Invoices.Command.InvoiceFilterDataContract
NameDescriptionTypeAdditional information
Name

string

None.

LiableAccountId

integer

None.

RecipientAccountId

integer

None.

LiableGroupId

integer

None.

RecipientGroupId

integer

None.

TenancyRoleId

integer

None.

Types

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.InvoiceType

None.

Statuses

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.InvoiceStatusType

None.

FromDate

date

None.

ToDate

date

None.

Ascending

boolean

None.

Order

Dezrez.Core.DataContracts.Accounts.Invoices.Command.InvoiceOrder

None.

SearchCriteria

Dezrez.Core.DataContracts.Accounts.Invoices.Command.InvoiceSearchCriteriaDataContract

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "LiableAccountId": 1,
  "RecipientAccountId": 1,
  "LiableGroupId": 1,
  "RecipientGroupId": 1,
  "TenancyRoleId": 1,
  "Types": [
    0,
    0
  ],
  "Statuses": [
    0,
    0
  ],
  "FromDate": "2024-10-05T14:04:34.8764964Z",
  "ToDate": "2024-10-05T14:04:34.8764964Z",
  "Ascending": true,
  "Order": 0,
  "SearchCriteria": {
    "SearchTerm": "sample string 1",
    "SubTypes": [
      0,
      0
    ],
    "ExcludeSubTypes": [
      0,
      0
    ]
  }
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "RecipientAccountId": 1,
      "LiableAccountId": 2,
      "RecipientAccountName": "sample string 3",
      "RecipientGroupId": 4,
      "LiableAccountName": "sample string 5",
      "LiableAccountBalance": 6.0,
      "LiableGroupId": 7.0,
      "Status": "sample string 8",
      "DueDate": "2024-10-05T14:04:34.8921263Z",
      "CreatedDate": "2024-10-05T14:04:34.8921263Z",
      "RentPeriodEndDate": "2024-10-05T14:04:34.8921263Z",
      "InvoiceNumber": 11,
      "Description": "sample string 12",
      "InvoiceType": "sample string 13",
      "InvoiceSubType": "sample string 14",
      "TotalAmount": 15.0,
      "SubTotalAmount": 16.0,
      "TaxTotalAmount": 17.0,
      "DiscountTotalAmount": 18.0,
      "TotalOutstanding": 19.0,
      "TotalPaid": 20.0,
      "Notes": "sample string 21",
      "Payments": [
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Id": 4
        },
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Id": 4
        }
      ],
      "Allocations": [
        {
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "InvoiceItems": [
        {
          "TaxAmount": 1.0,
          "SubTotalAmount": 2.0,
          "TotalOutstanding": 3.0,
          "Amount": 4.0,
          "Name": "sample string 5",
          "IsTaxable": true,
          "TaxitemId": 1,
          "Discount": 7.0,
          "DiscountName": "sample string 8",
          "DiscountDate": "2024-10-05T14:04:34.8921263Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            }
          ],
          "RefundItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            }
          ],
          "Id": 10
        },
        {
          "TaxAmount": 1.0,
          "SubTotalAmount": 2.0,
          "TotalOutstanding": 3.0,
          "Amount": 4.0,
          "Name": "sample string 5",
          "IsTaxable": true,
          "TaxitemId": 1,
          "Discount": 7.0,
          "DiscountName": "sample string 8",
          "DiscountDate": "2024-10-05T14:04:34.8921263Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            }
          ],
          "RefundItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            }
          ],
          "Id": 10
        }
      ],
      "LinkedFees": [
        {
          "LiableAccountId": 1,
          "RecipientAccountId": 2,
          "FeeId": 3,
          "ExternalReference": 4,
          "Id": 5
        },
        {
          "LiableAccountId": 1,
          "RecipientAccountId": 2,
          "FeeId": 3,
          "ExternalReference": 4,
          "Id": 5
        }
      ],
      "PropertyId": 1,
      "TenancyRoleId": 1,
      "Address": "sample string 22",
      "RelatedInvoiceId": 1,
      "CustomInvoiceNumber": "sample string 23",
      "DocumentIds": [
        1,
        2
      ],
      "PropertyAccountId": 1,
      "PreviewReziDocumentRef": "sample string 24",
      "Id": 25
    },
    {
      "RecipientAccountId": 1,
      "LiableAccountId": 2,
      "RecipientAccountName": "sample string 3",
      "RecipientGroupId": 4,
      "LiableAccountName": "sample string 5",
      "LiableAccountBalance": 6.0,
      "LiableGroupId": 7.0,
      "Status": "sample string 8",
      "DueDate": "2024-10-05T14:04:34.8921263Z",
      "CreatedDate": "2024-10-05T14:04:34.8921263Z",
      "RentPeriodEndDate": "2024-10-05T14:04:34.8921263Z",
      "InvoiceNumber": 11,
      "Description": "sample string 12",
      "InvoiceType": "sample string 13",
      "InvoiceSubType": "sample string 14",
      "TotalAmount": 15.0,
      "SubTotalAmount": 16.0,
      "TaxTotalAmount": 17.0,
      "DiscountTotalAmount": 18.0,
      "TotalOutstanding": 19.0,
      "TotalPaid": 20.0,
      "Notes": "sample string 21",
      "Payments": [
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Id": 4
        },
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Id": 4
        }
      ],
      "Allocations": [
        {
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        },
        {
          "Date": "2024-10-05T14:04:34.8921263Z",
          "Amount": 2.0,
          "Description": "sample string 3",
          "AllocationItems": [
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            },
            {
              "Date": "2024-10-05T14:04:34.8921263Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceItemId": 4,
              "InvoiceItemDescription": "sample string 5",
              "Protected": true,
              "ProtectedDate": "2024-10-05T14:04:34.8921263Z",
              "LandlordProtected": true,
              "Id": 9
            }
          ],
          "Id": 4
        }
      ],
      "InvoiceItems": [
        {
          "TaxAmount": 1.0,
          "SubTotalAmount": 2.0,
          "TotalOutstanding": 3.0,
          "Amount": 4.0,
          "Name": "sample string 5",
          "IsTaxable": true,
          "TaxitemId": 1,
          "Discount": 7.0,
          "DiscountName": "sample string 8",
          "DiscountDate": "2024-10-05T14:04:34.8921263Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            }
          ],
          "RefundItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            }
          ],
          "Id": 10
        },
        {
          "TaxAmount": 1.0,
          "SubTotalAmount": 2.0,
          "TotalOutstanding": 3.0,
          "Amount": 4.0,
          "Name": "sample string 5",
          "IsTaxable": true,
          "TaxitemId": 1,
          "Discount": 7.0,
          "DiscountName": "sample string 8",
          "DiscountDate": "2024-10-05T14:04:34.8921263Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Reason": "sample string 4",
              "InvoiceNumber": 5,
              "Id": 6
            }
          ],
          "RefundItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "InvoiceId": 3,
              "RefundId": 4,
              "Id": 5
            }
          ],
          "Id": 10
        }
      ],
      "LinkedFees": [
        {
          "LiableAccountId": 1,
          "RecipientAccountId": 2,
          "FeeId": 3,
          "ExternalReference": 4,
          "Id": 5
        },
        {
          "LiableAccountId": 1,
          "RecipientAccountId": 2,
          "FeeId": 3,
          "ExternalReference": 4,
          "Id": 5
        }
      ],
      "PropertyId": 1,
      "TenancyRoleId": 1,
      "Address": "sample string 22",
      "RelatedInvoiceId": 1,
      "CustomInvoiceNumber": "sample string 23",
      "DocumentIds": [
        1,
        2
      ],
      "PropertyAccountId": 1,
      "PreviewReziDocumentRef": "sample string 24",
      "Id": 25
    }
  ]
}