PUT api/invoice/sales/edit?id={id}

Edit a draft invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The invoice id to edit

integer

Required

Body Parameters

Invoice data contract

Dezrez.Core.DataContracts.Accounts.Invoices.CreateSalesInvoiceDataContract
NameDescriptionTypeAdditional information
LiableAccountId

integer

None.

RecipientAccountId

integer

None.

Date

date

None.

RentPeriodEndDate

date

None.

Description

string

None.

InvoiceItems

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.InvoiceItemDataContract

None.

Notes

string

None.

Type

Dezrez.Core.DataContracts.Accounts.Invoices.InvoiceType

None.

InvoiceSubType

Dezrez.Core.DataContracts.Accounts.Invoices.InvoiceSubType

None.

RelatedInvoiceId

integer

None.

TenancyRoleId

integer

None.

PropertyId

integer

None.

RelatedEntities

Collection of Dezrez.Core.DataContracts.Accounts.AccountingSystem.Query.RelatedEntityDataContract

None.

CustomInvoiceNumber

string

None.

InternalInvoice

boolean

None.

InvoiceStatus

Dezrez.Rezi.Domain.Accounts.Enums.InvoiceStatus

None.

Fees

Collection of Dezrez.Core.DataContracts.External.Api.Agency.Query.Fees.AgencyFeeDataContract

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "LiableAccountId": 1,
  "RecipientAccountId": 2,
  "Date": "2024-11-04T18:50:24.949431Z",
  "RentPeriodEndDate": "2024-11-04T18:50:24.949431Z",
  "Description": "sample string 4",
  "InvoiceItems": [
    {
      "Amount": 1.0,
      "Name": "sample string 2",
      "IsTaxable": true,
      "TaxitemId": 1,
      "Discount": 4.0,
      "DiscountName": "sample string 5",
      "DiscountDate": "2024-11-04T18:50:24.949431Z",
      "Type": 0,
      "RelatedEntityId": 6,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        }
      ],
      "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,
      "Name": "sample string 2",
      "IsTaxable": true,
      "TaxitemId": 1,
      "Discount": 4.0,
      "DiscountName": "sample string 5",
      "DiscountDate": "2024-11-04T18:50:24.949431Z",
      "Type": 0,
      "RelatedEntityId": 6,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        }
      ],
      "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
    }
  ],
  "Notes": "sample string 5",
  "Type": 0,
  "InvoiceSubType": 0,
  "RelatedInvoiceId": 1,
  "TenancyRoleId": 1,
  "PropertyId": 1,
  "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"
    }
  ],
  "CustomInvoiceNumber": "sample string 6",
  "InternalInvoice": true,
  "InvoiceStatus": 0,
  "Fees": [
    {
      "Name": "sample string 1",
      "FeeValueType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeCategoryType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeChargeType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeLiabilityType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeFrequency": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeePercentageOfType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "VatRateType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ApplyTax": true,
      "VatValue": 3.1,
      "DefaultValue": 4.1,
      "ScaleableFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        }
      ],
      "AdditionalFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        }
      ],
      "Notes": "sample string 5",
      "TransactionType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "IsDefault": true,
      "CalculatedValue": 7.1,
      "AutoApply": true,
      "CreatedDate": "2024-11-04T18:50:24.949431Z",
      "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": 10
    },
    {
      "Name": "sample string 1",
      "FeeValueType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeCategoryType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeChargeType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeLiabilityType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeeFrequency": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FeePercentageOfType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "VatRateType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ApplyTax": true,
      "VatValue": 3.1,
      "DefaultValue": 4.1,
      "ScaleableFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        }
      ],
      "AdditionalFees": [
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        },
        {
          "Name": "sample string 1",
          "Threshold": 2.1,
          "Value": 3.1,
          "ThresholdType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "ValueType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "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": 5
        }
      ],
      "Notes": "sample string 5",
      "TransactionType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "IsDefault": true,
      "CalculatedValue": 7.1,
      "AutoApply": true,
      "CreatedDate": "2024-11-04T18:50:24.949431Z",
      "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": 10
    }
  ],
  "Id": 8
}

Response Information

Resource Description

Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceDataContract
NameDescriptionTypeAdditional information
RecipientAccountId

integer

None.

LiableAccountId

integer

None.

RecipientAccountName

string

None.

RecipientGroupId

integer

None.

LiableAccountName

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.

Description

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.

Payments

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoicePaymentDataContract

None.

Allocations

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceAllocationCollectionDataContract

None.

InvoiceItems

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.InvoiceItemDetailDataContract

None.

LinkedFees

Collection of Dezrez.Core.DataContracts.Accounts.Invoices.Query.LinkedFeeDataContract

None.

PropertyId

integer

None.

TenancyRoleId

integer

None.

Address

string

None.

RelatedInvoiceId

integer

None.

CustomInvoiceNumber

string

None.

DocumentIds

Collection of integer

None.

PropertyAccountId

integer

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",
  "LiableAccountBalance": 6.0,
  "LiableGroupId": 7.0,
  "Status": "sample string 8",
  "DueDate": "2024-11-04T18:50:24.949431Z",
  "CreatedDate": "2024-11-04T18:50:24.949431Z",
  "RentPeriodEndDate": "2024-11-04T18:50:24.949431Z",
  "InvoiceNumber": 11,
  "Description": "sample string 12",
  "InvoiceType": "sample string 13",
  "InvoiceSubType": "sample string 14",
  "TotalAmount": 15.0,
  "SubTotalAmount": 16.0,
  "TaxTotalAmount": 17.0,
  "DiscountTotalAmount": 18.0,
  "TotalOutstanding": 19.0,
  "TotalPaid": 20.0,
  "Notes": "sample string 21",
  "Payments": [
    {
      "PaymentNumber": "sample string 1",
      "Amount": 2.0,
      "Date": "2024-11-04T18:50:24.949431Z",
      "Id": 4
    },
    {
      "PaymentNumber": "sample string 1",
      "Amount": 2.0,
      "Date": "2024-11-04T18:50:24.949431Z",
      "Id": 4
    }
  ],
  "Allocations": [
    {
      "Date": "2024-11-04T18:50:24.949431Z",
      "Amount": 2.0,
      "Description": "sample string 3",
      "AllocationItems": [
        {
          "Date": "2024-11-04T18:50:24.949431Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2024-11-04T18:50:24.949431Z",
          "LandlordProtected": true,
          "Id": 9
        },
        {
          "Date": "2024-11-04T18:50:24.949431Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2024-11-04T18:50:24.949431Z",
          "LandlordProtected": true,
          "Id": 9
        }
      ],
      "Id": 4
    },
    {
      "Date": "2024-11-04T18:50:24.949431Z",
      "Amount": 2.0,
      "Description": "sample string 3",
      "AllocationItems": [
        {
          "Date": "2024-11-04T18:50:24.949431Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2024-11-04T18:50:24.949431Z",
          "LandlordProtected": true,
          "Id": 9
        },
        {
          "Date": "2024-11-04T18:50:24.949431Z",
          "Amount": 2.0,
          "InvoiceId": 3,
          "InvoiceItemId": 4,
          "InvoiceItemDescription": "sample string 5",
          "Protected": true,
          "ProtectedDate": "2024-11-04T18:50:24.949431Z",
          "LandlordProtected": true,
          "Id": 9
        }
      ],
      "Id": 4
    }
  ],
  "InvoiceItems": [
    {
      "TaxAmount": 1.0,
      "SubTotalAmount": 2.0,
      "TotalOutstanding": 3.0,
      "Amount": 4.0,
      "Name": "sample string 5",
      "IsTaxable": true,
      "TaxitemId": 1,
      "Discount": 7.0,
      "DiscountName": "sample string 8",
      "DiscountDate": "2024-11-04T18:50:24.949431Z",
      "Type": 0,
      "RelatedEntityId": 9,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        }
      ],
      "RefundItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "InvoiceId": 3,
          "RefundId": 4,
          "Id": 5
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "InvoiceId": 3,
          "RefundId": 4,
          "Id": 5
        }
      ],
      "Id": 10
    },
    {
      "TaxAmount": 1.0,
      "SubTotalAmount": 2.0,
      "TotalOutstanding": 3.0,
      "Amount": 4.0,
      "Name": "sample string 5",
      "IsTaxable": true,
      "TaxitemId": 1,
      "Discount": 7.0,
      "DiscountName": "sample string 8",
      "DiscountDate": "2024-11-04T18:50:24.949431Z",
      "Type": 0,
      "RelatedEntityId": 9,
      "CreditNoteItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "CreditNoteId": 3,
          "Reason": "sample string 4",
          "InvoiceNumber": 5,
          "InvoiceId": 6,
          "CreatedDate": "2024-11-04T18:50:24.949431Z",
          "Id": 8
        }
      ],
      "RefundItems": [
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "InvoiceId": 3,
          "RefundId": 4,
          "Id": 5
        },
        {
          "Amount": 1.0,
          "InvoiceItemId": 2,
          "InvoiceId": 3,
          "RefundId": 4,
          "Id": 5
        }
      ],
      "Id": 10
    }
  ],
  "LinkedFees": [
    {
      "LiableAccountId": 1,
      "RecipientAccountId": 2,
      "FeeId": 3,
      "ExternalReference": 4,
      "Id": 5
    },
    {
      "LiableAccountId": 1,
      "RecipientAccountId": 2,
      "FeeId": 3,
      "ExternalReference": 4,
      "Id": 5
    }
  ],
  "PropertyId": 1,
  "TenancyRoleId": 1,
  "Address": "sample string 22",
  "RelatedInvoiceId": 1,
  "CustomInvoiceNumber": "sample string 23",
  "DocumentIds": [
    1,
    2
  ],
  "PropertyAccountId": 1,
  "PreviewReziDocumentRef": "sample string 24",
  "Id": 25
}