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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

Body Parameters

InvoiceFilterDataContract
NameDescriptionTypeAdditional information
Name

string

None.

LiableAccountId

integer

None.

RecipientAccountId

integer

None.

LiableGroupId

integer

None.

RecipientGroupId

integer

None.

TenancyRoleId

integer

None.

Types

Collection of InvoiceType

None.

Statuses

Collection of InvoiceStatusType

None.

FromDate

date

None.

ToDate

date

None.

Ascending

boolean

None.

Order

InvoiceOrder

None.

SearchCriteria

InvoiceSearchCriteriaDataContract

None.

Request Formats

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": "2019-06-25T17:51:55.0264928Z",
  "ToDate": "2019-06-25T17:51:55.0264928Z",
  "Ascending": true,
  "Order": 0,
  "SearchCriteria": {
    "SearchTerm": "sample string 1",
    "SubTypes": [
      0,
      0
    ],
    "ExcludeSubTypes": [
      0,
      0
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceFilterDataContract'.

Response Information

Resource Description

PagedCollectionDataContractOfInvoiceDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of 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": "2019-06-25T17:51:55.0733649Z",
      "CreatedDate": "2019-06-25T17:51:55.0733649Z",
      "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,
      "Payments": [
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Id": 4
        },
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Id": 4
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            },
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            },
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            }
          ],
          "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": "2019-06-25T17:51:55.0890023Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            }
          ],
          "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": "2019-06-25T17:51:55.0890023Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            }
          ],
          "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 21",
      "RelatedInvoiceId": 1,
      "CustomInvoiceNumber": "sample string 22",
      "DocumentIds": [
        1,
        2
      ],
      "Id": 23
    },
    {
      "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": "2019-06-25T17:51:55.0733649Z",
      "CreatedDate": "2019-06-25T17:51:55.0733649Z",
      "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,
      "Payments": [
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Id": 4
        },
        {
          "PaymentNumber": "sample string 1",
          "Amount": 2.0,
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Id": 4
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            },
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-25T17:51:55.0733649Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            },
            {
              "Date": "2019-06-25T17:51:55.0733649Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-25T17:51:55.0733649Z",
              "Id": 7
            }
          ],
          "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": "2019-06-25T17:51:55.0890023Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            }
          ],
          "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": "2019-06-25T17:51:55.0890023Z",
          "Type": 0,
          "RelatedEntityId": 9,
          "CreditNoteItems": [
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            },
            {
              "Amount": 1.0,
              "InvoiceItemId": 2,
              "CreditNoteId": 3,
              "Id": 4
            }
          ],
          "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 21",
      "RelatedInvoiceId": 1,
      "CustomInvoiceNumber": "sample string 22",
      "DocumentIds": [
        1,
        2
      ],
      "Id": 23
    }
  ]
}