POST api/invoice/totals
Get filtered list of invoice totals Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The invoice filter data contract supplied with the request.
InvoiceFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The name value. |
string |
None. |
| LiableAccountId |
The unique identifier of the related liable account resource. |
integer |
None. |
| RecipientAccountId |
The unique identifier of the related recipient account resource. |
integer |
None. |
| LiableGroupId |
The unique identifier of the related liable group resource. |
integer |
None. |
| RecipientGroupId |
The unique identifier of the related recipient group resource. |
integer |
None. |
| TenancyRoleId |
The unique identifier of the related tenancy role resource. |
integer |
None. |
| Types |
The collection of types. |
Collection of InvoiceType |
None. |
| Statuses |
The collection of statuses. |
Collection of InvoiceStatusType |
None. |
| FromDate |
The from date, expressed as a date and time. |
date |
None. |
| ToDate |
The to date, expressed as a date and time. |
date |
None. |
| Ascending |
Indicates whether ascending is true. |
boolean |
None. |
| Order |
The order classification. |
InvoiceOrder |
None. |
| SearchCriteria |
The search criteria value. |
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": "2026-07-23T08:18:58.6895677Z",
"ToDate": "2026-07-23T08:18:58.6895677Z",
"Ascending": true,
"Order": 0,
"SearchCriteria": {
"SearchTerm": "sample string 1",
"SubTypes": [
0,
0
],
"ExcludeSubTypes": [
0,
0
]
}
}
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfInvoiceDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of 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": "2026-07-23T08:18:58.7520698Z",
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"RentPeriodEndDate": "2026-07-23T08:18:58.7520698Z",
"InvoiceNumber": 1,
"Description": "sample string 11",
"InvoiceType": "sample string 12",
"InvoiceSubType": "sample string 13",
"TotalAmount": 14.0,
"SubTotalAmount": 15.0,
"TaxTotalAmount": 16.0,
"DiscountTotalAmount": 17.0,
"TotalOutstanding": 18.0,
"TotalPaid": 19.0,
"Notes": "sample string 20",
"Payments": [
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T08:18:58.7520698Z",
"Id": 4
},
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T08:18:58.7520698Z",
"Id": 4
}
],
"Allocations": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"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": "2026-07-23T08:18:58.7520698Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
}
],
"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": "2026-07-23T08:18:58.7520698Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
}
],
"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 21",
"RelatedInvoiceId": 1,
"CustomInvoiceNumber": "sample string 22",
"DocumentIds": [
1,
2
],
"PropertyAccountId": 1,
"InternalInvoiceNumber": 1,
"PreviewReziDocumentRef": "sample string 23",
"IsRecurring": true,
"ScheduleFrequency": 1,
"ScheduleOccurrences": 1,
"ScheduleInterval": 1,
"ScheduleStartDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleEndDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleNextRunDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleIsActive": true,
"ScheduleDaysOfTheWeek": 24,
"ScheduleId": 25,
"ScheduleDisplayText": "Occurs daily for 1 time",
"Id": 26
},
{
"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": "2026-07-23T08:18:58.7520698Z",
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"RentPeriodEndDate": "2026-07-23T08:18:58.7520698Z",
"InvoiceNumber": 1,
"Description": "sample string 11",
"InvoiceType": "sample string 12",
"InvoiceSubType": "sample string 13",
"TotalAmount": 14.0,
"SubTotalAmount": 15.0,
"TaxTotalAmount": 16.0,
"DiscountTotalAmount": 17.0,
"TotalOutstanding": 18.0,
"TotalPaid": 19.0,
"Notes": "sample string 20",
"Payments": [
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T08:18:58.7520698Z",
"Id": 4
},
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T08:18:58.7520698Z",
"Id": 4
}
],
"Allocations": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T08:18:58.7520698Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T08:18:58.7520698Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"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": "2026-07-23T08:18:58.7520698Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
}
],
"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": "2026-07-23T08:18:58.7520698Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T08:18:58.7520698Z",
"Id": 8
}
],
"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 21",
"RelatedInvoiceId": 1,
"CustomInvoiceNumber": "sample string 22",
"DocumentIds": [
1,
2
],
"PropertyAccountId": 1,
"InternalInvoiceNumber": 1,
"PreviewReziDocumentRef": "sample string 23",
"IsRecurring": true,
"ScheduleFrequency": 1,
"ScheduleOccurrences": 1,
"ScheduleInterval": 1,
"ScheduleStartDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleEndDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleNextRunDate": "2026-07-23T08:18:58.7520698Z",
"ScheduleIsActive": true,
"ScheduleDaysOfTheWeek": 24,
"ScheduleId": 25,
"ScheduleDisplayText": "Occurs daily for 1 time",
"Id": 26
}
]
}