PUT api/invoice/updateproperty?invoiceId={invoiceId}&tenancyRoleId={tenancyRoleId}

Edit regarding tenancy property in invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
invoiceId	The invoice id to edit	integer	Required
tenancyRoleId	The tenancy role id to edit	integer	Required

Body Parameters

None.

Response Information

Resource Description

InvoiceDocumentDataContract

Name	Type	Additional information
RecipientAccountId	integer	None.
LiableAccountId	integer	None.
RecipientAccountName	string	None.
RecipientGroupId	integer	None.
LiableAccountName	string	None.
IssuedByName	string	None.
IssuedToName	string	None.
LiableAccountBalance	decimal number	None.
LiableGroupId	decimal number	None.
Status	string	None.
DueDate	date	None.
CreatedDate	date	None.
RentPeriodEndDate	date	None.
InvoiceNumber	integer	None.
Title	string	None.
InvoiceType	string	None.
InvoiceSubType	string	None.
TotalAmount	decimal number	None.
SubTotalAmount	decimal number	None.
TaxTotalAmount	decimal number	None.
DiscountTotalAmount	decimal number	None.
TotalOutstanding	decimal number	None.
TotalPaid	decimal number	None.
Notes	string	None.
InvoiceItems	Collection of InvoiceItemDocumentDataContract	None.
PropertyId	integer	None.
TenancyRoleId	integer	None.
Address	string	None.
RelatedInvoiceId	integer	None.
CustomInvoiceNumber	string	None.
DocumentIds	Collection of integer	None.
PropertyAccountId	integer	None.
IssuedByAddress	AddressDataContract	None.
IssuedToAddress	AddressDataContract	None.
PreviewReziDocumentRef	string	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "RecipientAccountId": 1,
  "LiableAccountId": 2,
  "RecipientAccountName": "sample string 3",
  "RecipientGroupId": 4,
  "LiableAccountName": "sample string 5",
  "IssuedByName": "sample string 6",
  "IssuedToName": "sample string 7",
  "LiableAccountBalance": 8.0,
  "LiableGroupId": 9.0,
  "Status": "sample string 10",
  "DueDate": "2025-11-18T14:11:26.2032998Z",
  "CreatedDate": "2025-11-18T14:11:26.2032998Z",
  "RentPeriodEndDate": "2025-11-18T14:11:26.2032998Z",
  "InvoiceNumber": 13,
  "Title": "sample string 14",
  "InvoiceType": "sample string 15",
  "InvoiceSubType": "sample string 16",
  "TotalAmount": 17.0,
  "SubTotalAmount": 18.0,
  "TaxTotalAmount": 19.0,
  "DiscountTotalAmount": 20.0,
  "TotalOutstanding": 21.0,
  "TotalPaid": 22.0,
  "Notes": "sample string 23",
  "InvoiceItems": [
    {
      "Amount": 1.0,
      "Discount": 2.0,
      "TaxAmount": 3.0,
      "SubTotalAmount": 4.0,
      "Type": 0,
      "Summary": "sample string 5",
      "UnitPrice": 6.0,
      "VAT": 7.0,
      "Id": 8
    },
    {
      "Amount": 1.0,
      "Discount": 2.0,
      "TaxAmount": 3.0,
      "SubTotalAmount": 4.0,
      "Type": 0,
      "Summary": "sample string 5",
      "UnitPrice": 6.0,
      "VAT": 7.0,
      "Id": 8
    }
  ],
  "PropertyId": 1,
  "TenancyRoleId": 1,
  "Address": "sample string 24",
  "RelatedInvoiceId": 1,
  "CustomInvoiceNumber": "sample string 25",
  "DocumentIds": [
    1,
    2
  ],
  "PropertyAccountId": 1,
  "IssuedByAddress": {
    "Location": {
      "CenterPoint": {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      },
      "Extent": [
        {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        }
      ],
      "ViewPoints": [
        {
          "Point": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Pitch": 1.1,
          "Heading": 2.1,
          "FieldOfVision": 3.1,
          "Zoom": 4.1,
          "Label": "sample string 5",
          "Id": 6
        },
        {
          "Point": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Pitch": 1.1,
          "Heading": 2.1,
          "FieldOfVision": 3.1,
          "Zoom": 4.1,
          "Label": "sample string 5",
          "Id": 6
        }
      ],
      "Id": 1
    },
    "AddressSource": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "SourceId": "sample string 1",
    "OrganizationName": "sample string 2",
    "Number": "sample string 3",
    "BuildingName": "sample string 4",
    "Street": "sample string 5",
    "Town": "sample string 6",
    "Locality": "sample string 7",
    "County": "sample string 8",
    "Postcode": "sample string 9",
    "Uprn": "sample string 10",
    "CreatedDate": "2025-11-18T14:11:26.2032998Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 12
  },
  "IssuedToAddress": {
    "Location": {
      "CenterPoint": {
        "Latitude": 1.1,
        "Longitude": 2.1,
        "Altitude": 3.1,
        "Order": 4,
        "Id": 5
      },
      "Extent": [
        {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        }
      ],
      "ViewPoints": [
        {
          "Point": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Pitch": 1.1,
          "Heading": 2.1,
          "FieldOfVision": 3.1,
          "Zoom": 4.1,
          "Label": "sample string 5",
          "Id": 6
        },
        {
          "Point": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Pitch": 1.1,
          "Heading": 2.1,
          "FieldOfVision": 3.1,
          "Zoom": 4.1,
          "Label": "sample string 5",
          "Id": 6
        }
      ],
      "Id": 1
    },
    "AddressSource": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "SourceId": "sample string 1",
    "OrganizationName": "sample string 2",
    "Number": "sample string 3",
    "BuildingName": "sample string 4",
    "Street": "sample string 5",
    "Town": "sample string 6",
    "Locality": "sample string 7",
    "County": "sample string 8",
    "Postcode": "sample string 9",
    "Uprn": "sample string 10",
    "CreatedDate": "2025-11-18T14:11:26.2032998Z",
    "CreatedBy": {
      "Initials": "sample string 1",
      "ContactName": "sample string 2",
      "Gender": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Title": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "PrimaryTelephone": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "PrimaryEmail": {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      "JobTitle": "sample string 6",
      "Id": 7
    },
    "Id": 12
  },
  "PreviewReziDocumentRef": "sample string 26",
  "Id": 27
}