Sage 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.

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

Actions

Create Contact

Create a new contact | key: createContact

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

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

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

---

Create Purchase Invoice

Create a new purchase invoice | key: createPurchaseInvoice

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Contact Id string / Required	Default	Notes Provide the unique identifier of a contact.	Example example-533242
Input Date string / Required	Default	Notes Provide a valid date value.	Example 2022-01-03
Input Due Date string / Required	Default	Notes Provide a valid date value for the due date of the invoice.	Example 2022-01-03
Input Invoice Lines code / Required	Default [ { "description": "string", "ledger_account_id": "string", "unit_price": 0, "product_id": "string", "service_id": "string", "quantity": 0, }]	Notes Provide a list of javascript objects, each containing information of an an invoice line item.	Example
Input Total Amount string	Default	Notes Provide a total amount for the invoice.	Example 150.00

---

Create Sales Invoice

Create a new sales invoice | key: createSalesInvoice

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Contact Id string / Required	Default	Notes Provide the unique identifier of a contact.	Example example-533242
Input Date string / Required	Default	Notes Provide a valid date value.	Example 2022-01-03
Input Invoice Lines code / Required	Default [ { "description": "string", "ledger_account_id": "string", "unit_price": 0, "product_id": "string", "service_id": "string", "quantity": 0, }]	Notes Provide a list of javascript objects, each containing information of an an invoice line item.	Example
Input Total Amount string	Default	Notes Provide a total amount for the invoice.	Example 150.00

---

Delete Contact

Delete an existing contact by Id | key: deleteContact

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

---

Delete Contact Person

Delete an existing contact person by Id | key: deleteContactPerson

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

---

Delete Purchase Invoice

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

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

---

Delete Sales Invoice

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

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

---

Get Contact

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

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

---

Get Contact Person

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

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

---

Get Ledger Account

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

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

---

Get Purchase Invoice

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

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

---

Get Sales Invoice

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

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

---

List Address Types

List all address types | key: listAddressTypes

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

---

List Contact People

List all contact people | key: listContactPeople

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

---

List Contact Types

List all contact types | key: listContactTypes

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

---

List Contacts

List all contacts | key: listContacts

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

---

List Countries

List all countries | key: listCountries

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

---

List Currencies

List all currencies | key: listCurrencies

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

---

List Ledger Account Types

List all Ledger account types | key: listLedgerAccountTypes

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

---

List Ledger Accounts

List all Ledger accounts | key: listLedgerAccounts

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

---

List Purchase Invoices

List all purchase invoices | key: listPurchaseInvoice

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

---

List Sales Invoices

List all sales invoices | key: listSalesInvoices

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

---

Update Contact

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

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

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

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

---

Update Purchase Invoice

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

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Contact Id string	Default	Notes Provide the unique identifier of a contact.	Example example-533242
Input Contact Name string	Default	Notes Provide the name of a contact.	Example John Doe
Input Currency Id string	Default	Notes Provide the unique identifier of the currency type.	Example example-24525235
Input Date string	Default	Notes Provide a valid date value.	Example 2022-01-03
Input Due Date string / Required	Default	Notes Provide a valid date value for the due date of the invoice.	Example 2022-01-03
Input Invoice Lines code / Required	Default [ { "description": "string", "ledger_account_id": "string", "unit_price": 0, "product_id": "string", "service_id": "string", "quantity": 0, }]	Notes Provide a list of javascript objects, each containing information of an an invoice line item.	Example
Input Net Amount string	Default	Notes Provide the net amount of the invoice.	Example 150.00
Input Notes string	Default	Notes Provide a string value for notes.	Example This is an example note.
Input Purchase Invoice Id string / Required	Default	Notes Provide the unique identifier of a purchase invoice id.	Example example-533242
Input Tax Amount string	Default	Notes Provide a tax amount for the invoice.	Example 150.00
Input Total Amount string	Default	Notes Provide a total amount for the invoice.	Example 150.00
Input Total Quantity string	Default	Notes Provide a total quantity of the invoice.	Example 3

---

Update Sales Invoice

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

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Contact Id string	Default	Notes Provide the unique identifier of a contact.	Example example-533242
Input Contact Name string	Default	Notes Provide the name of a contact.	Example John Doe
Input Currency Id string	Default	Notes Provide the unique identifier of the currency type.	Example example-24525235
Input Date string	Default	Notes Provide a valid date value.	Example 2022-01-03
Input Due Date string / Required	Default	Notes Provide a valid date value for the due date of the invoice.	Example 2022-01-03
Input Invoice Lines code / Required	Default [ { "description": "string", "ledger_account_id": "string", "unit_price": 0, "product_id": "string", "service_id": "string", "quantity": 0, }]	Notes Provide a list of javascript objects, each containing information of an an invoice line item.	Example
Input Net Amount string	Default	Notes Provide the net amount of the invoice.	Example 150.00
Input Notes string	Default	Notes Provide a string value for notes.	Example This is an example note.
Input Sales Invoice Id string / Required	Default	Notes Provide the unique identifier of a sales invoice id.	Example example-533242
Input Tax Amount string	Default	Notes Provide a tax amount for the invoice.	Example 150.00
Input Total Amount string	Default	Notes Provide a total amount for the invoice.	Example 150.00
Input Total Quantity string	Default	Notes Provide a total quantity of the invoice.	Example 3

---