SO Sales Order
URL | Verbs | Function |
|---|---|---|
SOSalesOrder | GET | Query a list of Sales Orders |
SOSalesOrder | POST | Create a Sales Order in Greentree |
SOSalesOrder/<reference> | GET | Query a single Sales Order |
| SOSalesOrder/<reference> | POST | Update an existing Sales Order in Greentree |
Supported modifiers
Query String | Definition | Sample | Available |
|---|---|---|---|
modifiedSince | Return a list of Sales Orders which have been modified since a date/time | modifiedSince=2012-09-11T10:30:00 | |
status | Return a list of Sales Orders which have a particular status | status=Entered | |
| salesPerson | Return a list of Sales Orders for a particular sales person | salesPerson=SMITH | |
| customer | Return a list of Sales Orders for a particular Customer | customer=1000 | |
| generateReceipt | When POSTing a Sales Order, an Unapplied Receipt is generated for the amount of the Sales Order | generateReceipt=true | |
| autoApplyReceipt | Used in conjunction with generateReceipt; at the time the Sales Order is Invoiced, the Receipt will be applied to the Invoice | autoApplyReceipt=true | |
| branch | Return a list of Sales Orders for a particular branch | branch=02 | 2017.1.0 |
| customerOrderNumber | Return a list of Sales Orders with the specific Customer Order Number. Best used in conjunction with the customer modifier | customerOrderNumber=45667777 | 2017.1.0 |
| allowLongDeliveryAddressName | Do not enforce 50 character limit on AddressName. Default behaviour as at 2018.1.0 is to restrict this to 50 chars. | allowLongDeliveryAddressName=true | 2018.1.0 |
| cancel | When POSTing a Sales Order, this will Cancel the Sales Order, looking for a property of CancelStatus in the POST data | action=cancel | 2018.2 |
| putOnHold | When POSTing a Sales Order, this will put the Sales Order on a hold status POSTed through as HoldStatus | action=putOnHold | 2020.3 |
| takeOffHold | When POSTing a Sales Order, this will take the Sales Order off hold status. POST through the desired OffHoldStatus, or leave blank for Entered | action=takeOffHold | 2020.3 |
| generateAdvanceReceipt | When POSTing a Sales Order, this will create an Advance Receipt instead of the typical generateReceipt | generateAdvanceReceipt= true | 2023.1 |
Security Linked Menu
Menu Item | Located |
|---|---|
| Sales Order Entry | Data Entry / Sales Orders |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<SOSalesOrder>
<Reference>500041</Reference>
<InstantAlert/>
<Edition>10</Edition>
<OidString>3493.188</OidString>
<ModifiedTimeStamp>2017-07-10T21:08:08</ModifiedTimeStamp>
<EntryTimeStamp>2016-09-05T21:03:17</EntryTimeStamp>
<CurrencyCode>AUD</CurrencyCode>
<Status>Order Confirmation</Status>
<Branch>03</Branch>
<StandardText/>
<Customer>1000</Customer>
<DocumentDate>2016-09-05</DocumentDate>
<SourceSystem>Greentree</SourceSystem>
<DiscountAmount>67.48</DiscountAmount>
<NetAmount>2631.76</NetAmount>
<SurchargeAmount>0.00</SurchargeAmount>
<TaxAmount>263.18</TaxAmount>
<IsCurrencyRateMultiply>true</IsCurrencyRateMultiply>
<CurrencyRate>1.00000000</CurrencyRate>
<AddressName/>
<DeliveryAddress>
<AddressNumber>1</AddressNumber>
<RunNumber>0</RunNumber>
<DropSequence>0</DropSequence>
<Instructions/>
<Contact>Des Stanley</Contact>
<Address1>(Rear Door) via lane</Address1>
<Address2>Lot 2, Main Hwy</Address2>
<Address3>MacGregor</Address3>
<Suburb/>
<Postcode>3125</Postcode>
<State>VIC</State>
<Country>AUS</Country>
<TZone>+10:00</TZone>
<PhoneBH>(03) 8425 1213</PhoneBH>
<PhoneAH/>
<Fax>( )</Fax>
<Email/>
<Web/>
<Mobile/>
</DeliveryAddress>
<CustomerOrderNumber/>
<DeliveryDate>2016-09-05</DeliveryDate>
<DiscountPercentage>5.00</DiscountPercentage>
<IsDropShip>false</IsDropShip>
<IsForwardOrder>false</IsForwardOrder>
<Type/>
<SalesPerson>SAMPSS</SalesPerson>
<Location>02</Location>
<LineItems collection='true' count='4'>
<LineItem>
<LineType>SOSOINLineItem</LineType>
<LineNumber>1</LineNumber>
<OidString>3489.397</OidString>
<Edition>5</Edition>
<TaxCode>GST 10%</TaxCode>
<TaxType>Inclusive</TaxType>
<Quantity>10.0000</Quantity>
<DiscountPercentage>5.00</DiscountPercentage>
<Amount>641.08</Amount>
<DiscountAmount>33.74</DiscountAmount>
<HoldAmount>0.00</HoldAmount>
<TaxAmount>64.11</TaxAmount>
<TaxPercentage>10.0000</TaxPercentage>
<UnitPrice>74.2300</UnitPrice>
<StandardText/>
<CurrencyRate>1.00000000</CurrencyRate>
<DocumentDate>2016-09-05</DocumentDate>
<IsCurrencyRateMultiply>true</IsCurrencyRateMultiply>
<IsRateFixed>true</IsRateFixed>
<LineItemType>IN</LineItemType>
<NonTaxPrice>67.4818</NonTaxPrice>
<PostingDate>2016-09-05</PostingDate>
<TaxInclusivePrice>74.2300</TaxInclusivePrice>
<Status>Order Confirmation</Status>
<TransactionType>Issue</TransactionType>
<PriceLevel>RETAIL</PriceLevel>
<DeliveryDate>2016-09-05</DeliveryDate>
<UnitCost>84.4800</UnitCost>
<IsHoldingPrice>false</IsHoldingPrice>
<IsHoldingDiscount>false</IsHoldingDiscount>
<IsHoldingCost>false</IsHoldingCost>
<QuantityCommitted>10.0000</QuantityCommitted>
<QuantityBackordered>0.0000</QuantityBackordered>
<Location>02</Location>
<UnitOfMeasure>EA</UnitOfMeasure>
<StockItem>01AOPENAX4B533</StockItem>
</LineItem>
<LineItem>
<LineType>SOSOINLineItem</LineType>
<LineNumber>2</LineNumber>
<OidString>3489.419</OidString>
<Edition>1</Edition>
<TaxCode>GST 10%</TaxCode>
<TaxType>Inclusive</TaxType>
<Quantity>10.0000</Quantity>
<DiscountPercentage>0.00</DiscountPercentage>
<Amount>674.82</Amount>
<DiscountAmount>0.00</DiscountAmount>
<HoldAmount>0.00</HoldAmount>
<TaxAmount>67.48</TaxAmount>
<TaxPercentage>10.0000</TaxPercentage>
<UnitPrice>74.2300</UnitPrice>
<StandardText/>
<CurrencyRate>1.00000000</CurrencyRate>
<DocumentDate>2016-09-05</DocumentDate>
<IsCurrencyRateMultiply>true</IsCurrencyRateMultiply>
<IsRateFixed>true</IsRateFixed>
<LineItemType>IN</LineItemType>
<NonTaxPrice>67.4818</NonTaxPrice>
<PostingDate>2016-09-05</PostingDate>
<TaxInclusivePrice>74.2300</TaxInclusivePrice>
<Status>Order Confirmation</Status>
<TransactionType>Issue</TransactionType>
<PriceLevel>RETAIL</PriceLevel>
<DeliveryDate>2016-09-05</DeliveryDate>
<UnitCost>84.4800</UnitCost>
<IsHoldingPrice>false</IsHoldingPrice>
<IsHoldingDiscount>false</IsHoldingDiscount>
<IsHoldingCost>false</IsHoldingCost>
<QuantityCommitted>10.0000</QuantityCommitted>
<QuantityBackordered>0.0000</QuantityBackordered>
<Location>02</Location>
<UnitOfMeasure>EA</UnitOfMeasure>
<StockItem>01AOPENAX4B533</StockItem>
</LineItem>
<LineItem>
<LineType>SOSOINLineItem</LineType>
<LineNumber>3</LineNumber>
<OidString>3489.420</OidString>
<Edition>1</Edition>
<TaxCode>GST 10%</TaxCode>
<TaxType>Exclusive</TaxType>
<Quantity>10.0000</Quantity>
<DiscountPercentage>5.00</DiscountPercentage>
<Amount>641.06</Amount>
<DiscountAmount>33.74</DiscountAmount>
<HoldAmount>0.00</HoldAmount>
<TaxAmount>64.11</TaxAmount>
<TaxPercentage>10.0000</TaxPercentage>
<UnitPrice>67.4800</UnitPrice>
<StandardText/>
<CurrencyRate>1.00000000</CurrencyRate>
<DocumentDate>2016-09-05</DocumentDate>
<IsCurrencyRateMultiply>true</IsCurrencyRateMultiply>
<IsRateFixed>true</IsRateFixed>
<LineItemType>IN</LineItemType>
<NonTaxPrice>67.4800</NonTaxPrice>
<PostingDate>2016-09-05</PostingDate>
<TaxInclusivePrice>74.2280</TaxInclusivePrice>
<Status>Order Confirmation</Status>
<TransactionType>Issue</TransactionType>
<PriceLevel>RETAIL</PriceLevel>
<DeliveryDate>2016-09-05</DeliveryDate>
<UnitCost>84.4800</UnitCost>
<IsHoldingPrice>false</IsHoldingPrice>
<IsHoldingDiscount>false</IsHoldingDiscount>
<IsHoldingCost>false</IsHoldingCost>
<QuantityCommitted>10.0000</QuantityCommitted>
<QuantityBackordered>0.0000</QuantityBackordered>
<Location>02</Location>
<UnitOfMeasure>EA</UnitOfMeasure>
<StockItem>01AOPENAX4B533</StockItem>
</LineItem>
<LineItem>
<LineType>SOSOINLineItem</LineType>
<LineNumber>4</LineNumber>
<OidString>3489.421</OidString>
<Edition>1</Edition>
<TaxCode>GST 10%</TaxCode>
<TaxType>Exclusive</TaxType>
<Quantity>10.0000</Quantity>
<DiscountPercentage>0.00</DiscountPercentage>
<Amount>674.80</Amount>
<DiscountAmount>0.00</DiscountAmount>
<HoldAmount>0.00</HoldAmount>
<TaxAmount>67.48</TaxAmount>
<TaxPercentage>10.0000</TaxPercentage>
<UnitPrice>67.4800</UnitPrice>
<StandardText/>
<CurrencyRate>1.00000000</CurrencyRate>
<DocumentDate>2016-09-05</DocumentDate>
<IsCurrencyRateMultiply>true</IsCurrencyRateMultiply>
<IsRateFixed>true</IsRateFixed>
<LineItemType>IN</LineItemType>
<NonTaxPrice>67.4800</NonTaxPrice>
<PostingDate>2016-09-05</PostingDate>
<TaxInclusivePrice>74.2280</TaxInclusivePrice>
<Status>Order Confirmation</Status>
<TransactionType>Issue</TransactionType>
<PriceLevel>RETAIL</PriceLevel>
<DeliveryDate>2016-09-05</DeliveryDate>
<UnitCost>84.4800</UnitCost>
<IsHoldingPrice>false</IsHoldingPrice>
<IsHoldingDiscount>false</IsHoldingDiscount>
<IsHoldingCost>false</IsHoldingCost>
<QuantityCommitted>10.0000</QuantityCommitted>
<QuantityBackordered>0.0000</QuantityBackordered>
<Location>02</Location>
<UnitOfMeasure>EA</UnitOfMeasure>
<StockItem>01AOPENAX4B533</StockItem>
</LineItem>
</LineItems>
</SOSalesOrder>
Sample XML packet when POSTing a Sales Order with Payment Details include as a child element of the SOSalesOrder
(* Note : Payment details does NOT constitute a Receipt in Greentree, the modifiers above (introduced in GT4@2) regarding Receipt generation are used to manage the Receipts *)
Sample XML Response
<PaymentDetails>
<ReceiptType>Banked Credit Card</ReceiptType>
<CustomerCreditCard>VISA</CustomerCreditCard>
<IsAdHoc>true</IsAdHoc>
<CreditCard>MASTERCARD</CreditCard>
<CardNumber>9873456454522456</CardNumber>
<SecurityCode>0567</SecurityCode>
<CardName>Mr Fred Astaire</CardName>
<ExpiryDate>0117</ExpiryDate>
<RequestId>56765757</RequestId>
<IsAuthorised>true</IsAuthorised>
<AuthoriseId>97897565</AuthoriseId>
<AuthoriseDate>2014-01-01</AuthoriseDate>
<AuthorisedValue>143.45</AuthorisedValue>
</PaymentDetails>
When generating a receipt, you are able to set some of the receipt values using an XML packet as part of the SOSalesOrder.
Sample XML Response
<Receipt>
<BankAccount>02</BankAccount> </Receipt>