POST api/account/{id}/paymentoverview

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

ExtendedAccountPaymentDataContract
NameDescriptionTypeAdditional 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.

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.

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": "2019-06-18T22:57:01.4318331Z",
      "InvoiceItems": [
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "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": "2019-06-18T22:57:01.4318331Z",
      "InvoiceItems": [
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "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": "2019-06-18T22:57:01.4318331Z",
      "InvoiceItems": [
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "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": "2019-06-18T22:57:01.4318331Z",
      "InvoiceItems": [
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "Amount": 2.0,
          "Id": 3
        }
      ],
      "Allocations": [
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "Id": 4
        },
        {
          "Date": "2019-06-18T22:57:01.4318331Z",
          "Amount": 2.0,
          "InvoiceItem": 3,
          "Allocations": [
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            },
            {
              "Date": "2019-06-18T22:57:01.4318331Z",
              "Amount": 2.0,
              "InvoiceId": 3,
              "InvoiceDescription": "sample string 4",
              "Protected": true,
              "ProtectedDate": "2019-06-18T22:57:01.4318331Z",
              "Id": 7
            }
          ],
          "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": "2019-06-18T22:57:01.4474557Z",
      "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": "2019-06-18T22:57:01.4474557Z",
      "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": "2019-06-18T22:57:01.509957Z",
      "Description": "sample string 3",
      "IssuingAccountId": 4,
      "RecipientAccountId": 5,
      "Id": 6
    },
    {
      "Amount": 1.0,
      "DateTime": "2019-06-18T22:57:01.509957Z",
      "Description": "sample string 3",
      "IssuingAccountId": 4,
      "RecipientAccountId": 5,
      "Id": 6
    }
  ],
  "RefundDeductions": [
    {
      "Amount": 1.0,
      "DateTime": "2019-06-18T22:57:01.509957Z",
      "Description": "sample string 3",
      "IssuingAccountId": 4,
      "RecipientAccountId": 5,
      "Id": 6
    },
    {
      "Amount": 1.0,
      "DateTime": "2019-06-18T22:57:01.509957Z",
      "Description": "sample string 3",
      "IssuingAccountId": 4,
      "RecipientAccountId": 5,
      "Id": 6
    }
  ],
  "ClosingBalance": 1.0,
  "Name": "sample string 2",
  "Total": 3.0,
  "Deductions": 4.0,
  "ToPay": 5.0,
  "Received": 6.0,
  "AllDisbursements": 7.0,
  "NumberOfItems": 8,
  "LastStatementDate": "2019-06-18T22:57:01.509957Z",
  "AssociatedGroupId": 9,
  "Id": 10
}