GET api/Invoices/InvoicesByAccountkey/{AccountKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AccountKey

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Invoice
NameDescriptionTypeAdditional information
OwnerName1

string

None.

OwnerName2

string

None.

OwnerAddress

Address

None.

Description

string

None.

Description2

string

None.

Values

exValues

None.

InvoiceNumber

integer

None.

InvoiceType

integer

None.

InvoiceDescription

string

None.

InvoiceCode

string

None.

InvoiceCodeDescription

string

None.

Installment

integer

None.

ParcelID

string

None.

RowVersion

unsigned integer

None.

ValidTill

date

None.

BlackListInvoice

boolean

None.

Account

Account

None.

BilledAmount

decimal number

None.

AdditionalInfo

Dictionary of string [key] and Collection of Dictionary of string [key] and string [value] [value]

None.

ReceiptNumber

string

None.

Client

globally unique identifier

None.

IDHash

string

None.

Hash

string

None.

Version

integer

None.

BillingID

string

None.

LastUpdated

date

None.

BillDate

date

None.

ExpireDate

date

None.

DueDate

date

None.

IDs

IDFields

None.

Year

integer

None.

Name

string

None.

RecordType

string

None.

Payment

Payment

None.

BaseValues

Values

None.

CartPaymentAmount

decimal number

None.

RequiresAuthentication

boolean

None.

Locked

boolean

None.

RequiresGetDelinquents

boolean

None.

isDelinquent

boolean

None.

AuthenticationValues

Dictionary of string [key] and string [value]

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "2",
    "$type": "Avalon.Data.Taxes.VA.PCI.Invoice, WebPortalRTFAPI",
    "OwnerName1": "sample string 1",
    "OwnerName2": "sample string 2",
    "OwnerAddress": null,
    "Description": "sample string 3",
    "Description2": "sample string 4",
    "Values": {
      "$id": "3",
      "$type": "Avalon.Data.Taxes.VA.PCI.exValues, WebPortalRTFAPI",
      "Lines": {
        "$id": "4",
        "$values": [
          {
            "$id": "5",
            "$type": "Avalon.Data.Taxes.VA.PCI.Line, WebPortalRTFAPI",
            "Key": 1,
            "Type": "sample string 2",
            "TaxCodeDescription": "sample string 3",
            "Prompt": "sample string 4",
            "Code": 5,
            "BiID": "sample string 6",
            "ArLID": "sample string 7",
            "ItemDescription1": "sample string 8",
            "ItemDescription2": "sample string 9",
            "TaxRate": 10.0,
            "TaxRateBasis": 11.0,
            "TaxGroup": "sample string 12",
            "TaxYear": 13,
            "From": "2026-06-05T19:43:41.4211889-04:00",
            "To": "2026-06-05T19:43:41.4211889-04:00",
            "Fee": 14.0,
            "TaxableValue": 15.0,
            "TaxValue": 16.0,
            "LineValue": 17.0,
            "PaidAmount": 18.0,
            "NewInterest": 19.0,
            "NewPenalty": 20.0,
            "LateFilingPenalty": 21.0,
            "Assessed": 22.0,
            "PreTaxDiscount1": 23.0,
            "Adjusted": 24.0,
            "PPTRAValue": 25.0,
            "PostTaxDiscount": 26.0,
            "Exempt": 27.0,
            "Deffered": 28.0,
            "AnnualTax": 29.0,
            "AnnualRelief": 30.0,
            "Item": {
              "$id": "6",
              "$type": "Avalon.Data.Taxes.VA.PCI.Item, WebPortalRTFAPI",
              "Type": "sample string 1",
              "Description": "sample string 2",
              "Prompt": "sample string 3",
              "ItemNumber": "sample string 4",
              "OwnedFrom": "2026-06-05T19:43:41.4211889-04:00",
              "OwnedTo": "2026-06-05T19:43:41.4211889-04:00",
              "Address": null,
              "LocationAddress": null,
              "OwnerDeedName": "sample string 5",
              "MapNumber": "sample string 6",
              "LegalDescription1": "sample string 7",
              "LegalDescription2": "sample string 8",
              "LegalDescription3": "sample string 9",
              "Assessment": {
                "$id": "7",
                "$type": "Avalon.Data.Taxes.VA.PCI.ItemAssessment, WebPortalRTFAPI",
                "MVLand": 1.0,
                "MVImprovement": 2.0,
                "TVLand": 3.0,
                "TVImprovement": 4.0
              },
              "DistrictCode": "sample string 10",
              "DistrictName": "sample string 11",
              "ItemAttributes": {
                "$id": "8",
                "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
                "sample string 1": "sample string 2",
                "sample string 3": "sample string 4"
              }
            },
            "AdditionalInfo": {
              "$id": "9",
              "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.Collections.Generic.List`1[[System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib]], mscorlib]], mscorlib",
              "sample string 1": {
                "$id": "10",
                "$values": [
                  {
                    "$id": "11",
                    "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  {
                    "$id": "12",
                    "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  }
                ]
              },
              "sample string 2": {
                "$id": "13",
                "$values": [
                  {
                    "$id": "14",
                    "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  {
                    "$id": "15",
                    "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  }
                ]
              }
            },
            "CyclePeriodFrom": "2026-06-05T19:43:41.4211889-04:00",
            "CyclePeriodTo": "2026-06-05T19:43:41.4211889-04:00",
            "LesseeOwnerId": 1
          },
          {
            "$ref": "5"
          }
        ]
      },
      "BaseTax": 1.0,
      "Penalty": 2.0,
      "Interest": 3.0,
      "LateFilingPenalty": 4.0,
      "Assessed": 1,
      "Appraised": 1,
      "AssessmentRatio": 5.0,
      "Fee": 6.0,
      "OriginalAmountDue": 7.0,
      "AmountDue": 8.0
    },
    "InvoiceNumber": 5,
    "InvoiceType": 6,
    "InvoiceDescription": "sample string 7",
    "InvoiceCode": "sample string 8",
    "InvoiceCodeDescription": "sample string 9",
    "Installment": 10,
    "ParcelID": "sample string 11",
    "RowVersion": 12,
    "ValidTill": "2026-06-05T19:43:41.4211889-04:00",
    "BlackListInvoice": true,
    "Account": {
      "$id": "16",
      "$type": "Avalon.Data.Taxes.VA.PCI.Account, WebPortalRTFAPI",
      "Number": 1,
      "AccountName": "sample string 2",
      "Type": "sample string 3",
      "Description": "sample string 4",
      "TradingName": "sample string 5",
      "BadCheckStatus": true,
      "OpenStatuses": "sample string 7",
      "RowVersion": 8,
      "BlackListAccount": true,
      "Address": null,
      "Customers": {
        "$id": "17",
        "$values": [
          {
            "$id": "18",
            "$type": "Avalon.Data.Taxes.VA.PCI.Customer, WebPortalRTFAPI",
            "Key": 1,
            "FirstName": "sample string 2",
            "LastName": "sample string 3",
            "BusinessName": "sample string 4",
            "TradingName": "sample string 5",
            "Type": "sample string 6",
            "TypeDescription": "sample string 7",
            "Number": 8,
            "DLNumber": "sample string 9",
            "Address": null,
            "isPrimary": true,
            "ShortKey": "sample string 11",
            "EncKey": "sample string 12",
            "LongKey": "sample string 13",
            "RowVersion": 14
          },
          {
            "$ref": "18"
          }
        ]
      },
      "PrimaryCustomerNumber": 10,
      "CustomerNumber": 11,
      "AdditionalInfo": {
        "$id": "19",
        "$values": [
          {
            "$id": "20",
            "$type": "System.Object, mscorlib"
          },
          {
            "$id": "21",
            "$type": "System.Object, mscorlib"
          }
        ]
      },
      "AttributeInfo": {
        "$id": "22",
        "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    "BilledAmount": 15.0,
    "AdditionalInfo": {
      "$id": "23",
      "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.Collections.Generic.List`1[[System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib]], mscorlib]], mscorlib",
      "sample string 1": {
        "$id": "24",
        "$values": [
          {
            "$id": "25",
            "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          {
            "$id": "26",
            "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        ]
      },
      "sample string 2": {
        "$id": "27",
        "$values": [
          {
            "$id": "28",
            "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          {
            "$id": "29",
            "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        ]
      }
    },
    "ReceiptNumber": "sample string 16",
    "Client": "9d09cc73-c015-4176-a9d6-7fae63b0d517",
    "IDHash": "sample string 18",
    "Hash": "sample string 19",
    "Version": 20,
    "BillingID": "sample string 21",
    "LastUpdated": "2026-06-05T19:43:41.4211889-04:00",
    "BillDate": "2026-06-05T19:43:41.4211889-04:00",
    "ExpireDate": "2026-06-05T19:43:41.4211889-04:00",
    "DueDate": "2026-06-05T19:43:41.4211889-04:00",
    "IDs": {
      "$id": "30",
      "$type": "Avalon.Data.IDFields, WebPortalRTFAPI",
      "ID1": {
        "$id": "31",
        "$type": "Avalon.Data.IDField, WebPortalRTFAPI",
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      "ID2": {
        "$ref": "31"
      },
      "ID3": {
        "$ref": "31"
      },
      "ID4": {
        "$ref": "31"
      },
      "ID5": {
        "$ref": "31"
      }
    },
    "Year": 24,
    "Name": "sample string 25",
    "RecordType": "sample string 26",
    "Payment": {
      "$id": "32",
      "$type": "Avalon.Data.Payment, WebPortalRTFAPI",
      "Date": "2026-06-05T19:43:41.4211889-04:00",
      "PaymentStatus": "Paid",
      "PaymentStatusOther": "sample string 1",
      "Status": "Paid",
      "Amount": 1.0,
      "AllowPayment": true,
      "AllowPartialPayment": true,
      "AllowOverPayment": true,
      "MinimumPartialPayment": 5.0,
      "PayerName": "sample string 6"
    },
    "BaseValues": {
      "$id": "33",
      "$type": "Avalon.Data.Values, WebPortalRTFAPI",
      "OriginalAmountDue": 1.0,
      "AmountDue": 2.0
    },
    "CartPaymentAmount": 27.0,
    "RequiresAuthentication": true,
    "Locked": true,
    "RequiresGetDelinquents": true,
    "isDelinquent": true,
    "AuthenticationValues": {
      "$id": "34",
      "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[System.String, mscorlib]], mscorlib",
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  {
    "$ref": "2"
  }
]