POST api/user/invoices
Request Information
URI Parameters
None.
Body Parameters
UserInvoiceListRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | string |
None. |
|
| InvoiceDateFrom | date |
None. |
|
| InvoiceDateTo | date |
None. |
|
| Page | integer |
None. |
|
| Size | integer |
None. |
|
| TotalItems | integer |
None. |
|
| SortOrder | string |
None. |
|
| SortField | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"userId": "sample string 1",
"invoiceDateFrom": "2025-12-11T04:20:12.1388005+11:00",
"invoiceDateTo": "2025-12-11T04:20:12.1388005+11:00",
"page": 2,
"size": 3,
"totalItems": 4,
"sortOrder": "sample string 5",
"sortField": "sample string 6"
}
application/octet-stream
Sample:
{"userId":"sample string 1","invoiceDateFrom":"2025-12-11T04:20:12.1388005+11:00","invoiceDateTo":"2025-12-11T04:20:12.1388005+11:00","page":2,"size":3,"totalItems":4,"sortOrder":"sample string 5","sortField":"sample string 6"}
application/xml, text/xml
Sample:
<UserInvoiceListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Request">
<Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Page>
<Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</Size>
<SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 6</SortField>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortOrder>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">4</TotalItems>
<InvoiceDateFrom xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-10T17:20:12.1388005Z</d2p1:DateTime>
<d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
</InvoiceDateFrom>
<InvoiceDateTo xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>2025-12-10T17:20:12.1388005Z</d2p1:DateTime>
<d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
</InvoiceDateTo>
<UserId>sample string 1</UserId>
</UserInvoiceListRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseResultOfUserInvoiceListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | UserInvoiceListResponse |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"userId": "sample string 1",
"invoices": [
{
"id": "8d6af68f-6959-4d4b-9a7f-985d89f397ba",
"invoiceNum": 2,
"invoiceDate": "2025-12-11T04:20:12.154426+11:00",
"dueDate": "2025-12-11T04:20:12.154426+11:00",
"status": "sample string 3",
"userId": "sample string 4",
"userFullName": "sample string 5",
"memberNum": "sample string 6",
"addressLine1": "sample string 7",
"addressLine2": "sample string 8",
"addressSuburb": "sample string 9",
"addressState": "sample string 10",
"addressPostcode": "sample string 11",
"addressCountry": "sample string 12",
"orgId": "5a1bfbae-c41b-415d-9ba6-ce090369083b",
"orgName": "sample string 13",
"description": "sample string 14",
"totalAmountIncGst": 15.0,
"totalGst": 16.0,
"totalDiscount": 17.0,
"totalRebate": 18.0,
"totalWriteOff": 19.0,
"totalAmountExcGst": -1.0,
"netTotalAmount": -20.0,
"totalAmountPaid": 20.0,
"balanceDue": -59.0,
"membershipStartDate": "2025-12-11T04:20:12.154426+11:00",
"membershipEndDate": "2025-12-11T04:20:12.154426+11:00",
"paymentUrl": "sample string 21"
},
{
"id": "8d6af68f-6959-4d4b-9a7f-985d89f397ba",
"invoiceNum": 2,
"invoiceDate": "2025-12-11T04:20:12.154426+11:00",
"dueDate": "2025-12-11T04:20:12.154426+11:00",
"status": "sample string 3",
"userId": "sample string 4",
"userFullName": "sample string 5",
"memberNum": "sample string 6",
"addressLine1": "sample string 7",
"addressLine2": "sample string 8",
"addressSuburb": "sample string 9",
"addressState": "sample string 10",
"addressPostcode": "sample string 11",
"addressCountry": "sample string 12",
"orgId": "5a1bfbae-c41b-415d-9ba6-ce090369083b",
"orgName": "sample string 13",
"description": "sample string 14",
"totalAmountIncGst": 15.0,
"totalGst": 16.0,
"totalDiscount": 17.0,
"totalRebate": 18.0,
"totalWriteOff": 19.0,
"totalAmountExcGst": -1.0,
"netTotalAmount": -20.0,
"totalAmountPaid": 20.0,
"balanceDue": -59.0,
"membershipStartDate": "2025-12-11T04:20:12.154426+11:00",
"membershipEndDate": "2025-12-11T04:20:12.154426+11:00",
"paymentUrl": "sample string 21"
}
],
"page": 2,
"size": 3,
"totalItems": 4,
"sortOrder": "sample string 5",
"sortField": "sample string 6"
},
"message": "sample string 1"
}
application/octet-stream
Sample:
{"data":{"userId":"sample string 1","invoices":[{"id":"8d6af68f-6959-4d4b-9a7f-985d89f397ba","invoiceNum":2,"invoiceDate":"2025-12-11T04:20:12.154426+11:00","dueDate":"2025-12-11T04:20:12.154426+11:00","status":"sample string 3","userId":"sample string 4","userFullName":"sample string 5","memberNum":"sample string 6","addressLine1":"sample string 7","addressLine2":"sample string 8","addressSuburb":"sample string 9","addressState":"sample string 10","addressPostcode":"sample string 11","addressCountry":"sample string 12","orgId":"5a1bfbae-c41b-415d-9ba6-ce090369083b","orgName":"sample string 13","description":"sample string 14","totalAmountIncGst":15.0,"totalGst":16.0,"totalDiscount":17.0,"totalRebate":18.0,"totalWriteOff":19.0,"totalAmountExcGst":-1.0,"netTotalAmount":-20.0,"totalAmountPaid":20.0,"balanceDue":-59.0,"membershipStartDate":"2025-12-11T04:20:12.154426+11:00","membershipEndDate":"2025-12-11T04:20:12.154426+11:00","paymentUrl":"sample string 21"},{"id":"8d6af68f-6959-4d4b-9a7f-985d89f397ba","invoiceNum":2,"invoiceDate":"2025-12-11T04:20:12.154426+11:00","dueDate":"2025-12-11T04:20:12.154426+11:00","status":"sample string 3","userId":"sample string 4","userFullName":"sample string 5","memberNum":"sample string 6","addressLine1":"sample string 7","addressLine2":"sample string 8","addressSuburb":"sample string 9","addressState":"sample string 10","addressPostcode":"sample string 11","addressCountry":"sample string 12","orgId":"5a1bfbae-c41b-415d-9ba6-ce090369083b","orgName":"sample string 13","description":"sample string 14","totalAmountIncGst":15.0,"totalGst":16.0,"totalDiscount":17.0,"totalRebate":18.0,"totalWriteOff":19.0,"totalAmountExcGst":-1.0,"netTotalAmount":-20.0,"totalAmountPaid":20.0,"balanceDue":-59.0,"membershipStartDate":"2025-12-11T04:20:12.154426+11:00","membershipEndDate":"2025-12-11T04:20:12.154426+11:00","paymentUrl":"sample string 21"}],"page":2,"size":3,"totalItems":4,"sortOrder":"sample string 5","sortField":"sample string 6"},"message":"sample string 1"}
application/xml, text/xml
Sample:
<ResponseResultOfUserInvoiceListResponseBtYhHhLc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Response">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.User.Response">
<Page xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">2</Page>
<Size xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">3</Size>
<SortField xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 6</SortField>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">sample string 5</SortOrder>
<TotalItems xmlns="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Global.Pagination">4</TotalItems>
<d2p1:Invoices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BondMX.Api.Common.Invoice.Response">
<d3p1:InvoiceResponse>
<d3p1:AddressCountry>sample string 12</d3p1:AddressCountry>
<d3p1:AddressLine1>sample string 7</d3p1:AddressLine1>
<d3p1:AddressLine2>sample string 8</d3p1:AddressLine2>
<d3p1:AddressPostcode>sample string 11</d3p1:AddressPostcode>
<d3p1:AddressState>sample string 10</d3p1:AddressState>
<d3p1:AddressSuburb>sample string 9</d3p1:AddressSuburb>
<d3p1:Description>sample string 14</d3p1:Description>
<d3p1:DueDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:DueDate>
<d3p1:Id>8d6af68f-6959-4d4b-9a7f-985d89f397ba</d3p1:Id>
<d3p1:InvoiceDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:InvoiceDate>
<d3p1:InvoiceNum>2</d3p1:InvoiceNum>
<d3p1:MemberNum>sample string 6</d3p1:MemberNum>
<d3p1:MembershipEndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:MembershipEndDate>
<d3p1:MembershipStartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:MembershipStartDate>
<d3p1:OrgId>5a1bfbae-c41b-415d-9ba6-ce090369083b</d3p1:OrgId>
<d3p1:OrgName>sample string 13</d3p1:OrgName>
<d3p1:PaymentUrl>sample string 21</d3p1:PaymentUrl>
<d3p1:Status>sample string 3</d3p1:Status>
<d3p1:TotalAmountIncGst>15</d3p1:TotalAmountIncGst>
<d3p1:TotalAmountPaid>20</d3p1:TotalAmountPaid>
<d3p1:TotalDiscount>17</d3p1:TotalDiscount>
<d3p1:TotalGst>16</d3p1:TotalGst>
<d3p1:TotalRebate>18</d3p1:TotalRebate>
<d3p1:TotalWriteOff>19</d3p1:TotalWriteOff>
<d3p1:UserFullName>sample string 5</d3p1:UserFullName>
<d3p1:UserId>sample string 4</d3p1:UserId>
</d3p1:InvoiceResponse>
<d3p1:InvoiceResponse>
<d3p1:AddressCountry>sample string 12</d3p1:AddressCountry>
<d3p1:AddressLine1>sample string 7</d3p1:AddressLine1>
<d3p1:AddressLine2>sample string 8</d3p1:AddressLine2>
<d3p1:AddressPostcode>sample string 11</d3p1:AddressPostcode>
<d3p1:AddressState>sample string 10</d3p1:AddressState>
<d3p1:AddressSuburb>sample string 9</d3p1:AddressSuburb>
<d3p1:Description>sample string 14</d3p1:Description>
<d3p1:DueDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:DueDate>
<d3p1:Id>8d6af68f-6959-4d4b-9a7f-985d89f397ba</d3p1:Id>
<d3p1:InvoiceDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:InvoiceDate>
<d3p1:InvoiceNum>2</d3p1:InvoiceNum>
<d3p1:MemberNum>sample string 6</d3p1:MemberNum>
<d3p1:MembershipEndDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:MembershipEndDate>
<d3p1:MembershipStartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>2025-12-10T17:20:12.154426Z</d5p1:DateTime>
<d5p1:OffsetMinutes>660</d5p1:OffsetMinutes>
</d3p1:MembershipStartDate>
<d3p1:OrgId>5a1bfbae-c41b-415d-9ba6-ce090369083b</d3p1:OrgId>
<d3p1:OrgName>sample string 13</d3p1:OrgName>
<d3p1:PaymentUrl>sample string 21</d3p1:PaymentUrl>
<d3p1:Status>sample string 3</d3p1:Status>
<d3p1:TotalAmountIncGst>15</d3p1:TotalAmountIncGst>
<d3p1:TotalAmountPaid>20</d3p1:TotalAmountPaid>
<d3p1:TotalDiscount>17</d3p1:TotalDiscount>
<d3p1:TotalGst>16</d3p1:TotalGst>
<d3p1:TotalRebate>18</d3p1:TotalRebate>
<d3p1:TotalWriteOff>19</d3p1:TotalWriteOff>
<d3p1:UserFullName>sample string 5</d3p1:UserFullName>
<d3p1:UserId>sample string 4</d3p1:UserId>
</d3p1:InvoiceResponse>
</d2p1:Invoices>
<d2p1:UserId>sample string 1</d2p1:UserId>
</Data>
<Message>sample string 1</Message>
</ResponseResultOfUserInvoiceListResponseBtYhHhLc>