POST api/account/{id}/paymentoverview
Get payment overview for an account
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ExtendedAccountPaymentDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceDeductions | Collection of InvoiceAmountsDataContract |
None. |
|
| InvoicePayments | Collection of InvoiceAmountsDataContract |
None. |
|
| Receipts | Collection of ReceiptDataContract |
None. |
|
| Refunds | Collection of RefundDataContract |
None. |
|
| RefundDeductions | Collection of RefundDataContract |
None. |
|
| ClosingBalance | decimal number |
None. |
|
| Name | string |
None. |
|
| Total | decimal number |
None. |
|
| TotalUncleared | decimal number |
None. |
|
| Deductions | decimal number |
None. |
|
| ToPay | decimal number |
None. |
|
| Received | decimal number |
None. |
|
| AllDisbursements | decimal number |
None. |
|
| NumberOfItems | integer |
None. |
|
| LastStatementDate | date |
None. |
|
| AssociatedGroupId | integer |
None. |
|
| IsTenant | boolean |
None. |
|
| IsLandlord | boolean |
None. |
|
| IsCompany | boolean |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceDeductions": [
{
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2021-06-14T00:33:42.4549079Z",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"Allocations": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"Id": 9
},
{
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2021-06-14T00:33:42.4549079Z",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"Allocations": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"Id": 9
}
],
"InvoicePayments": [
{
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2021-06-14T00:33:42.4549079Z",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"Allocations": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"Id": 9
},
{
"Description": "sample string 1",
"TotalAmount": 2.0,
"SubTotalAmount": 3.0,
"TaxTotalAmount": 4.0,
"DiscountTotalAmount": 5.0,
"TotalOutstanding": 6.0,
"TotalPaid": 7.0,
"CreatedDate": "2021-06-14T00:33:42.4549079Z",
"InvoiceItems": [
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
},
{
"Name": "sample string 1",
"Amount": 2.0,
"Id": 3
}
],
"Allocations": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-14T00:33:42.4549079Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
}
],
"RelatedEntities": [
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
},
{
"Name": "sample string 1",
"Type": "sample string 2",
"Description": "sample string 3"
}
],
"PaymentLines": [
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
},
{
"SubAmount": 1.0,
"PaymentLedgerLine": {
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
},
"EntityId": 2
}
],
"Id": 9
}
],
"Receipts": [
{
"DateTime": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"PaymentType": 0,
"BankAccountId": 3,
"BankAccountName": "sample string 4",
"AccountId": 5,
"AccountName": "sample string 6",
"IsDeposited": true,
"DepositId": 1,
"Description": "sample string 8",
"OriginalAmount": 9.0,
"LedgerEntryId": 10,
"Id": 11
},
{
"DateTime": "2021-06-14T00:33:42.4549079Z",
"Amount": 2.0,
"PaymentType": 0,
"BankAccountId": 3,
"BankAccountName": "sample string 4",
"AccountId": 5,
"AccountName": "sample string 6",
"IsDeposited": true,
"DepositId": 1,
"Description": "sample string 8",
"OriginalAmount": 9.0,
"LedgerEntryId": 10,
"Id": 11
}
],
"Refunds": [
{
"Amount": 1.0,
"DateTime": "2021-06-14T00:33:42.4705307Z",
"Description": "sample string 3",
"InvoiceId": 4,
"IssuingAccountId": 5,
"RecipientAccountId": 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": 7
},
{
"Amount": 1.0,
"DateTime": "2021-06-14T00:33:42.4705307Z",
"Description": "sample string 3",
"InvoiceId": 4,
"IssuingAccountId": 5,
"RecipientAccountId": 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": 7
}
],
"RefundDeductions": [
{
"Amount": 1.0,
"DateTime": "2021-06-14T00:33:42.4705307Z",
"Description": "sample string 3",
"InvoiceId": 4,
"IssuingAccountId": 5,
"RecipientAccountId": 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": 7
},
{
"Amount": 1.0,
"DateTime": "2021-06-14T00:33:42.4705307Z",
"Description": "sample string 3",
"InvoiceId": 4,
"IssuingAccountId": 5,
"RecipientAccountId": 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": 7
}
],
"ClosingBalance": 1.0,
"Name": "sample string 2",
"Total": 3.0,
"TotalUncleared": 4.0,
"Deductions": 5.0,
"ToPay": 6.0,
"Received": 7.0,
"AllDisbursements": 8.0,
"NumberOfItems": 9,
"LastStatementDate": "2021-06-14T00:33:42.4705307Z",
"AssociatedGroupId": 10,
"IsTenant": true,
"IsLandlord": true,
"IsCompany": true,
"Id": 11
}