Sage Accounting Component

Manage contacts and others connected to your Sage account.

Component key: sage

Description

Sage is software for managing your small business's accounting. This component allows you to generate and track invoices, manage accounts, contacts and more.

Connections

OAuth 2.0

You will first need to create and configure a Connected App within Sage Accounting. Be sure to enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Once the app has been created, you will be provided with a Client Id and Client Secret.

Create a new connection for the Sage component and use the following values:

For Client ID and Client Secret enter the values that you received previously.
For Scopes enter either full_access or readonly. Sage Authentication Documentation

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://www.sageone.com/oauth2/auth/central?filter=apiv3.1	The OAuth 2.0 Authorization URL for Sage
Client ID string / Required clientId		Client Identifier of your app for Sage
Client Secret password / Required clientSecret		Client Secret of your app for Sage
Scopes string / Required scopes	full_access	Space separated OAuth 2.0 permission scopes for Sage
Token URL string / Required Hidden Field tokenUrl	https://oauth.accounting.sage.com/token	The OAuth 2.0 Token URL for Sage

Actions

Create Contact

Create a new contact | key: createContact

Input	Default	Notes	Example
Account Name string accountName		Provide a string value for the name of the bank account.	Example Account
Account Number string accountNumber		Provide a valid bank account number.	Example Account No
Address Line 1 string addressLine1		Provide a valid street address	4 Privet Drive
Address Line 2 string addressLine2		Provide a string value for the 2nd address line.	apt 319
Address Name string addressName		Provide a string value for a name.	Example Name
Address Type Id string addressTypeId		Provide a unique identifier for the address type	90211
Bank Account Id string bankAccountId		Provide a value for the postal code.	example-9489210
BIC string bic		Provide a valid BIC for the bank account.	BOFA
City string city		Provide a string value for the city of the address.	Beverly Hills
Connection connection / Required connection
Contact Type Ids string / Required Value List contactTypeIds		For each list item, provide an Id of a contact type	example-2356795
Country Id string countryId		Provide a unique identifier for the contact's country.
Credit Days string creditDays		Provide a number value for the credit days of the contact.	10
Credit Limit string creditLimit		Provide a number value for the credit limit of the contact.	350.00
Currency Id string currencyId		Provide the unique identifier of the currency type.	example-24525235
Default Purchase Ledger Id string defaultPurchaseLedgerId		Provide the unique identifier of the default purchase ledger for the contact.	example-80430964
Default Sales Ledger Id string defaultSalesLedgerId		Provide the unique identifier of the default sales ledger.	example-80430964
Default Sales Tax Rate Id string defaultSalesTaxRateId		Provide the unique identifier of the sales tax rate for the contact.	example-80430964
Delivery Address Bank Account Id string deliveryBankAccountId		Provide a value for the postal code.	example-9489210
Delivery Address City string deliveryCity		Provide a string value for the city of the address.	Beverly Hills
Delivery Address Country Id string deliveryCountryId		Provide a unique identifier for the contact's country.
Delivery Address Line 1 string deliveryLine1		Provide a valid street address	4 Privet Drive
Delivery Address Line 2 string deliveryLine2		Provide a string value for the 2nd address line.	apt 319
Delivery Address Name string deliveryName		Provide a string value for a name.	Example Name
Delivery Address Postal Code string deliveryPostalCode		Provide a value for the postal code.	90211
Delivery Address Region string deliveryRegion		Provide a valid region for the contact.	North America
Delivery Address Type Id string deliveryTypeId		Provide a unique identifier for the address type	90211
IBAN string iban		Provide a valid IBAN for the bank account.	CY 17 002 00128 00000012005276002
Is Main Address boolean isMainAddress	false	This flag will determine if this is the contacts main address.
Is Main Address boolean isMainDelivery	false	This flag will determine if this is the contacts main address.
Name string / Required name		Provide a string value for a name.	Example Name
Notes string notes		Provide a string value for notes.	This is an example note.
Postal Code string postalCode		Provide a value for the postal code.	90211
Reference string reference		Provide a string value for the reference of the contact.	uniqueValue
Region string region		Provide a valid region for the contact.	North America
Sort Code string sortCode		Provide a sort code for the bank account.	12-34-56
Source GUID string sourceGuid		Provide a valid GUID, used for importing/exporting contacts from 3rd party services.	example-80430964
Tax Number string taxNumber		Provide a string value for the VAT registration number for the contact.	80430964

Example Payload for Create Contact

{
  "data": {
    "results": {
      "id": "example-80745034",
      "displayed_as": "Example Contact",
      "$path": "/contacts/example",
      "created_at": "2022-01-03T18:00:57Z",
      "updated_at": "2022-01-03T18:00:57Z",
      "links": [
        {
          "href": "https://accounting.na.sageone.com/contacts/customers/example",
          "rel": "alternative",
          "type": "text/html"
        }
      ],
      "contact_types": [
        {
          "id": "CUSTOMER",
          "displayd_as": "Customer"
        }
      ],
      "name": "exampleName",
      "reference": null,
      "default_sales_ledger_account": {
        "id": "example",
        "displayed_as": "Professional Fees"
      }
    }
  }
}

Create Ledger Account

Create a new Ledger account | key: createLedgerAccount

Input	Default	Notes	Example
Connection connection / Required connection
Display Name string / Required displayName		Provide a string value for the display name.	Example Name
Include In Chart boolean / Required includedInChart	false	This flag determines if the account will be included in the chart of accounts.	true
Ledger Account Type Id string / Required ledgerAccountTypeId		Provide the unique identifier of a ledger account type.	example-2356795
Name string / Required name		Provide a string value for a name.	Example Name
Nominal Code string / Required nominalCode		Provide an unique integer value for the nominal code of the ledger account.	1
Tax Rate Id string taxRateId		Provide the unique identifier of a tax rate id.	example-238953e2

Create Purchase Invoice

Create a new purchase invoice | key: createPurchaseInvoice

Input	Notes	Example
Connection connection / Required connection
Contact Id string / Required contactId	Provide the unique identifier of a contact.	example-533242
Date string / Required date	Provide a valid date value.	2022-01-03
Due Date string / Required dueDate	Provide a valid date value for the due date of the invoice.	2022-01-03
Invoice Lines code / Required invoiceLines	Provide a list of javascript objects, each containing information of an an invoice line item.
Total Amount string totalAmount	Provide a total amount for the invoice.	150.00

Create Sales Invoice

Create a new sales invoice | key: createSalesInvoice

Input	Notes	Example
Connection connection / Required connection
Contact Id string / Required contactId	Provide the unique identifier of a contact.	example-533242
Date string / Required date	Provide a valid date value.	2022-01-03
Invoice Lines code / Required invoiceLines	Provide a list of javascript objects, each containing information of an an invoice line item.
Total Amount string totalAmount	Provide a total amount for the invoice.	150.00

Delete Contact

Delete an existing contact by Id | key: deleteContact

Input	Notes	Example
Connection connection / Required connection
Contact Id string / Required contactId	Provide the unique identifier of a contact.	example-533242

Delete Contact Person

Delete an existing contact person by Id | key: deleteContactPerson

Input	Notes	Example
Connection connection / Required connection
Contact Person Id string / Required contactPersonId	Provide the unique identifier of a contact person.	example-533242

Delete Purchase Invoice

Delete the information and metadata of a purchase invoice by Id | key: deletePurchaseInvoice

Input	Notes	Example
Connection connection / Required connection
Purchase Invoice Id string / Required purchaseInvoiceId	Provide the unique identifier of a purchase invoice id.	example-533242

Delete Sales Invoice

Delete the information and metadata of a sales invoice by Id | key: deleteSalesInvoice

Input	Notes	Example
Connection connection / Required connection
Sales Invoice Id string / Required salesInvoiceId	Provide the unique identifier of a sales invoice id.	example-533242

Get Contact

Get the information and metadata of a contact by Id | key: getContact

Input	Notes	Example
Connection connection / Required connection
Contact Id string / Required contactId	Provide the unique identifier of a contact.	example-533242

Get Contact Person

Get the information and metadata of a contact person by Id | key: getContactPerson

Input	Notes	Example
Connection connection / Required connection
Contact Person Id string / Required contactPersonId	Provide the unique identifier of a contact person.	example-533242

Get Ledger Account

Get the information and metadata of a Ledger account | key: getLedgerAccount

Input	Notes	Example
Connection connection / Required connection
Ledger Account Id string / Required ledgerAccountId	Provide the unique identifier of a ledger account.	example-2356795

Get Purchase Invoice

Get the information and metadata of a purchase invoice by Id | key: getPurchaseInvoice

Input	Notes	Example
Connection connection / Required connection
Purchase Invoice Id string / Required purchaseInvoiceId	Provide the unique identifier of a purchase invoice id.	example-533242

Get Sales Invoice

Get the information and metadata of a sales invoice by Id | key: getSalesInvoice

Input	Notes	Example
Connection connection / Required connection
Sales Invoice Id string / Required salesInvoiceId	Provide the unique identifier of a sales invoice id.	example-533242

List Address Types

List all address types | key: listAddressTypes

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1

List Contact People

List all contact people | key: listContactPeople

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1
Update or Created Since string updated_or_created_since	Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+\|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+\|-)hh:mm). Inclusive of the passed timestamp.	2015-10-27T16:24:52Z

List Contact Types

List all contact types | key: listContactTypes

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1

List Contacts

List all contacts | key: listContacts

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1
Update or Created Since string updated_or_created_since	Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+\|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+\|-)hh:mm). Inclusive of the passed timestamp.	2015-10-27T16:24:52Z

List Countries

List all countries | key: listCountries

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1

List Currencies

List all currencies | key: listCurrencies

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1

List Ledger Account Types

List all Ledger account types | key: listLedgerAccountTypes

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1

List Ledger Accounts

List all Ledger accounts | key: listLedgerAccounts

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1
Update or Created Since string updated_or_created_since	Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+\|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+\|-)hh:mm). Inclusive of the passed timestamp.	2015-10-27T16:24:52Z

List Purchase Invoices

List all purchase invoices | key: listPurchaseInvoice

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1
Update or Created Since string updated_or_created_since	Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+\|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+\|-)hh:mm). Inclusive of the passed timestamp.	2015-10-27T16:24:52Z

List Sales Invoices

List all sales invoices | key: listSalesInvoices

Input	Notes	Example
Connection connection / Required connection
Items Per Page string itemsPerPage	Provide a value for the amount of items to be returned in the response.	100
Page string page	Provide a value for the page of results you would like to be returned.	1
Update or Created Since string updated_or_created_since	Use this to limit the response to Contacts changed since a given date (format: YYYY-MM-DDT(+\|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+\|-)hh:mm). Inclusive of the passed timestamp.	2015-10-27T16:24:52Z

Raw Request

Send raw HTTP request to Sage Accounting | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/contacts), The base URL is already included (https://api.accounting.sage.com/v3.1). For example, to connect to https://api.accounting.sage.com/v3.1/contacts, only /contacts is entered in this field.	/contacts
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Update Contact

Update the information and metadata of an existing contact by Id | key: updateContact

Input	Default	Notes	Example
Account Name string accountName		Provide a string value for the name of the bank account.	Example Account
Account Number string accountNumber		Provide a valid bank account number.	Example Account No
Address Line 1 string addressLine1		Provide a valid street address	4 Privet Drive
Address Line 2 string addressLine2		Provide a string value for the 2nd address line.	apt 319
Address Name string addressName		Provide a string value for a name.	Example Name
Address Type Id string addressTypeId		Provide a unique identifier for the address type	90211
Bank Account Id string bankAccountId		Provide a value for the postal code.	example-9489210
BIC string bic		Provide a valid BIC for the bank account.	BOFA
City string city		Provide a string value for the city of the address.	Beverly Hills
Connection connection / Required connection
Contact Id string / Required contactId		Provide the unique identifier of a contact.	example-533242
Contact Type Ids string Value List contactTypeIds		For each list item, provide an Id of a contact type	example-2356795
Country Id string countryId		Provide a unique identifier for the contact's country.
Credit Days string creditDays		Provide a number value for the credit days of the contact.	10
Credit Limit string creditLimit		Provide a number value for the credit limit of the contact.	350.00
Currency Id string currencyId		Provide the unique identifier of the currency type.	example-24525235
Default Purchase Ledger Id string defaultPurchaseLedgerId		Provide the unique identifier of the default purchase ledger for the contact.	example-80430964
Default Sales Ledger Id string defaultSalesLedgerId		Provide the unique identifier of the default sales ledger.	example-80430964
Default Sales Tax Rate Id string defaultSalesTaxRateId		Provide the unique identifier of the sales tax rate for the contact.	example-80430964
Delivery Address Bank Account Id string deliveryBankAccountId		Provide a value for the postal code.	example-9489210
Delivery Address City string deliveryCity		Provide a string value for the city of the address.	Beverly Hills
Delivery Address Country Id string deliveryCountryId		Provide a unique identifier for the contact's country.
Delivery Address Line 1 string deliveryLine1		Provide a valid street address	4 Privet Drive
Delivery Address Line 2 string deliveryLine2		Provide a string value for the 2nd address line.	apt 319
Delivery Address Name string deliveryName		Provide a string value for a name.	Example Name
Delivery Address Postal Code string deliveryPostalCode		Provide a value for the postal code.	90211
Delivery Address Region string deliveryRegion		Provide a valid region for the contact.	North America
Delivery Address Type Id string deliveryTypeId		Provide a unique identifier for the address type	90211
IBAN string iban		Provide a valid IBAN for the bank account.	CY 17 002 00128 00000012005276002
Is Main Address boolean isMainAddress	false	This flag will determine if this is the contacts main address.
Is Main Address boolean isMainDelivery	false	This flag will determine if this is the contacts main address.
Name string name		Provide a string value for a name.	Example Name
Notes string notes		Provide a string value for notes.	This is an example note.
Postal Code string postalCode		Provide a value for the postal code.	90211
Reference string reference		Provide a string value for the reference of the contact.	uniqueValue
Region string region		Provide a valid region for the contact.	North America
Sort Code string sortCode		Provide a sort code for the bank account.	12-34-56
Source GUID string sourceGuid		Provide a valid GUID, used for importing/exporting contacts from 3rd party services.	example-80430964
Tax Number string taxNumber		Provide a string value for the VAT registration number for the contact.	80430964

Example Payload for Update Contact

{
  "data": {
    "results": {
      "id": "example-80745034",
      "displayed_as": "Example Contact",
      "$path": "/contacts/example",
      "created_at": "2022-01-03T18:00:57Z",
      "updated_at": "2022-01-03T18:00:57Z",
      "links": [
        {
          "href": "https://accounting.na.sageone.com/contacts/customers/example",
          "rel": "alternative",
          "type": "text/html"
        }
      ],
      "contact_types": [
        {
          "id": "CUSTOMER",
          "displayd_as": "Customer"
        }
      ],
      "name": "exampleName",
      "reference": null,
      "default_sales_ledger_account": {
        "id": "example",
        "displayed_as": "Professional Fees"
      }
    }
  }
}

Update Ledger Account

Update the information and metadata of a Ledger account by Id | key: updateLedgerAccount

Input	Default	Notes	Example
Account Id string / Required accountId		Provide the unique identifier of the account Id.	example-2356795
Connection connection / Required connection
Display Name string / Required displayName		Provide a string value for the display name.	Example Name
Gifi Code string gifiCode		Provide a value for The General Index of Financial Information.	NA
Include In Chart boolean / Required includedInChart	false	This flag determines if the account will be included in the chart of accounts.	true
Ledger Account Type Id string / Required ledgerAccountTypeId		Provide the unique identifier of a ledger account type.	example-2356795
Name string / Required name		Provide a string value for a name.	Example Name
Nominal Code string / Required nominalCode		Provide an unique integer value for the nominal code of the ledger account.	1
Tax Rate Id string taxRateId		Provide the unique identifier of a tax rate id.	example-238953e2

Update Purchase Invoice

Update the information and metadata of a purchase invoice by Id | key: updatePurchaseInvoice

Input	Notes	Example
Connection connection / Required connection
Contact Id string contactId	Provide the unique identifier of a contact.	example-533242
Contact Name string contactName	Provide the name of a contact.	John Doe
Currency Id string currencyId	Provide the unique identifier of the currency type.	example-24525235
Date string date	Provide a valid date value.	2022-01-03
Due Date string / Required dueDate	Provide a valid date value for the due date of the invoice.	2022-01-03
Invoice Lines code / Required invoiceLines	Provide a list of javascript objects, each containing information of an an invoice line item.
Net Amount string netAmount	Provide the net amount of the invoice.	150.00
Notes string notes	Provide a string value for notes.	This is an example note.
Purchase Invoice Id string / Required purchaseInvoiceId	Provide the unique identifier of a purchase invoice id.	example-533242
Tax Amount string taxAmount	Provide a tax amount for the invoice.	150.00
Total Amount string totalAmount	Provide a total amount for the invoice.	150.00
Total Quantity string totalQuantity	Provide a total quantity of the invoice.	3

Update Sales Invoice

Update the information and metadata of a sales invoice by Id | key: updateSalesInvoice

Input	Notes	Example
Connection connection / Required connection
Contact Id string contactId	Provide the unique identifier of a contact.	example-533242
Contact Name string contactName	Provide the name of a contact.	John Doe
Currency Id string currencyId	Provide the unique identifier of the currency type.	example-24525235
Date string date	Provide a valid date value.	2022-01-03
Due Date string / Required dueDate	Provide a valid date value for the due date of the invoice.	2022-01-03
Invoice Lines code / Required invoiceLines	Provide a list of javascript objects, each containing information of an an invoice line item.
Net Amount string netAmount	Provide the net amount of the invoice.	150.00
Notes string notes	Provide a string value for notes.	This is an example note.
Sales Invoice Id string / Required salesInvoiceId	Provide the unique identifier of a sales invoice id.	example-533242
Tax Amount string taxAmount	Provide a tax amount for the invoice.	150.00
Total Amount string totalAmount	Provide a total amount for the invoice.	150.00
Total Quantity string totalQuantity	Provide a total quantity of the invoice.	3

Manage contacts and others connected to your Sage account.

Description​

Connections​

OAuth 2.0​

Actions​

Create Contact​

Create Ledger Account​

Create Purchase Invoice​

Create Sales Invoice​

Delete Contact​

Delete Contact Person​

Delete Purchase Invoice​

Delete Sales Invoice​

Get Contact​

Get Contact Person​

Get Ledger Account​

Get Purchase Invoice​

Get Sales Invoice​

List Address Types​

List Contact People​

List Contact Types​

List Contacts​

List Countries​

List Currencies​

List Ledger Account Types​

List Ledger Accounts​

List Purchase Invoices​

List Sales Invoices​

Raw Request​

Update Contact​

Update Ledger Account​

Update Purchase Invoice​

Update Sales Invoice​