POST api/invoice/sales/create
Create a new invoice Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The create sales invoice data contract supplied with the request.
CreateSalesInvoiceDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| LiableAccountId |
The unique identifier of the related liable account resource. |
integer |
None. |
| RecipientAccountId |
The unique identifier of the related recipient account resource. |
integer |
None. |
| Date |
The date, expressed as a date and time. |
date |
None. |
| RentPeriodEndDate |
The rent period end date, expressed as a date and time. |
date |
None. |
| Description |
The description value. |
string |
None. |
| InvoiceItems |
The collection of invoice items. |
Collection of InvoiceItemDataContract |
None. |
| Notes |
The notes value. |
string |
None. |
| Type |
The type classification. |
InvoiceType |
None. |
| InvoiceSubType |
The invoice sub type classification. |
InvoiceSubType |
None. |
| RelatedInvoiceId |
The unique identifier of the related related invoice resource. |
integer |
None. |
| TenancyRoleId |
The unique identifier of the related tenancy role resource. |
integer |
None. |
| PropertyId |
The unique identifier of the related property resource. |
integer |
None. |
| RelatedEntities |
The collection of related entities. |
Collection of RelatedEntityDataContract |
None. |
| CustomInvoiceNumber |
The custom invoice number value. |
string |
None. |
| InternalInvoice |
Indicates whether internal invoice is true. |
boolean |
None. |
| InvoiceStatus |
The invoice status classification. |
InvoiceStatus |
None. |
| Fees |
The collection of fees. |
Collection of AgencyFeeDataContract |
None. |
| IsRecurring |
Indicates whether this item is recurring. |
boolean |
None. |
| ScheduleDetails |
The schedule details value. |
RecurringInvoiceScheduleDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"LiableAccountId": 1,
"RecipientAccountId": 2,
"Date": "2026-07-23T10:35:56.7422741Z",
"RentPeriodEndDate": "2026-07-23T10:35:56.7422741Z",
"Description": "sample string 4",
"InvoiceItems": [
{
"Amount": 1.0,
"Name": "sample string 2",
"IsTaxable": true,
"TaxitemId": 1,
"Discount": 4.0,
"DiscountName": "sample string 5",
"DiscountDate": "2026-07-23T10:35:56.7422741Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7422741Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7422741Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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": "2026-07-23T10:35:56.7422741Z",
"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
}
],
"IsRecurring": true,
"ScheduleDetails": {
"AgencyId": 1,
"OriginalInvoiceId": 2,
"Frequency": 0,
"Occurrences": 3,
"Interval": 4,
"DaysOfTheWeek": 5,
"RecurringStartDate": "2026-07-23T10:35:56.7422741Z",
"RecurringEndDate": "2026-07-23T10:35:56.7422741Z",
"NextRunDate": "2026-07-23T10:35:56.7422741Z",
"MetaData": "sample string 8",
"IsActive": true,
"CreatedDate": "2026-07-23T10:35:56.7422741Z",
"LastUpdated": "2026-07-23T10:35:56.7422741Z",
"Id": 9
},
"Id": 9
}
Response Information
Resource Description
The response returned after the operation completes.
InvoiceDataContract| 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. |
| 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. |
| Description |
The description 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. |
| Payments |
The collection of payments. |
Collection of InvoicePaymentDataContract |
None. |
| Allocations |
The collection of allocations. |
Collection of InvoiceAllocationCollectionDataContract |
None. |
| InvoiceItems |
The collection of invoice items. |
Collection of InvoiceItemDetailDataContract |
None. |
| LinkedFees |
The collection of linked fees. |
Collection of LinkedFeeDataContract |
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. |
| InternalInvoiceNumber |
The internal invoice number value. |
integer |
None. |
| PreviewReziDocumentRef |
The preview rezi document ref value. |
string |
None. |
| IsRecurring |
Indicates whether this item is recurring. |
boolean |
None. |
| ScheduleFrequency |
The schedule frequency value. |
integer |
None. |
| ScheduleOccurrences |
The schedule occurrences value. |
integer |
None. |
| ScheduleInterval |
The schedule interval value. |
integer |
None. |
| ScheduleStartDate |
The schedule start date, expressed as a date and time. |
date |
None. |
| ScheduleEndDate |
The schedule end date, expressed as a date and time. |
date |
None. |
| ScheduleNextRunDate |
The schedule next run date, expressed as a date and time. |
date |
None. |
| ScheduleIsActive |
Indicates whether schedule is active is true. |
boolean |
None. |
| ScheduleDaysOfTheWeek |
The schedule days of the week value. |
integer |
None. |
| ScheduleId |
The unique identifier of the related schedule resource. |
integer |
None. |
| ScheduleDisplayText |
The schedule display text 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",
"LiableAccountBalance": 6.0,
"LiableGroupId": 7.0,
"Status": "sample string 8",
"DueDate": "2026-07-23T10:35:56.7735262Z",
"CreatedDate": "2026-07-23T10:35:56.7735262Z",
"RentPeriodEndDate": "2026-07-23T10:35:56.7735262Z",
"InvoiceNumber": 1,
"Description": "sample string 11",
"InvoiceType": "sample string 12",
"InvoiceSubType": "sample string 13",
"TotalAmount": 14.0,
"SubTotalAmount": 15.0,
"TaxTotalAmount": 16.0,
"DiscountTotalAmount": 17.0,
"TotalOutstanding": 18.0,
"TotalPaid": 19.0,
"Notes": "sample string 20",
"Payments": [
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T10:35:56.7735262Z",
"Id": 4
},
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2026-07-23T10:35:56.7735262Z",
"Id": 4
}
],
"Allocations": [
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T10:35:56.7735262Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T10:35:56.7735262Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
},
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"Regarding": "sample string 3",
"Description": "sample string 4",
"AllocationItems": [
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T10:35:56.7735262Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2026-07-23T10:35:56.7735262Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2026-07-23T10:35:56.7735262Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 5
}
],
"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": "2026-07-23T10:35:56.7735262Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7735262Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7735262Z",
"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": "2026-07-23T10:35:56.7735262Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7735262Z",
"Id": 8
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"InvoiceNumber": 5,
"InvoiceId": 6,
"CreatedDate": "2026-07-23T10:35:56.7735262Z",
"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 21",
"RelatedInvoiceId": 1,
"CustomInvoiceNumber": "sample string 22",
"DocumentIds": [
1,
2
],
"PropertyAccountId": 1,
"InternalInvoiceNumber": 1,
"PreviewReziDocumentRef": "sample string 23",
"IsRecurring": true,
"ScheduleFrequency": 1,
"ScheduleOccurrences": 1,
"ScheduleInterval": 1,
"ScheduleStartDate": "2026-07-23T10:35:56.7735262Z",
"ScheduleEndDate": "2026-07-23T10:35:56.7735262Z",
"ScheduleNextRunDate": "2026-07-23T10:35:56.7735262Z",
"ScheduleIsActive": true,
"ScheduleDaysOfTheWeek": 24,
"ScheduleId": 25,
"ScheduleDisplayText": "Occurs daily for 1 time",
"Id": 26
}