POST api/deposit/{depositInvoiceId}/release
Releases the deposit money back to the user. If invoices are supplied these are created for DepositDeductions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| depositInvoiceId | integer |
Required |
Body Parameters
ReleaseDepositDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountId | integer |
None. |
|
| ClientAccountId | integer |
None. |
|
| DepositCollectionId | integer |
None. |
|
| DepositDeductions | Collection of CreateSalesInvoiceDataContract |
None. |
|
| Notes | string |
None. |
|
| Id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"AccountId": 1,
"ClientAccountId": 1,
"DepositCollectionId": 2,
"DepositDeductions": [
{
"LiableAccountId": 1,
"RecipientAccountId": 2,
"Date": "2021-06-12T20:45:11.4399117Z",
"RentPeriodEndDate": "2021-06-12T20:45:11.4399117Z",
"Description": "sample string 4",
"InvoiceItems": [
{
"Amount": 1.0,
"Name": "sample string 2",
"IsTaxable": true,
"TaxitemId": 1,
"Discount": 4.0,
"DiscountName": "sample string 5",
"DiscountDate": "2021-06-12T20:45:11.4399117Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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": "2021-06-12T20:45:11.4399117Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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,
"PropertyId": 1,
"TenancyRoleId": 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"
}
],
"IsDraft": true,
"CustomInvoiceNumber": "sample string 7",
"InternalInvoice": true,
"Id": 9
},
{
"LiableAccountId": 1,
"RecipientAccountId": 2,
"Date": "2021-06-12T20:45:11.4399117Z",
"RentPeriodEndDate": "2021-06-12T20:45:11.4399117Z",
"Description": "sample string 4",
"InvoiceItems": [
{
"Amount": 1.0,
"Name": "sample string 2",
"IsTaxable": true,
"TaxitemId": 1,
"Discount": 4.0,
"DiscountName": "sample string 5",
"DiscountDate": "2021-06-12T20:45:11.4399117Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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": "2021-06-12T20:45:11.4399117Z",
"Type": 0,
"RelatedEntityId": 6,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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,
"PropertyId": 1,
"TenancyRoleId": 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"
}
],
"IsDraft": true,
"CustomInvoiceNumber": "sample string 7",
"InternalInvoice": true,
"Id": 9
}
],
"Notes": "sample string 3",
"Id": 4
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ReleaseDepositResponseDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Invoices | Collection of InvoiceDataContract |
None. |
|
| Notes | string |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Invoices": [
{
"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": "2021-06-12T20:45:11.4867519Z",
"CreatedDate": "2021-06-12T20:45:11.4867519Z",
"RentPeriodEndDate": "2021-06-12T20:45:11.4867519Z",
"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": "2021-06-12T20:45:11.4867519Z",
"Id": 4
},
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2021-06-12T20:45:11.4867519Z",
"Id": 4
}
],
"Allocations": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"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": "2021-06-12T20:45:11.4867519Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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": "2021-06-12T20:45:11.4867519Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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
],
"Id": 24
},
{
"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": "2021-06-12T20:45:11.4867519Z",
"CreatedDate": "2021-06-12T20:45:11.4867519Z",
"RentPeriodEndDate": "2021-06-12T20:45:11.4867519Z",
"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": "2021-06-12T20:45:11.4867519Z",
"Id": 4
},
{
"PaymentNumber": "sample string 1",
"Amount": 2.0,
"Date": "2021-06-12T20:45:11.4867519Z",
"Id": 4
}
],
"Allocations": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
}
],
"Id": 4
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"Description": "sample string 3",
"AllocationItems": [
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"LandlordProtected": true,
"Id": 9
},
{
"Date": "2021-06-12T20:45:11.4867519Z",
"Amount": 2.0,
"InvoiceId": 3,
"InvoiceItemId": 4,
"InvoiceItemDescription": "sample string 5",
"Protected": true,
"ProtectedDate": "2021-06-12T20:45:11.4867519Z",
"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": "2021-06-12T20:45:11.4867519Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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": "2021-06-12T20:45:11.4867519Z",
"Type": 0,
"RelatedEntityId": 9,
"CreditNoteItems": [
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
},
{
"Amount": 1.0,
"InvoiceItemId": 2,
"CreditNoteId": 3,
"Reason": "sample string 4",
"Id": 5
}
],
"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
],
"Id": 24
}
],
"Notes": "sample string 1",
"Id": 2
}