An AccountRight user has a choice of using a default template or a customised template when printing and/or emailing an invoice or a bill. As the equivalent choice is being offered for a new Essentials user, the AccountRight API has been updated to expose form templates based on the platform in use.
The /{cf_uri}/Company/FormTemplate endpoint returns available form templates based on a file. Below matrix explains expected form templates to be exposed based on the UIAccessFlag property value in the {domain}/accountright/ endpoint. For details visit here.
/{cf_uri}/Company/FormTemplate GET request Outcome | |||
UIAccessFlags | |||
1 | 2 | 3 | |
Sales | |||
- New EA Templates | 〇 | 〇 | |
- AR Templates | 〇 | 〇 | |
Purchases | |||
- New EA Templates | 〇 | 〇 | |
- AR Templates | 〇 | 〇 | |
Payslip | |||
- AR Templates | 〇 | 〇 | 〇 |
/{cf_uri}/Company/FormTemplate GET request Body | |
AccountRight template example | New Essentials template example |
. |
. . { "Name": "Standard", "Type": "Sale", "Layout": "Item", "IsSystem": false }, { "Name": "Standard", "Type": "Sale", "Layout": "Service", "IsSystem": false }, . . |
IMPORTANT:
Supported layout types in new Essentials are currently Service, Item and Hybrid(Service and Item). All new Essentials Sales and Purchases templates will return "IsSystem": false, whereas an AccountRight template returns false for a customised template and true for a default template.
Comments
0 comments
Article is closed for comments.