Sage Accounting
App · 20 actions
Manage accounting contacts and read invoices, products, services, bank accounts, ledger accounts and tax rates.
Actions
| Action | What it does |
|---|---|
| Create contact | Create contact in Sage Accounting. |
| Delete contact | Delete contact in Sage Accounting. |
| Get business | Get business in Sage Accounting. |
| Get contact | Get contact in Sage Accounting. |
| Get current user | Get current user in Sage Accounting. |
| Get product | Get product in Sage Accounting. |
| Get purchase invoice | Get purchase invoice in Sage Accounting. |
| Get sales invoice | Get sales invoice in Sage Accounting. |
| Get service | Get service in Sage Accounting. |
| List bank accounts | List bank accounts in Sage Accounting. |
| List businesses | List businesses in Sage Accounting. |
| List contact types | List contact types in Sage Accounting. |
| List contacts | List contacts in Sage Accounting. |
| List ledger accounts | List ledger accounts in Sage Accounting. |
| List products | List products in Sage Accounting. |
| List purchase invoices | List purchase invoices in Sage Accounting. |
| List sales invoices | List sales invoices in Sage Accounting. |
| List services | List services in Sage Accounting. |
| List tax rates | List tax rates in Sage Accounting. |
| Update contact | Update contact in Sage Accounting. |
Create contact
Create contact in Sage Accounting.
Inputs
- Name
nametextRequired - The contact's full name or business name
- Contact type IDs
contact_type_idslistRequired - The IDs of the Contact Types.
- Reference
referencetext - Unique reference for the contact
- Tax number
tax_numbertext - The VAT registration number of the contact. The format will be validated.
- Notes
notestext - The notes for the contact
- Credit limit
credit_limitnumber - Custom credit limit amount for the contact not applicable to Start
- Credit days
credit_daysnumber - Custom credit days for the contact. If returned as null in a GET response, you may want to GET /invoice_settings and use 'customer_credit_days'/'vendor_credit_days' as default/fallback according to your use case.From 0 to 365.
- Credit terms
credit_termstext - Credit terms options determine how invoice due dates are calculated. Options include: end of next month, a delay of supplier credit_days and immediately. Only: month_end_invoice, date_from_invoice, immediate_invoice, month_end_payment, date_from_payment, immediate_payment are valid values. If returned as null in a GET response, you may want to GET /invoice_settings and use 'customer_credit_terms'/'vendor_credit_terms' as default.One of:
month_end_invoice(Month end invoice),date_from_invoice(Date from invoice),immediate_invoice(Immediate invoice),month_end_payment(Month end payment),date_from_payment(Date from payment),immediate_payment(Immediate payment). - Main address
main_addressobject - Main address.
- Main contact person
main_contact_personobject - Main contact person.
Outputs
dataobject- ### Endpoint Availability * Accounting Plus: 🇨🇦, 🇬🇧, 🇮🇪 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: `Contacts`: Restricted Access, Full Access
Example output
{
"data": {
"$path": "example",
"aux_reference": "example",
"auxiliary_account": "example",
"balance": 1.0,
"bank_account_details": {
"account_name": "example",
"account_number": "example",
"bic": "example",
"iban": "example",
"sort_code": "example"
},
"cis_registered": false,
"cis_settings": {
"deduction_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"registered_cis_name": "example",
"subcontractor_verification_number": "example"
},
"contact_types": [],
"created_at": "example",
"credit_days": 1,
"credit_limit": 1.0,
"credit_terms": "month_end_invoice",
"credit_terms_and_conditions": "example",
"currency": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"default_purchase_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"deletable": false,
"deleted_at": "example",
"delivery_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"destination_vat_blocking": false,
"displayed_as": "example",
"email": "example",
"gb_based": false,
"gdpr_obfuscated": false,
"has_unfinished_recurring_invoices": false,
"id": "example",
"is_active": false,
"links": [],
"locale": "example",
"main_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"main_contact_person": {
"$path": "example",
"address": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"contact_person_types": [],
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"email": "example",
"fax": "example",
"id": "example",
"is_main_contact": false,
"is_preferred_contact": false,
"job_title": "example",
"mobile": "example",
"name": "example",
"telephone": "example",
"updated_at": "example"
},
"name": "example",
"ni_based": false,
"notes": "example",
"product_sales_price_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"reference": "example",
"registered_number": "example",
"source_guid": "example",
"system": false,
"tax_calculation": "example",
"tax_number": "example",
"tax_treatment": {
"eu_not_tax_registered": false,
"eu_tax_registered": false,
"home_tax": false,
"is_importer": false,
"rest_of_world_tax": false
},
"updated_at": "example"
}
}Delete contact
Delete contact in Sage Accounting.
Inputs
- Contact
contact_idtextRequired - The Contact Key.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}Get business
Get business in Sage Accounting.
Inputs
- Business
business_idtextRequired - The ID of the business. Use `lead` to get your lead business.
Outputs
dataobject- Returns all Businesses
Example output
{
"data": {
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"country": {
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"displayed_as": "example",
"id": "example",
"is_demo": false,
"mobile": "example",
"name": "example",
"ni_based": false,
"postal_code": "example",
"region": "example",
"subscriptions": [],
"telephone": "example",
"updated_at": "example",
"website": "example"
}
}Get contact
Get contact in Sage Accounting.
Inputs
- Contact
contact_idtextRequired - The Contact Key.
- Attributes
attributestext - Specify the attributes that you want to expose for the Contact (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}Get current user
Get current user in Sage Accounting.
Inputs
None.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}Get product
Get product in Sage Accounting.
Inputs
- Product
product_idtextRequired - The Product Key.
- Attributes
attributestext - Specify the attributes that you want to expose for the Product (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}Get purchase invoice
Get purchase invoice in Sage Accounting.
Inputs
- Purchase invoice
purchase_invoice_idtextRequired - The Purchase Invoice Key.
- Attributes
attributestext - Specify the attributes that you want to expose for the Purchase Invoice (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}Get sales invoice
Get sales invoice in Sage Accounting.
Inputs
- Sales invoice
sales_invoice_idtextRequired - The Sales Invoice Key.
- Attributes
attributestext - Specify the attributes that you want to expose for the Sales Invoice (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- ### Endpoint Availability * Accounting Plus: 🇨🇦, 🇬🇧, 🇮🇪 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any of the following roles in the area `Sales`: Full Access, Restricted Access
Example output
{
"data": {
"$path": "example",
"base_currency_cis_applicable_amount": 1.0,
"base_currency_net_amount": 1.0,
"base_currency_outstanding_amount": 1.0,
"base_currency_shipping_net_amount": 1.0,
"base_currency_shipping_tax_amount": 1.0,
"base_currency_shipping_tax_breakdown": [],
"base_currency_shipping_total_amount": 1.0,
"base_currency_tax_amount": 1.0,
"base_currency_total_after_cis_deduction": 1.0,
"base_currency_total_amount": 1.0,
"base_currency_total_discount_amount": 1.0,
"base_currency_withholding_tax_amount": 1.0,
"cis_applicable_amount": 1.0,
"contact": {
"$path": "example",
"aux_reference": "example",
"auxiliary_account": "example",
"balance": 1.0,
"bank_account_details": {
"account_name": "example",
"account_number": "example",
"bic": "example",
"iban": "example",
"sort_code": "example"
},
"cis_registered": false,
"cis_settings": {
"deduction_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"registered_cis_name": "example",
"subcontractor_verification_number": "example"
},
"contact_types": [],
"created_at": "example",
"credit_days": 1,
"credit_limit": 1.0,
"credit_terms": "month_end_invoice",
"credit_terms_and_conditions": "example",
"currency": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"default_purchase_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"deletable": false,
"deleted_at": "example",
"delivery_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"destination_vat_blocking": false,
"displayed_as": "example",
"email": "example",
"gb_based": false,
"gdpr_obfuscated": false,
"has_unfinished_recurring_invoices": false,
"id": "example",
"is_active": false,
"links": [],
"locale": "example",
"main_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"main_contact_person": {
"$path": "example",
"address": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"contact_person_types": [],
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"email": "example",
"fax": "example",
"id": "example",
"is_main_contact": false,
"is_preferred_contact": false,
"job_title": "example",
"mobile": "example",
"name": "example",
"telephone": "example",
"updated_at": "example"
},
"name": "example",
"ni_based": false,
"notes": "example",
"product_sales_price_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"reference": "example",
"registered_number": "example",
"source_guid": "example",
"system": false,
"tax_calculation": "example",
"tax_number": "example",
"tax_treatment": {
"eu_not_tax_registered": false,
"eu_tax_registered": false,
"home_tax": false,
"is_importer": false,
"rest_of_world_tax": false
},
"updated_at": "example"
},
"contact_name": "example",
"contact_reference": "example",
"corrections": [],
"created_at": "example",
"currency": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"date": "example",
"deleted_at": "example",
"delivery_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"postal_code": "example",
"region": "example"
},
"delivery_address_free_form": "example",
"delivery_performance_date": "example",
"destination_consignment": false,
"destination_vat_rates_in_use": false,
"detailed_tax_analysis": {
"base_currency_total": 1.0,
"base_currency_total_goods_amount": 1.0,
"base_currency_total_net": 1.0,
"base_currency_total_services_amount": 1.0,
"base_currency_total_tax": 1.0,
"tax_rates_breakdown": {
"base_currency_goods_amount": 1.0,
"base_currency_net_amount": 1.0,
"base_currency_services_amount": 1.0,
"base_currency_tax_amount": 1.0,
"base_currency_total_amount": 1.0,
"goods_amount": 1.0,
"name": "example",
"net_amount": 1.0,
"percentage": 1.0,
"retail_tax_amount": 1.0,
"services_amount": 1.0,
"tax_amount": 1.0,
"tax_rate": {
"$path": "example",
"agency": "example",
"component_tax_rates": [],
"created_at": "example",
"deletable": false,
"displayed_as": "example",
"editable": false,
"id": "example",
"is_combined_rate": false,
"is_visible": false,
"name": "example",
"percentage": 1.0,
"percentages": [],
"retailer": false,
"updated_at": "example"
},
"total_amount": 1.0
},
"total": 1.0,
"total_goods_amount": 1.0,
"total_net": 1.0,
"total_retailer_tax": 1.0,
"total_services_amount": 1.0,
"total_tax": 1.0
},
"displayed_as": "example",
"due_date": "example",
"editable": false,
"exchange_rate": 1.0,
"has_cis_labour": false,
"has_cis_materials": false,
"id": "example",
"inverse_exchange_rate": 1.0,
"invoice_lines": [],
"invoice_number": "example",
"invoice_number_prefix": "example",
"is_cis": false,
"last_paid": "example",
"links": [],
"main_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"postal_code": "example",
"region": "example"
},
"main_address_free_form": "example",
"migrated": false,
"net_amount": 1.0,
"notes": "example",
"original_quote_estimate": {
"$path": "example",
"displayed_as": "example",
"id": "example",
"links": []
},
"outstanding_amount": 1.0,
"payments_allocations": [],
"payments_allocations_total_amount": 1.0,
"payments_allocations_total_discount": 1.0,
"recurring_invoice": {
"displayed_as": "example",
"frequency": 1,
"id": "example",
"links": [],
"on_day_number": 1,
"on_week_day": 1,
"recurrence_status_identifier": "example",
"recurrence_type": "example"
},
"reference": "example",
"sent": false,
"sent_by_email": false,
"shipping_net_amount": 1.0,
"shipping_tax_amount": 1.0,
"shipping_tax_breakdown": [],
"shipping_tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"shipping_total_amount": 1.0,
"status": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_address_region": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_amount": 1.0,
"tax_analysis": [],
"tax_calculation_method": "example",
"tax_reconciled": false,
"terms_and_conditions": "example",
"total_after_cis_deduction": 1.0,
"total_amount": 1.0,
"total_discount_amount": 1.0,
"total_paid": 1.0,
"total_quantity": 1.0,
"transaction": {
"$path": "example",
"audit_trail_id": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"date": "example",
"deleted": false,
"displayed_as": "example",
"id": "example",
"number_of_attachments": "example",
"origin": {
"$path": "example",
"currency": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"displayed_as": "example",
"due_date": "example",
"id": "example",
"links": [],
"outstanding_amount": 1.0,
"sent": false,
"status": {
"$path": "example",
"displayed_as": "example",
"id": "example"
}
},
"reference": "example",
"total": 1.0,
"total_in_transaction_currency": 1.0,
"transaction_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"updated_at": "example"
},
"transaction_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"updated_at": "example",
"vat_reverse_charge": false,
"void_reason": "example",
"withholding_tax_amount": 1.0,
"withholding_tax_rate": 1.0
}
}Get service
Get service in Sage Accounting.
Inputs
- Service
service_idtextRequired - The Service Key.
- Attributes
attributestext - Specify the attributes that you want to expose for the Service (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
Example output
{
"data": {}
}List bank accounts
List bank accounts in Sage Accounting.
Inputs
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Bank Accounts 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.
- Items per page
items_per_pagenumber - Returns the given number of Bank Accounts per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Bank AccountsDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Bank Accounts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List businesses
List businesses in Sage Accounting.
Inputs
- Items per page
items_per_pagenumber - Returns the given number of businesses per request.From 25 to 500. Default:
25. - Page
pagenumber - Go to specific page of businesses. The first page is 1.Default:
1.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List contact types
List contact types in Sage Accounting.
Inputs
- Items per page
items_per_pagenumber - Returns the given number of Contact Types per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Contact TypesDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Contact Types (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List contacts
List contacts in Sage Accounting.
Inputs
- Updated or created since
updated_or_created_sincedate and time - 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.
- Contact type
contact_type_idtext - Use this to filter by contact type id
- Search
searchtext - Use this to filter by the contact name, company name or reference.
- Items per page
items_per_pagenumber - Returns the given number of Contacts per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of ContactsDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Contacts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List ledger accounts
List ledger accounts in Sage Accounting.
Inputs
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Ledger Accounts 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.
- From date
from_datedate and time - Calculate balances from this date.
- To date
to_datedate and time - Calculate balances to this date.
- Search
searchtext - Use this to filter by the item code or description
- Items per page
items_per_pagenumber - Returns the given number of Ledger Accounts per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Ledger AccountsDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Ledger Accounts (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List products
List products in Sage Accounting.
Inputs
- Search
searchtext - Use this to filter by the item code or description.
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Products 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.
- Items per page
items_per_pagenumber - Returns the given number of Products per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of ProductsDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Products (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List purchase invoices
List purchase invoices in Sage Accounting.
Inputs
- Search
searchtext - Use this to filter by the invoice reference or contact name.
- Contact
contact_idtext - Use this to filter by contact id
- From date
from_datedate and time - Use this to filter by Purchase Invoices dates
- To date
to_datedate and time - Use this to filter by Purchase Invoices dates
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Purchase Invoices 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.
- Items per page
items_per_pagenumber - Returns the given number of Purchase Invoices per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Purchase InvoicesDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Purchase Invoices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List sales invoices
List sales invoices in Sage Accounting.
Inputs
- Search
searchtext - Use this to filter by the invoice reference or contact name.
- Contact
contact_idtext - Use this to filter by contact id
- From date
from_datedate and time - Use this to filter by Sales Invoices dates
- To date
to_datedate and time - Use this to filter by Sales Invoices dates
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Sales Invoices 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.
- Items per page
items_per_pagenumber - Returns the given number of Sales Invoices per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Sales InvoicesDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Sales Invoices (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List services
List services in Sage Accounting.
Inputs
- Search
searchtext - Use this to filter by the item code or description.
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Services 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.
- Items per page
items_per_pagenumber - Returns the given number of Services per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of ServicesDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Services (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}List tax rates
List tax rates in Sage Accounting.
Inputs
- Updated or created since
updated_or_created_sincedate and time - Use this to limit the response to Tax Rates 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.
- Items per page
items_per_pagenumber - Returns the given number of Tax Rates per request.From 1 to 200. Default:
20. - Page
pagenumber - Go to specific page of Tax RatesDefault:
1. - Attributes
attributestext - Specify the attributes that you want to expose for the Tax Rates (expose all attributes with 'all'). These are in addition to the base attributes (name, path)Default:
all.
Outputs
dataobject- Sage Accounting response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"$items": [],
"$next": "example",
"$page": 1,
"$total": 1
},
"has_more": false,
"next_cursor": null,
"records": []
}Update contact
Update contact in Sage Accounting.
Inputs
- Contact
contact_idtextRequired - The Contact Key.
- Name
nametext - The contact's full name or business name
- Contact type IDs
contact_type_idslist - The IDs of the Contact Types.
- Reference
referencetext - Unique reference for the contact
- Tax number
tax_numbertext - The VAT registration number of the contact. The format will be validated.
- Notes
notestext - The notes for the contact
- Credit limit
credit_limitnumber - Custom credit limit amount for the contact not applicable to Start
- Credit days
credit_daysnumber - Custom credit days for the contact. If returned as null in a GET response, you may want to GET /invoice_settings and use 'customer_credit_days'/'vendor_credit_days' as default/fallback according to your use case.From 0 to 365.
- Credit terms
credit_termstext - Credit terms options determine how invoice due dates are calculated. Options include: end of next month, a delay of supplier credit_days and immediately. Only: month_end_invoice, date_from_invoice, immediate_invoice, month_end_payment, date_from_payment, immediate_payment are valid values. If returned as null in a GET response, you may want to GET /invoice_settings and use 'customer_credit_terms'/'vendor_credit_terms' as default.One of:
month_end_invoice(Month end invoice),date_from_invoice(Date from invoice),immediate_invoice(Immediate invoice),month_end_payment(Month end payment),date_from_payment(Date from payment),immediate_payment(Immediate payment). - Main address
main_addressobject - Main address.
- Main contact person
main_contact_personobject - Main contact person.
Outputs
dataobject- ### Endpoint Availability * Accounting Plus: 🇨🇦, 🇬🇧, 🇮🇪 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇬🇧, 🇮🇪 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: `Contacts`: Restricted Access, Full Access
Example output
{
"data": {
"$path": "example",
"aux_reference": "example",
"auxiliary_account": "example",
"balance": 1.0,
"bank_account_details": {
"account_name": "example",
"account_number": "example",
"bic": "example",
"iban": "example",
"sort_code": "example"
},
"cis_registered": false,
"cis_settings": {
"deduction_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"registered_cis_name": "example",
"subcontractor_verification_number": "example"
},
"contact_types": [],
"created_at": "example",
"credit_days": 1,
"credit_limit": 1.0,
"credit_terms": "month_end_invoice",
"credit_terms_and_conditions": "example",
"currency": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"default_purchase_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_ledger_account": {
"$path": "example",
"balance_details": {
"balance": 1.0,
"credit_or_debit": "example",
"credits": 1.0,
"debits": 1.0,
"from_date": "example",
"to_date": "example"
},
"cis_labour": false,
"cis_materials": false,
"control_name": "example",
"created_at": "example",
"display_formatted": "example",
"display_name": "example",
"displayed_as": "example",
"fixed_tax_rate": false,
"gifi_code": 1,
"id": "example",
"included_in_chart": false,
"is_control_account": false,
"ledger_account_classification": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"ledger_account_group": {
"displayed_as": "example",
"id": "example"
},
"ledger_account_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"name": "example",
"nominal_code": 1,
"non_recoverable_ledger_account": {},
"recoverable_percentage": 1.0,
"tax_instalment": false,
"tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"tax_recoverable": false,
"updated_at": "example",
"visible_in_banking": false,
"visible_in_expenses": false,
"visible_in_journals": false,
"visible_in_other_payments": false,
"visible_in_other_receipts": false,
"visible_in_reporting": false,
"visible_in_sales": false,
"visible_scopes": []
},
"default_sales_tax_rate": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"deletable": false,
"deleted_at": "example",
"delivery_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"destination_vat_blocking": false,
"displayed_as": "example",
"email": "example",
"gb_based": false,
"gdpr_obfuscated": false,
"has_unfinished_recurring_invoices": false,
"id": "example",
"is_active": false,
"links": [],
"locale": "example",
"main_address": {
"$path": "example",
"address_line_1": "example",
"address_line_2": "example",
"address_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"bank_account": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"city": "example",
"contact": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"country_group": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"id": "example",
"is_main_address": false,
"name": "example",
"postal_code": "example",
"region": "example",
"updated_at": "example"
},
"main_contact_person": {
"$path": "example",
"address": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"contact_person_types": [],
"created_at": "example",
"deleted_at": "example",
"displayed_as": "example",
"email": "example",
"fax": "example",
"id": "example",
"is_main_contact": false,
"is_preferred_contact": false,
"job_title": "example",
"mobile": "example",
"name": "example",
"telephone": "example",
"updated_at": "example"
},
"name": "example",
"ni_based": false,
"notes": "example",
"product_sales_price_type": {
"$path": "example",
"displayed_as": "example",
"id": "example"
},
"reference": "example",
"registered_number": "example",
"source_guid": "example",
"system": false,
"tax_calculation": "example",
"tax_number": "example",
"tax_treatment": {
"eu_not_tax_registered": false,
"eu_tax_registered": false,
"home_tax": false,
"is_importer": false,
"rest_of_world_tax": false
},
"updated_at": "example"
}
}