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

Edit regarding tenancy property in invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

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

The response returned after the operation completes.

InvoiceDocumentDataContract

Name	Description	Type	Additional information
RecipientAccountId	The unique identifier of the related recipient account resource.	integer	None.
LiableAccountId	The unique identifier of the related liable account resource.	integer	None.
RecipientAccountName	The recipient account name value.	string	None.
RecipientGroupId	The unique identifier of the related recipient group resource.	integer	None.
LiableAccountName	The liable account name value.	string	None.
IssuedByName	The issued by name value.	string	None.
IssuedToName	The issued to name value.	string	None.
LiableAccountBalance	The liable account balance value.	decimal number	None.
LiableGroupId	The unique identifier of the related liable group resource.	decimal number	None.
Status	The status value.	string	None.
DueDate	The due date, expressed as a date and time.	date	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
RentPeriodEndDate	The rent period end date, expressed as a date and time.	date	None.
InvoiceNumber	The invoice number value.	integer	None.
Title	The title value.	string	None.
InvoiceType	The invoice type value.	string	None.
InvoiceSubType	The invoice sub type value.	string	None.
TotalAmount	The total amount value.	decimal number	None.
SubTotalAmount	The sub total amount value.	decimal number	None.
TaxTotalAmount	The tax total amount value.	decimal number	None.
DiscountTotalAmount	The discount total amount value.	decimal number	None.
TotalOutstanding	The total outstanding value.	decimal number	None.
TotalPaid	The total paid value.	decimal number	None.
Notes	The notes value.	string	None.
InvoiceItems	The collection of invoice items.	Collection of InvoiceItemDocumentDataContract	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
TenancyRoleId	The unique identifier of the related tenancy role resource.	integer	None.
Address	The address value.	string	None.
RelatedInvoiceId	The unique identifier of the related related invoice resource.	integer	None.
CustomInvoiceNumber	The custom invoice number value.	string	None.
DocumentIds	The unique identifiers of the related document resources.	Collection of integer	None.
PropertyAccountId	The unique identifier of the related property account resource.	integer	None.
IssuedByAddress	The issued by address value.	AddressDataContract	None.
IssuedToAddress	The issued to address value.	AddressDataContract	None.
PreviewReziDocumentRef	The preview rezi document ref value.	string	None.
Id	The unique identifier of this resource.	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": "2026-07-23T08:19:27.2917709Z",
  "CreatedDate": "2026-07-23T08:19:27.2917709Z",
  "RentPeriodEndDate": "2026-07-23T08:19:27.2917709Z",
  "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",
    "Country": "sample string 9",
    "Postcode": "sample string 10",
    "Uprn": "sample string 11",
    "CreatedDate": "2026-07-23T08:19:27.2917709Z",
    "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": 13
  },
  "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",
    "Country": "sample string 9",
    "Postcode": "sample string 10",
    "Uprn": "sample string 11",
    "CreatedDate": "2026-07-23T08:19:27.2917709Z",
    "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": 13
  },
  "PreviewReziDocumentRef": "sample string 26",
  "Id": 27
}