Sage Accounting Component
Manage contacts and others connected to your Sage account.
Component key: sageDescription
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
orreadonly
. Sage Authentication Documentation
Actions
Create Contact
Create a new contact | key: createContact
Output Example Payload
{
"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
Create Purchase Invoice
Create a new purchase invoice | key: createPurchaseInvoice
Create Sales Invoice
Create a new sales invoice | key: createSalesInvoice
Delete Contact
Delete an existing contact by Id | key: deleteContact
Delete Contact Person
Delete an existing contact person by Id | key: deleteContactPerson
Delete Purchase Invoice
Delete the information and metadata of a purchase invoice by Id | key: deletePurchaseInvoice
Delete Sales Invoice
Delete the information and metadata of a sales invoice by Id | key: deleteSalesInvoice
Get Contact
Get the information and metadata of a contact by Id | key: getContact
Get Contact Person
Get the information and metadata of a contact person by Id | key: getContactPerson
Get Ledger Account
Get the information and metadata of a Ledger account | key: getLedgerAccount
Get Purchase Invoice
Get the information and metadata of a purchase invoice by Id | key: getPurchaseInvoice
Get Sales Invoice
Get the information and metadata of a sales invoice by Id | key: getSalesInvoice
List Address Types
List all address types | key: listAddressTypes
List Contact People
List all contact people | key: listContactPeople
List Contact Types
List all contact types | key: listContactTypes
List Contacts
List all contacts | key: listContacts
List Countries
List all countries | key: listCountries
List Currencies
List all currencies | key: listCurrencies
List Ledger Account Types
List all Ledger account types | key: listLedgerAccountTypes
List Ledger Accounts
List all Ledger accounts | key: listLedgerAccounts
List Purchase Invoices
List all purchase invoices | key: listPurchaseInvoice
List Sales Invoices
List all sales invoices | key: listSalesInvoices
Raw Request
Send Raw Request to Sage | key: rawRequest
Update Contact
Update the information and metadata of an existing contact by Id | key: updateContact
Output Example Payload
{
"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
Update Purchase Invoice
Update the information and metadata of a purchase invoice by Id | key: updatePurchaseInvoice
Update Sales Invoice
Update the information and metadata of a sales invoice by Id | key: updateSalesInvoice