Sage CRM APIs
Account Request URL
-Base Endpoint
-
Account
Retrieve an account by its ID
id
Account
Update an account
id, name, currency, address, reference, termCode, discount, creditStatus, accountClassification, sendFreeStatements, password, user
Account
Create a new account
name, currency, address, reference, termCode, discount, creditStatus, accountClassification, sendFreeStatements, password, user
Account
Delete an account by its ID
id
Accounts
Retrieve a list of accounts
order, orderBy, page, pageSize
AccountType
Retrieve an account type by its ID
id
AccountType
Create a new account type
name, description
AccountType
Delete an account type by its ID
id
AccountTypes
Retrieve a list of account types
order, orderBy, page, pageSize
Address
Retrieve an address
id
Address
Create a new address
addressLine1, addressLine2, town, county, postcode, country
Address
Update an address
id, addressLine1, addressLine2, town, county, postcode, country
Address
Delete an address
id
Addresses
Retrieve a list of addresses
order, orderBy, page, pageSize
Attachment
Retrieve an attachment
id
Attachment
Create a new attachment
fileName, fileSize, mimeType, fileData
Attachment
Update an attachment
id, fileName, fileSize, mimeType, fileData
Attachment
Delete an attachment
id
Attachments
Retrieve a list of attachments
order, orderBy, page, pageSize
Bank
Retrieve a bank
id
Bank
Create a new bank
name, branchCode, sortCode, address
Bank
Update a bank
id, name, branchCode, sortCode, address
Bank
Delete a bank
id
Banks
Retrieve a list of banks
order, orderBy, page, pageSize
BankTransaction
Retrieve a bank transaction
id
BankTransaction
Create a new bank transaction
accountId, date, amount, description, bankAccountId
BankTransaction
Update a bank transaction
id, accountId, date, amount, description, bankAccountId
BankTransaction
Delete a bank transaction
id
BankTransactions
Retrieve a list of bank transactions
order, orderBy, page, pageSize
BusinessRule
Retrieve a business rule
id
BusinessRule
Create a new business rule
name, module, active, enabled, rule, script
BusinessRule
Update a business rule
id, name, module, active, enabled, rule, script
BusinessRule
Delete a business rule
id
BusinessRules
Retrieve a list of business rules
order, orderBy, page, pageSize
Category
Retrieve a category
id
Category
Create a new category
name, description, parentCategoryId
Category
Update a category
id, name, description, parentCategoryId
Category
Delete a category
id
Categories
Retrieve a list of categories
order, orderBy, page, pageSize
Contact
Retrieve a contact
id
Contact
Create a new contact
firstName, lastName, title, workPhone, mobilePhone, email, address
Contact
Update a contact
id, firstName, lastName, title, workPhone, mobilePhone, email, address
Contact
Delete a contact
id
Contacts
Retrieve a list of contacts
order, orderBy, page, pageSize
Country
Retrieve a country
id
Country
Create a new country
name, code
Country
Update a country
id, name, code
Country
Delete a country
id
Countries
Retrieve a list of countries
order, orderBy, page, pageSize
Currency
Retrieve a currency
id
Currency
Create a new currency
name, code, decimalPlaces
Currency
Update a currency
id, name, code, decimalPlaces
Currency
Delete a currency
id
Currencies
Retrieve a list of currencies
order, orderBy, page, pageSize
CustomField
Retrieve a custom field
id
CustomField
Create a new custom field
name, type, required, visible, values, default, module, order
CustomField
Update a custom field
id, name, type, required, visible, values, default, module, order
CustomField
Delete a custom field
id
CustomFields
Retrieve a list of custom fields
order, orderBy, page, pageSize
Division
Retrieve a division
id
Division
Create a new division
name, description, parentDivisionId
Division
Update a division
id, name, description, parentDivisionId
Division
Delete a division
id
Divisions
Retrieve a list of divisions
order, orderBy, page, pageSize
Retrieve an email
id
Create a new email
subject, body, recipients, sender, attachments
Update an email
id, subject, body, recipients, sender, attachments
Delete an email
id
Emails
Retrieve a list of emails
order, orderBy, page, pageSize
Event
Retrieve an event
id
Event
Create a new event
name, description, startDate, endDate, location, privacy, attendees
Event
Update an event
id, name, description, startDate, endDate, location, privacy, attendees
Event
Delete an event
id
Events
Retrieve a list of events
order, orderBy, page, pageSize
FinanceCharge
Retrieve a finance charge
id
FinanceCharge
Create a new finance charge
accountId, date, amount, description, type
FinanceCharge
Update a finance charge
id, accountId, date, amount, description, type
FinanceCharge
Delete a finance charge
id
FinanceCharges
Retrieve a list of finance charges
order, orderBy, page, pageSize
Group
Retrieve a group
id
Group
Create a new group
name, description
Group
Update a group
id, name, description
Group
Delete a group
id
Groups
Retrieve a list of groups
order, orderBy, page, pageSize
Holiday
Retrieve a holiday
id
Holiday
Create a new holiday
name, date, description
Holiday
Update a holiday
id, name, date, description
Holiday
Delete a holiday
id
Holidays
Retrieve a list of holidays
order, orderBy, page, pageSize
Invoice
Retrieve an invoice
id
Invoice
Create a new invoice
accountId, date, description, amount, currency, taxCode
Invoice
Update an invoice
id, accountId, date, description, amount, currency, taxCode
Invoice
Delete an invoice
id
Invoices
Retrieve a list of invoices
order, orderBy, page, pageSize
Item
Retrieve an item
id
Item
Create a new item
name, description, unitPrice, taxCode, categoryId, supplierId
Item
Update an item
id, name, description, unitPrice, taxCode, categoryId, supplierId
Item
Delete an item
id
Items
Retrieve a list of items
order, orderBy, page, pageSize
Journal
Retrieve a journal
id
Journal
Create a new journal
accountId, date, description, amount, currency, taxCode
Journal
Update a journal
id, accountId, date, description, amount, currency, taxCode
Journal
Delete a journal
id
Journals
Retrieve a list of journals
order, orderBy, page, pageSize
Language
Retrieve a language
id
Language
Create a new language
name, code
Language
Update a language
id, name, code
Language
Delete a language
id
Languages
Retrieve a list of languages
order, orderBy, page, pageSize
Lead
Retrieve a lead
id
Lead
Create a new lead
firstName, lastName, title, workPhone, mobilePhone, email, address, source, status, assignedTo
Lead
Update a lead
id, firstName, lastName, title, workPhone, mobilePhone, email, address, source, status, assignedTo
Lead
Delete a lead
id
Leads
Retrieve a list of leads
order, orderBy, page, pageSize
Location
Retrieve a location
id
Location
Create a new location
name, description, address
Location
Update a location
id, name, description, address
Location
Delete a location
id
Locations
Retrieve a list of locations
order, orderBy, page, pageSize
LookupType
Retrieve a lookup type
id
LookupType
Create a new lookup type
name, description, values
LookupType
Update a lookup type
id, name, description, values
LookupType
Delete a lookup type
id
LookupTypes
Retrieve a list of lookup types
order, orderBy, page, pageSize
Module
Retrieve a module
id
Details
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Other Apps
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.
