GET api/Invoice/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseResultOfInvoiceDetailResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | InvoiceDetailResponse |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"lineItems": [
{
"id": "0558f726-abe3-4ffa-a925-1ddfc0bc81d2",
"itemName": "sample string 2",
"quantity": 3,
"unitPrice": 4.0,
"totalPrice": 5.0
},
{
"id": "0558f726-abe3-4ffa-a925-1ddfc0bc81d2",
"itemName": "sample string 2",
"quantity": 3,
"unitPrice": 4.0,
"totalPrice": 5.0
}
],
"id": "54e00226-bd05-4503-9a4b-3ed50d91144d",
"invoiceNum": 2,
"invoiceDate": "2025-12-11T04:20:39.8997728+11:00",
"dueDate": "2025-12-11T04:20:39.8997728+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": "fb112602-a323-450f-8d96-c41e2c1f602c",
"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:39.8997728+11:00",
"membershipEndDate": "2025-12-11T04:20:39.8997728+11:00",
"paymentUrl": "sample string 21"
},
"message": "sample string 1"
}
application/octet-stream
Sample:
{"data":{"lineItems":[{"id":"0558f726-abe3-4ffa-a925-1ddfc0bc81d2","itemName":"sample string 2","quantity":3,"unitPrice":4.0,"totalPrice":5.0},{"id":"0558f726-abe3-4ffa-a925-1ddfc0bc81d2","itemName":"sample string 2","quantity":3,"unitPrice":4.0,"totalPrice":5.0}],"id":"54e00226-bd05-4503-9a4b-3ed50d91144d","invoiceNum":2,"invoiceDate":"2025-12-11T04:20:39.8997728+11:00","dueDate":"2025-12-11T04:20:39.8997728+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":"fb112602-a323-450f-8d96-c41e2c1f602c","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:39.8997728+11:00","membershipEndDate":"2025-12-11T04:20:39.8997728+11:00","paymentUrl":"sample string 21"},"message":"sample string 1"}
application/xml, text/xml
Sample:
<ResponseResultOfInvoiceDetailResponseYk_SafBg5 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.Invoice.Response">
<d2p1:AddressCountry>sample string 12</d2p1:AddressCountry>
<d2p1:AddressLine1>sample string 7</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 8</d2p1:AddressLine2>
<d2p1:AddressPostcode>sample string 11</d2p1:AddressPostcode>
<d2p1:AddressState>sample string 10</d2p1:AddressState>
<d2p1:AddressSuburb>sample string 9</d2p1:AddressSuburb>
<d2p1:Description>sample string 14</d2p1:Description>
<d2p1:DueDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-10T17:20:39.8997728Z</d3p1:DateTime>
<d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
</d2p1:DueDate>
<d2p1:Id>54e00226-bd05-4503-9a4b-3ed50d91144d</d2p1:Id>
<d2p1:InvoiceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-10T17:20:39.8997728Z</d3p1:DateTime>
<d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
</d2p1:InvoiceDate>
<d2p1:InvoiceNum>2</d2p1:InvoiceNum>
<d2p1:MemberNum>sample string 6</d2p1:MemberNum>
<d2p1:MembershipEndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-10T17:20:39.8997728Z</d3p1:DateTime>
<d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
</d2p1:MembershipEndDate>
<d2p1:MembershipStartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2025-12-10T17:20:39.8997728Z</d3p1:DateTime>
<d3p1:OffsetMinutes>660</d3p1:OffsetMinutes>
</d2p1:MembershipStartDate>
<d2p1:OrgId>fb112602-a323-450f-8d96-c41e2c1f602c</d2p1:OrgId>
<d2p1:OrgName>sample string 13</d2p1:OrgName>
<d2p1:PaymentUrl>sample string 21</d2p1:PaymentUrl>
<d2p1:Status>sample string 3</d2p1:Status>
<d2p1:TotalAmountIncGst>15</d2p1:TotalAmountIncGst>
<d2p1:TotalAmountPaid>20</d2p1:TotalAmountPaid>
<d2p1:TotalDiscount>17</d2p1:TotalDiscount>
<d2p1:TotalGst>16</d2p1:TotalGst>
<d2p1:TotalRebate>18</d2p1:TotalRebate>
<d2p1:TotalWriteOff>19</d2p1:TotalWriteOff>
<d2p1:UserFullName>sample string 5</d2p1:UserFullName>
<d2p1:UserId>sample string 4</d2p1:UserId>
<d2p1:LineItems>
<d2p1:LineItemResponse>
<d2p1:Id>0558f726-abe3-4ffa-a925-1ddfc0bc81d2</d2p1:Id>
<d2p1:ItemName>sample string 2</d2p1:ItemName>
<d2p1:Quantity>3</d2p1:Quantity>
<d2p1:TotalPrice>5</d2p1:TotalPrice>
<d2p1:UnitPrice>4</d2p1:UnitPrice>
</d2p1:LineItemResponse>
<d2p1:LineItemResponse>
<d2p1:Id>0558f726-abe3-4ffa-a925-1ddfc0bc81d2</d2p1:Id>
<d2p1:ItemName>sample string 2</d2p1:ItemName>
<d2p1:Quantity>3</d2p1:Quantity>
<d2p1:TotalPrice>5</d2p1:TotalPrice>
<d2p1:UnitPrice>4</d2p1:UnitPrice>
</d2p1:LineItemResponse>
</d2p1:LineItems>
</Data>
<Message>sample string 1</Message>
</ResponseResultOfInvoiceDetailResponseYk_SafBg5>