Arlo

REST Auth API: CreditNoteLines

CreditNoteLine resources are a subresource of CreditNote, and represent individual credit items.

Each line has a description, quantity, amount, and references to account codes and any applicable tax.

CreditNoteLine instance resource

Resource URI

/api/2012-02-01/auth/resources/creditnotes/{CreditNoteID}/lines/{CreditNoteLineID}/

General structure

<CreditNoteLine>
  <CreditNoteLineID>7192</CreditNoteLineID>
  <LineNumber>1</LineNumber>
  <Description>Facilitation - The Art of Collaborative Leadership (ART-014), 9-Oct-2015 8:00 AM, Hannah Lane</Description>
  <UnitAmount>450.00</UnitAmount>
  <Quantity>1.00</Quantity>
  <TaxAmount>67.50</TaxAmount>
  <LineAmount>517.50</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/creditnotes/302/lines/7192/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/CreditNote" type="application/xml" title="CreditNote" href="https://demo.arlo.co/api/2012-02-01/auth/resources/creditnotes/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/"/>
</CreditNoteLine>

Resource properties

Property Description
CreditNoteLineID An integer value that uniquely identifies this resource within the platform.
LineNumber An integer value identifying the number of this line within the credit note.
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 credit note.
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 credit note.
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.

HTTP GET

Returns a representation of a CreditNoteLine, 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/creditnotes/11079/lines/7192/

<CreditNoteLine>
  <CreditNoteLineID>7192</CreditNoteLineID>
  <LineNumber>1</LineNumber>
  <Description>Facilitation - The Art of Collaborative Leadership (ART-014), 9-Oct-2015 8:00 AM, Hannah Lane</Description>
  <UnitAmount>450.00</UnitAmount>
  <Quantity>1.00</Quantity>
  <TaxAmount>67.50</TaxAmount>
  <LineAmount>517.50</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/"/>
</CreditNoteLine>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.