Addresses

Address Regions

Address Types

Artefact Statuses

Attachment Context Types

Attachments

Bank Account Types

Bank Accounts

Bank Deposits

Bank Reconciliations

Bank Transfers

Businesses

Catalog Item Types

Coa Accounts

Coa Templates

Contact Allocations

Sales Invoice

Contact Payments

Contact Person Types

Contact Persons

Contact Types

Contacts

Countries

Country Groups

Currencies

EU Goods Services Types

EU Sales Descriptions

Journals

Ledger Account Classifications

Ledger Account Types

Indicates whether the ledger account is flagged for CIS Labour

Indicates whether the ledger account is flagged for CIS Materials

The control name for the ledger account. This is used internally by Accounting to identify the correct ledger account for booking taxes etc. You cannot add ledger accounts with control name and you cannot modify the control name of existing ledger accounts.


The display name formatted based on coa_list_order in settings

Indicates whether the default tax rate is fixed or may be changed per transaction

The GIFI code of the ledger account. GIFI is short for The General Index of Financial Information and it lets the CRA validate tax information electronically instead of manually. Information from financial statements is categorized under the appropriate 4-digit-long GIFI code and entered on corporate income tax returns. GIFI is needed when filing a T2 income tax return. _Canada only_


Indicates whether the ledger account is included in the chart of accounts

Indicates whether the ledger account is a control account.
Control accounts cannot be removed. See also `control_name`.


The name for the ledger account. Changes to this field do not propagate to other resources, namely not to the name of the associated bank_account (unlike the behaviour of the UI).


The partial recoverable tax rate (Canada only)

Indicates whether the ledger account is flagged for Tax Intalment (Canada only)

Indicates that transactions posted to this ledger account have part recoverable taxes (Canada only)


The datetime when the item was last updated

Indicates whether the ledger account is displayed in the banking area of the application

Indicates whether the ledger account is displayed in the purchases area of the application

Indicates whether the ledger account is displayed in the journals area of the application

Indicates whether the ledger account is displayed in the other payments area of the application


Indicates whether the ledger account is displayed in the other receipts area of the application


Indicates whether the ledger account is displayed in the reporting area of the application

Indicates whether the ledger account is displayed in the sales area of the application

The visible scopes for the ledger account. This indicates in which of the UI's areas the ledger account is displayed and available for user selection. Possible entries in this array are `bank`, `sales`, `purchasing`, `other_payment`, `other_receipt`, `reporting`, `journals`, `sales_eu`, `sales_row`, `purchasing_eu`, `purchasing_row` and `purchasing_hrc`.


Ledger Accounts

Ledger Entries

Other Payments

Payment Methods

Product Sales Price Types

Products

Purchase Credit Notes

Purchase Invoices

Purchase Quick Entries

Quick Entry Types

Sales Credit Notes

Sales Estimates

Sales Invoices

Sales Quick Entries

Sales Quotes

Service Rate Types

Services

Stock Items

Stock Movements

Tax Determinations

Tax Profiles

Tax Rates

Tax Return Frequencies

Tax Types

Transaction Types

Transactions

Unallocated Artefacts

Sage Accounting

### Endpoint Availability

* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
* Accounting Standard: 🇬🇧, 🇮🇪
* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Returns all Coa Accounts

Returns a Coa Account

Returns all Coa Templates

Returns a Coa Template

### 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: `Sales`: Full Access, Restricted Access, Read Only
* Area: `Purchases`: Full Access, Restricted Access, Read Only
* Area: `Products & Services`: Full Access, Restricted Access, Read Only
* Area: `Contacts`: Full Access, Restricted Access, Read Only
* Area: `Bank`: Full Access, Restricted Access, Read Only
* Area: `Journals`: Full Access, Restricted Access, Read Only
* Area: `Settings`: Full Access, Read Only

Returns all Ledger Accounts

### 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: `Settings`: Full Access

Creates a Ledger Account

Returns a Ledger Account

### 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: `Settings`: Full Access

Updates a Ledger Account

Returns all Ledger Account Classifications

Returns a Ledger Account Classification

Returns all Ledger Account Types

Returns a Ledger Account Type

### 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 `Journals`: Read Only, Full Access

Returns all Journals

### 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 `Journals`: Full Access

Creates a Journal

Returns a Journal

Deletes a Journal



### Access Control Restrictions

Requires the authenticated user to have any of the following roles in the area `Journals`: Full Access

Reissues an existing Journal by voiding the existing one and creating a new one

### 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: `Journals`: Full Access, Read Only
* Area: `Settings`: Full Access, Read Only

Returns all Journal Codes

### 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: `Settings`: Full Access

Creates a Journal Code

Returns a Journal Code

Updates a Journal Code

Deletes a Journal Code

Returns all Journal Code Types

Returns a Journal Code Type

Returns all Ledger Entries

Returns a Ledger Entry

### 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 `Journals`: Read Only, Full Access

Returns all Transactions

Returns a Transaction

Returns all Transaction Types

Returns a Transaction Type

### 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: `Sales`: Read Only, Restricted Access, Full Access
* Area: `Purchases`: Read Only, Restricted Access, Full Access

Returns all Attachments

### 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: `Sales`: Restricted Access, Full Access
* Area: `Purchases`: Restricted Access, Full Access

Creates a Attachment

### 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: `Sales`: Read Only, Restricted Access, Full Access
* Area: `Purchases`: Read Only, Restricted Access, Full Access

Returns a Attachment

Updates a Attachment

Deletes a Attachment

Returns an Attachment File

Returns all Attachment Context Types

### Endpoint Availability

* Accounting Plus: 🇨🇦, 🇩🇪, 🇪���, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
* Accounting Standard: 🇬🇧, 🇮🇪
* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸

Returns a Attachment Context Type

### 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 `Bank`: Full Access, Read Only, Restricted Access

Returns all Bank Accounts

### 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 `Bank`: Full Access

Creates a Bank Account

Returns a Bank Account

Updates a Bank Account

Deletes a Bank Account

Bank feed endpoint for Banking Cloud Bank accounts

Returns all Bank Account Types

Returns a Bank Account Type

### 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 `Bank`: Read Only, Restricted Access, Full Access

Returns all Bank Deposits

Creates a Bank Deposit

Returns a Bank Deposit

Deletes a Bank Deposit

Returns all Bank Reconciliations

Creates a Bank Reconciliation

Returns a Bank Reconciliation

Updates a Bank Reconciliation

Returns all Bank Transfers

### 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 `Bank`: Full Access, Restricted Access

Creates a Bank Transfer

Returns a Bank Transfer

Updates a Bank Transfer

Deletes a Bank Transfer

### 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`: Read Only, Restricted Access, Full Access
* Area: `Sales`: Read Only, Restricted Access, Full Access
* Area: `Purchases`: Read Only, Restricted Access, Full Access

Returns all Addresses

### 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

Creates a Address

### 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`: Read Only, Restricted Access, Full Access
* Area: `Sales`: Read Only, Restricted Access, Full Access
* Area: `Purchases`: Read Only, Restricted Access, Full Access
* Area: `Bank`: Read Only, Restricted Access, Full Access

Returns a Address

Updates a Address

### 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`: Full Access

Deletes a Address

Returns all Address Types

Returns a Address Type

Returns all Address Regions

Returns a Address Region

Returns all Contacts

Creates a Contact

Returns a Contact

Updates a Contact

Deletes a Contact

Returns all Contact Types

Returns a Contact Type

Returns all Contact People

Creates a Contact Person

Returns a Contact Person

Updates a Contact Person

Deletes a Contact Person

Returns all Contact Person Types

Returns a Contact Person Type

Returns all Countries

Returns a Country

Returns all Country Groups

Returns a Country Group

### 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 `Settings`: Full Access, Read Only

Returns all Business Exchange Rates

### 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 `Settings`: Full Access

Creates a Business Exchange Rate

Returns a Business Exchange Rate

Updates a Business Exchange Rate

Deletes a Business Exchange Rate

Returns all Currencies

Returns a Currency

Returns all Exchange Rates

Returns a Exchange Rate

Returns all Live Exchange Rates

Returns a Live Exchange Rate

### Endpoint Availability

* Accounting Plus: 🇪🇸
* Accounting Standard: 🇪🇸
* Accounting Start: 🇪🇸

Field Name	API Key	Type
Id	id	string
Displayed As	displayed_as	string
Path	$path	string
Address Type Id	address_type_id	string
Country Id	country_id	string

Sage Accounting API Integration Profile

How to work with Addresses in Sage Accounting API

Operations on Addresses Collection

See Related Collections

Build every single integration your customers need with AI