REST Auth API: OrderLines
OrderLine resources are a subresource of Order, and represent individual invoice line items.
Each line has a description, quantity, amount, and references to account codes and any applicable tax. To help with auditing, each line can have a reference to the underlying billable item, such as a Registration on an event.
OrderLine instance resource
Resource URI
/api/2012-02-01/auth/resources/orders/{OrderID}/lines/{OrderLineID}/
General structure
<OrderLine> <OrderLineID>7192</OrderLineID> <LineNumber>1</LineNumber> <Description>Facilitation - The Art of Collaborative Leadership (ART-014), 9-Oct-2015 8:00 AM, Hannah Lane</Description> <UnitAmount>780.26</UnitAmount> <Quantity>1.00</Quantity> <DiscountAmount>-117.04</DiscountAmount> <TaxAmount>99.48</TaxAmount> <LineAmount>762.70</LineAmount> <AccountCode>GL15/200</AccountCode> <TaxAccountCode>GST15</TaxAccountCode> <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/302/lines/7192/"/> <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Order" type="application/xml" title="Order" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/302/"/> <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/9/"/> <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registration" type="application/xml" title="Registration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/99230/"/> </OrderLine>
Resource properties
| Property | Description |
|---|---|
| OrderLineID | An integer value that uniquely identifies this resource within the platform. |
| LineNumber | An integer value identifying the number of this line within the order. |
| UnitAmount |
The base amount for the item, supporting up to 4 decimal places of precision. This amount may be tax inclusive or exclusive depending on the LineAmountsTaxInclusive setting on the parent order.
|
| Quantity | The quantity multiplier for the line. |
| DiscountAmount | The total amount of any discounts applied to the line. Omitted if the line has no associated discounts. |
| TaxAmount | The amount of tax for the line, rounded to 2 decimal places of precision. Omitted if the line has no associated tax. |
| LineAmount |
The total for the line, inclusive of any discount amount, rounded to 2 decimal places of precision. This amount may be tax inclusive or exclusive depending on the LineAmountsTaxInclusive setting on the parent order.
|
| AccountCode | The revenue or income account code for the line. |
| TaxAccountCode | The tax account code for the line. Omitted if the line has no associated tax. |
Related resource links
| Link (title) | Description |
|---|---|
| Order | The parent Order that owns this instance. |
| TaxRate | Reference to a TaxRate for the line. Omitted if the line has no tax. |
| Registration | Reference to the Registration resource this orderline is for. Included only if there is a registration associated with the line. |
| EventSessionRegistration | Reference to the Session Registration resource this orderline is for. Included only if there is a registration associated with the line. |
| Event | Reference to the Event this orderline is for. Included only if the line is associated with an event run privately for an organisation. |
HTTP GET
Returns a representation of a OrderLine, including the properties and links above.
Optional parameters
| Parameter | Description |
|---|---|
| expand | Expression referencing Link elements to expand when generating the response. See link expansion. |
Example
GET /api/2012-02-01/auth/resources/orders/11079/lines/7192/
<OrderLine> <OrderLineID>7192</OrderLineID> <LineNumber>1</LineNumber> <Description>Facilitation - The Art of Collaborative Leadership (ART-014), 9-Oct-2015 8:00 AM, Hannah Lane</Description> <UnitAmount>780.26</UnitAmount> <Quantity>1.00</Quantity> <DiscountAmount>-117.04</DiscountAmount> <TaxAmount>99.48</TaxAmount> <LineAmount>762.70</LineAmount> <AccountCode>GL15/200</AccountCode> <TaxAccountCode>GST15</TaxAccountCode> <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/orders/302/lines/7192/"/> <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TaxRate" type="application/xml" title="TaxRate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/taxrates/9/"/> <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registration" type="application/xml" title="Registration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/99230/"/> </OrderLine>
HTTP POST
Not supported.
HTTP PUT
Not supported.
HTTP DELETE
Not supported.