Skip to content
Developerhome

Sales Artefacts

  Less than to read

Overview of Sales Artefacts

The Sage Accounting Zapier application was created using the publicly available API’s for Sage Business Cloud Accounting. The API’s support the 6 different regions this version of Sage Business Cloud Accounting is available in. The regions are Canada, France, Ireland, Spain, United Kingdom and USA.

Creating a single application for all six regions came with some compromises. For example the address region on both main and delivery address is set as required. The region is required in only Canada and the USA outside of Zapier meaning for other regions, free text needs to be added and not a USA state or Canadian province.

Zapier Fields available for Create Sales Invoice

Required Fields Field Description Is Required
Business Name The id of the customer or business Search Options *
Date The date of the invoice *
Invoice Number Prefix The invoice number prefix  
Invoice Number The generated invoice number  
Expiry Date The due date of the invoice  
Shipping Net Amount The net shipping amount  
Shipping Tax Rate The ID of the Shipping Tax Rate. Choose from drop down  
Currency The ID of the Currency. Choose from drop down  
Exchange Rate The exchange rate for the invoice  
Inverse Exchange Rate The inverse exchange rate for the invoice  
Reference The reference for the invoice  
Notes Invoice notes  
Status The ID of the Status. Choose from drop down  
Sent Indicates whether the invoice has been sent via email. Choose from drop down  
Terms and Conditions Invoice terms and conditions  
Main Address Line 1 The first line of the address *
Main Address Line 2 The second line of the address  
Main Address City The address town/city *
Main Address Postal Code or Zipcode The address postal code/zipcode *
Main Address Country Code The ID of the Country. Choose from drop down *
Main Address Type The ID of the Address Type. Choose from drop down *
Main Address Region The address state/province/region. Choose from drop down *
[Delivery Address] Line 1 The first line of the address  
[Delivery Address] Line 2 The second line of the address  
[Delivery Address] City The address town/city  
[Delivery Address] Postal Code or Zipcode The address postal code/zipcode  
[Delivery Address] Country Code The ID of the Country. Choose from drop down  
[Delivery Address] Type The ID of the Address Type. Choose from drop down  
[Delivery Address] Region The address state/province/region. Choose from drop down  
Product/Service Item Code The ID of the Product. Use Search to obtain ID  
Invoice line Quantity The quantity for the invoice line. Must be set to 1 for Start subscriptions *
Invoice line Description The description for the invoice line *
Invoice line Unit Price The unit price for the invoice line *
Tax Rate The ID of the Tax Rate. Choose from drop down  
Tax Amount The tax amount for the invoice line. This field is required, unless the tax rate is of a “zero”, “exempt” or “no_tax” type *
Invoice line Ledger Account_id The ID of the Ledger Account. Choose from drop down *
Discount Amount The discount amount for the invoice line  

Zapier Fields available for Update Sales Invoice

Required Fields Field Description Is Required
Sales Invoice Key The id of the sales invoice Search Options *
Business Name The contact the sales invoice relates to  
Date The date of the invoice *
Invoice Number Prefix The invoice number prefix  
Invoice Number The generated invoice number  
Expiry Date The due date of the invoice  
Shipping Net Amount The net shipping amount  
Shipping Tax Rate The ID of the Shipping Tax Rate. Choose from drop down  
Currency The ID of the Currency. Choose from drop down  
Exchange Rate The exchange rate for the invoice  
Inverse Exchange Rate The inverse exchange rate for the invoice  
Reference The reference for the invoice  
Notes Invoice notes  
Terms and Conditions Invoice terms and conditions  
Status The ID of the Status. Choose from drop down  
Sent Indicates whether the invoice has been sent via email. Choose from drop down  
Main Address Line 1 The first line of the address *
Main Address Line 2 The second line of the address  
Main Address City The address town/city *
Main Address Postal Code or Zipcode The address postal code/zipcode *
Main Address Country Code The ID of the Country. Choose from drop down *
Main Address Type The ID of the Address Type. Choose from drop down *
Main Address Region The address state/province/region. Choose from drop down *
[Delivery Address] Line 1 The first line of the address  
[Delivery Address] Line 2 The second line of the address  
[Delivery Address] City The address town/city  
[Delivery Address] Postal Code or Zipcode The address postal code/zipcode  
[Delivery Address] Country Code The ID of the Country. Choose from drop down  
[Delivery Address] Type The ID of the Address Type. Choose from drop down  
[Delivery Address] Region The address state/province/region. Choose from drop down  
Product/Service Item Code The ID of the Product. Use Search to obtain ID  
Invoice line Quantity The quantity for the invoice line. Must be set to 1 for Start subscriptions *
Invoice line Description The description for the invoice line *
Invoice line Unit Price The unit price for the invoice line *
Tax Rate The ID of the Tax Rate. Choose from drop down  
Tax Amount The tax amount for the invoice line. This field is required, unless the tax rate is of a “zero”, “exempt” or “no_tax” type *
Invoice line Ledger Account_id The ID of the Ledger Account. Choose from drop down *
Discount Amount The discount amount for the invoice line  

Zapier Fields available for Create Sales Quotes

Required Fields Field Description Is Required
Business Name The id of the customer or business Search Options *
Date The date of the invoice *
Quote Number Prefix The quote number prefix  
Invoice Number The generated invoice number  
Expiry Date The expiry date of the quote  
Shipping Net Amount The net shipping amount  
Shipping Tax Rate The ID of the Shipping Tax Rate. Choose from drop down  
Currency The ID of the Currency. Choose from drop down  
Exchange Rate The exchange rate for the quote  
Inverse Exchange Rate The inverse exchange rate for the quote  
Reference The reference for the quote  
Notes Invoice notes  
Status The ID of the Status. Choose from drop down  
Sent Indicates whether the invoice has been sent via email. Choose from drop down  
Terms and Conditions Quote terms and conditions  
Main Address Line 1 The first line of the address *
Main Address Line 2 The second line of the address  
Main Address City The address town/city *
Main Address Postal Code or Zipcode The address postal code/zipcode *
Main Address Country Code The ID of the Country. Choose from drop down *
Main Address Type The ID of the Address Type. Choose from drop down *
Main Address Region The address state/province/region. Choose from drop down *
[Delivery Address]) Line 1 The first line of the address  
[Delivery Address] Line 2 The second line of the address  
[Delivery Address] City The address town/city  
[Delivery Address] Postal Code or Zipcode The address postal code/zipcode  
[Delivery Address] Country Code The ID of the Country. Choose from drop down  
[Delivery Address] Type The ID of the Address Type. Choose from drop down  
[Delivery Address] Region The address state/province/region. Choose from drop down  
Product/Service Item Code The ID of the Product. Use Search to obtain ID  
Quote line Quantity The quantity for the quote line. Must be set to 1 for Start subscriptions *
Quote line Description The description for the quote line *
Quote line Unit Price The unit price for the quote line *
Tax Rate The ID of the Tax Rate. Choose from drop down  
Tax Amount The tax amount for the quote line. This field is required, unless the tax rate is of a “zero”, “exempt” or “no_tax” type *
Quote line Ledger Account_id The ID of the Ledger Account. Choose from drop down *
Discount Amount The discount amount for the quote line  

Zapier Fields available for Update Sales Quotes

Required Fields Field Description Is Required
Sales Quote Key The id of the sales quote Search Options *
Business Name The contact the sales invoice relates to  
Date The date of the invoice *
Quote Number Prefix The quote number prefix  
Invoice Number The generated invoice number  
Expiry Date The expiry date of the quote  
Shipping Net Amount The net shipping amount  
Shipping Tax Rate The ID of the Shipping Tax Rate. Choose from drop down  
Currency The ID of the Currency. Choose from drop down  
Exchange Rate The exchange rate for the quote  
Inverse Exchange Rate The inverse exchange rate for the quote  
Reference The reference for the quote  
Notes Invoice notes  
Terms and Conditions Quote terms and conditions  
Sent Indicates whether the invoice has been sent via email. Choose from drop down  
Main Address Line 1 The first line of the address *
Main Address Line 2 The second line of the address  
Main Address City The address town/city *
Main Address Postal Code or Zipcode The address postal code/zipcode *
Main Address Country Code The ID of the Country. Choose from drop down *
Main Address Type The ID of the Address Type. Choose from drop down *
Main Address Region The address state/province/region. Choose from drop down *
[Delivery Address]) Line 1 The first line of the address  
[Delivery Address] Line 2 The second line of the address  
[Delivery Address] City The address town/city  
[Delivery Address] Postal Code or Zipcode The address postal code/zipcode  
[Delivery Address] Country Code The ID of the Country. Choose from drop down  
[Delivery Address] Type The ID of the Address Type. Choose from drop down  
[Delivery Address] Region The address state/province/region. Choose from drop down  
Product/Service Item Code The ID of the Product. Use Search to obtain ID  
Quote line Quantity The quantity for the quote line. Must be set to 1 for Start subscriptions *
Quote line Description The description for the quote line *
Quote line Unit Price The unit price for the quote line *
Tax Rate The ID of the Tax Rate. Choose from drop down  
Tax Amount The tax amount for the quote line. This field is required, unless the tax rate is of a “zero”, “exempt” or “no_tax” type *
Quote line Ledger Account_id The ID of the Ledger Account. Choose from drop down *
Discount Amount The discount amount for the quote line