Hybrid Layout

With the release of AccountRight 2020.1, two changes were introduced to the API:

1. Introduction of support for hybrid layout transactions.
2. Adding additional fields to item and service lines within item, service and hybrid layouts.

Please Note: In order to use the hybrid layout via the API, this needs to enabled from within the file first.
To do this:

1. Open the file in the web browser.
2. Click on the business name in the top right.
3. Select Sales settings. (for Purchases, select Purchase settings)
4. Change the field layout to Service and Item.

Attention: Use of the freight fields is not supported for AccountRight, MYOB Business or Essentials when using the Hybrid Layout. If you need to have freight, then you will need to display it as a line item on the transaction. 

 Changes were made to the existing Item & Service endpoints. Additional properties have been be exposed for the Item & Service endpoints, see below: 

Service Layout/Endpoint: 
   +UnitsOfMeasure - String (5) 
   +UnitCount - Decimal (13.6) 
   +UnitPrice - Decimal (13.6) 
   +UnitPriceForeign - Decimal (13.2) 
   +DiscountPercent - Double (99.99%) 
 
ItemLayout/Endpoint: 
   +UnitsOfMeasure - String (5) 
   +UnitCount - Decimal (13.6) 
   +Account 
       +UID -Guid (36) 
        +Name -String (60) 
        +DisplayID - String (6) 
        +URI - String 
 
 
How are Developers going to be impacted: 

Service Layout 
Ability to maintain unit of measure, count and price for invoice/quote/order/bill transactions will be available via the API.

Item Layout 
Not only item lines, but also service line are allowed to be recorded if both UnitPrice and UnitCount are provided. This means an item layout transaction could be in following formats:
 - An invoice/quote/bill contains only item line(s).
 - An invoice/quote/bill contains item line(s) and service line(s). NEW

While these transactions will be editable within new Essentials and AccountRight Browser. It is important to note that these transactions will be read only when using the AccountRight Desktop application.

Valiation Errors that you may come accross: 

{
"Name": "CannotUseItemAndAccountOnSameLine",
"Message": "Cannot use both Item and Account on the same line.",
 "ErrorCode": 10007,
 "Severity": "Error"
}

{
 "Name": "RequireEitherItemOrAccountOnTransactionLine",
 "Message": "Either an Item or an Account is required on a Transaction line.",
 "ErrorCode": 10008,
 "Severity": "Error"
}

{
 "Name": "HybridLayoutIsNotSupported",
 "Message": "Hybrid Layout Is Not Supported.",
 "ErrorCode": 10009,
 "Severity": "Error"
}

 
Code samples