Sage One - Accounts - v3 DE
Documentation of the Sage Business Cloud Accounting API.
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: Read Only, Restricted Access, Full Access
Request URL
Request parameters
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to limit the response to Bank Transfers 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.
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to limit the response to Bank Transfers deleted since a given date (format: YYYY-MM-DDT(+|-)hh:mm) or date-time (format: YYYY-MM-DDThh:mm:ss(+|-)hh:mm). Not inclusive of the passed timestamp.
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to filter by Bank Transfers dates
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to filter by Bank Transfers dates
(optional)
boolean
Display the legacy_id for the Bank Transfers.
(optional)
integer
Format - int32. Returns the given number of Bank Transfers per request.
(optional)
integer
Format - int32. Go to specific page of Bank Transfers
(optional)
string
Specify the attributes that you want to expose for the Bank Transfers (expose all attributes with 'all'). These are in addition to the base attributes (name, path)
(optional)
string
Order by a given attribute (required) and direction (optional; asc or desc; defaults to asc).
Available attributes are:
created_at, updated_at, date
Example: sort=created_at or sort=created_at:desc
Request headers
Request body
Response 200
Returns all Bank Transfers
[
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"transaction": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"transaction_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"deleted_at": "string",
"from_bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"deleted_at": "string",
"bank_account_details": {
"account_name": "string",
"account_number": "string",
"sort_code": "string",
"bic": "string",
"iban": "string"
},
"ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_account_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"balance": 0.0,
"main_address": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"deleted_at": "string",
"created_at": "string",
"updated_at": "string",
"bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"address_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"name": "string",
"region": "string",
"country_group": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"is_main_address": true
},
"main_contact_person": {
"name": "string",
"job_title": "string",
"telephone": "string",
"mobile": "string",
"email": "string",
"fax": "string"
},
"nominal_code": 0,
"editable": true,
"deletable": true,
"journal_code": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"code": "string",
"journal_code_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"control_name": "string",
"reserved": true
},
"default_payment_method": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"gifi_code": 0,
"is_active": true
},
"to_bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"deleted_at": "string",
"bank_account_details": {
"account_name": "string",
"account_number": "string",
"sort_code": "string",
"bic": "string",
"iban": "string"
},
"ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_account_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"balance": 0.0,
"main_address": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"deleted_at": "string",
"created_at": "string",
"updated_at": "string",
"bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"address_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"name": "string",
"region": "string",
"country_group": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"is_main_address": true
},
"main_contact_person": {
"name": "string",
"job_title": "string",
"telephone": "string",
"mobile": "string",
"email": "string",
"fax": "string"
},
"nominal_code": 0,
"editable": true,
"deletable": true,
"journal_code": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"code": "string",
"journal_code_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"control_name": "string",
"reserved": true
},
"default_payment_method": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"gifi_code": 0,
"is_active": true
},
"date": "string",
"reference": "string",
"amount": 0.0,
"description": "string"
}
]{
"type": "array",
"items": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"transaction": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The transaction for the item",
"x-sage-menusection": "Settings"
},
"transaction_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The transaction type of the item",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"from_bank_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"bank_account_details": {
"type": "object",
"properties": {
"account_name": {
"type": "string",
"description": "The account name"
},
"account_number": {
"type": "string",
"description": "The account number"
},
"sort_code": {
"type": "string",
"description": "The sort code"
},
"bic": {
"type": "string",
"description": "The bic"
},
"iban": {
"type": "string",
"description": "The iban"
}
},
"description": "The account details for the bank account"
},
"ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The ledger account for the bank account",
"x-sage-menusection": "Settings"
},
"bank_account_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The bank account type for the bank account",
"x-sage-menusection": "Settings"
},
"balance": {
"type": "number",
"format": "double",
"description": "The bank account balance"
},
"main_address": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"address_line_1": {
"type": "string",
"maxLength": 50,
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"maxLength": 50,
"description": "The second line of the address"
},
"city": {
"type": "string",
"maxLength": 50,
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"maxLength": 10,
"description": "The address postal code/zipcode"
},
"country": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The address country",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"bank_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The related bank account of the address, if the address belongs to a bank account.",
"x-sage-menusection": "Settings"
},
"contact": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The related contact of the address, if the address belongs to a contact.",
"x-sage-menusection": "Settings"
},
"address_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Defines the nature of the address (Shipping, Billing, Head Office etc.).<br>Start defaults to \"Sales\" for Customers and \"Purchasing\" for Vendors",
"x-sage-menusection": "Settings"
},
"name": {
"type": "string",
"maxLength": 50,
"description": "The custom name of the address"
},
"region": {
"type": "string",
"maxLength": 50,
"description": "The address state/province/region"
},
"country_group": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Country group allows countries to be filtered for selection.<br>Set it to e.g. EU if the address is within the EEC.",
"x-sage-menusection": "Settings"
},
"is_main_address": {
"type": "boolean",
"description": "Specifies the address as the contact's main address. Only a single address can exist for a contact in Start so this is always true when returned by the API but cannot be seen in the UI"
}
},
"description": "The main address for the bank account",
"x-sage-menusection": "Contacts, Addresses & Countries"
},
"main_contact_person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the contact"
},
"job_title": {
"type": "string",
"description": "The job title of the contact"
},
"telephone": {
"type": "string",
"description": "The telephone of the contact"
},
"mobile": {
"type": "string",
"description": "The mobile of the contact"
},
"email": {
"type": "string",
"description": "The email of the contact"
},
"fax": {
"type": "string",
"description": "The fax number of the contact"
}
},
"description": "The main contact for the bank account"
},
"nominal_code": {
"type": "integer",
"format": "int32",
"description": "The nominal code of the bank account"
},
"editable": {
"type": "boolean",
"description": "Indicates whether or not the bank account can be edited"
},
"deletable": {
"type": "boolean",
"description": "Indicates whether or not the bank account can be deleted"
},
"journal_code": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the journal code"
},
"code": {
"type": "string",
"maxLength": 255,
"description": "The code of the journal code"
},
"journal_code_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"maxLength": 20,
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The journal code type of the journal code",
"x-sage-menusection": "Financial Accounts & Entries"
},
"control_name": {
"type": "string",
"maxLength": 255,
"description": "The control name of the journal code\n\nControl names are identifiers for a journal codes with a specific meaning. Some examples are `AC` for\npurchases, `VE` for sales, `OD` for other transactions and `REPBAL` for opening balances.\n"
},
"reserved": {
"type": "boolean",
"description": "Indicates whether the journal code is reserved.\n\nReserved journal codes cannot be deleted. A journal code is reserved when it has a control name.\nPlease note that journal codes can also not be deleted when there is any journal that is using\nthe code.\n"
}
},
"description": "The journal code of the bank account (France only)",
"x-sage-menusection": "Settings"
},
"default_payment_method": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default payment method of the bank account",
"x-sage-menusection": "Settings"
},
"gifi_code": {
"type": "integer",
"format": "int32",
"description": "The GIFI code of the bank ledger account'\n\nGIFI is short for The General Index of Financial Information and it lets the CRA validate tax information electronically instead of manually.\nInformation from financial statements is categorized under the appropriate 4-digit-long GIFI code and entered on corporate income tax returns.\nGIFI is needed when filing a T2 income tax return.\n\n_Canada only_\n"
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the Bank account is active or inactive."
}
},
"description": "The bank account that the money was transfered from",
"x-sage-menusection": "Bank, Payments & Receipts"
},
"to_bank_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"bank_account_details": {
"type": "object",
"properties": {
"account_name": {
"type": "string",
"description": "The account name"
},
"account_number": {
"type": "string",
"description": "The account number"
},
"sort_code": {
"type": "string",
"description": "The sort code"
},
"bic": {
"type": "string",
"description": "The bic"
},
"iban": {
"type": "string",
"description": "The iban"
}
},
"description": "The account details for the bank account"
},
"ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The ledger account for the bank account",
"x-sage-menusection": "Settings"
},
"bank_account_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The bank account type for the bank account",
"x-sage-menusection": "Settings"
},
"balance": {
"type": "number",
"format": "double",
"description": "The bank account balance"
},
"main_address": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"address_line_1": {
"type": "string",
"maxLength": 50,
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"maxLength": 50,
"description": "The second line of the address"
},
"city": {
"type": "string",
"maxLength": 50,
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"maxLength": 10,
"description": "The address postal code/zipcode"
},
"country": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The address country",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"bank_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The related bank account of the address, if the address belongs to a bank account.",
"x-sage-menusection": "Settings"
},
"contact": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The related contact of the address, if the address belongs to a contact.",
"x-sage-menusection": "Settings"
},
"address_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Defines the nature of the address (Shipping, Billing, Head Office etc.).<br>Start defaults to \"Sales\" for Customers and \"Purchasing\" for Vendors",
"x-sage-menusection": "Settings"
},
"name": {
"type": "string",
"maxLength": 50,
"description": "The custom name of the address"
},
"region": {
"type": "string",
"maxLength": 50,
"description": "The address state/province/region"
},
"country_group": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "Country group allows countries to be filtered for selection.<br>Set it to e.g. EU if the address is within the EEC.",
"x-sage-menusection": "Settings"
},
"is_main_address": {
"type": "boolean",
"description": "Specifies the address as the contact's main address. Only a single address can exist for a contact in Start so this is always true when returned by the API but cannot be seen in the UI"
}
},
"description": "The main address for the bank account",
"x-sage-menusection": "Contacts, Addresses & Countries"
},
"main_contact_person": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the contact"
},
"job_title": {
"type": "string",
"description": "The job title of the contact"
},
"telephone": {
"type": "string",
"description": "The telephone of the contact"
},
"mobile": {
"type": "string",
"description": "The mobile of the contact"
},
"email": {
"type": "string",
"description": "The email of the contact"
},
"fax": {
"type": "string",
"description": "The fax number of the contact"
}
},
"description": "The main contact for the bank account"
},
"nominal_code": {
"type": "integer",
"format": "int32",
"description": "The nominal code of the bank account"
},
"editable": {
"type": "boolean",
"description": "Indicates whether or not the bank account can be edited"
},
"deletable": {
"type": "boolean",
"description": "Indicates whether or not the bank account can be deleted"
},
"journal_code": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the journal code"
},
"code": {
"type": "string",
"maxLength": 255,
"description": "The code of the journal code"
},
"journal_code_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"maxLength": 20,
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The journal code type of the journal code",
"x-sage-menusection": "Financial Accounts & Entries"
},
"control_name": {
"type": "string",
"maxLength": 255,
"description": "The control name of the journal code\n\nControl names are identifiers for a journal codes with a specific meaning. Some examples are `AC` for\npurchases, `VE` for sales, `OD` for other transactions and `REPBAL` for opening balances.\n"
},
"reserved": {
"type": "boolean",
"description": "Indicates whether the journal code is reserved.\n\nReserved journal codes cannot be deleted. A journal code is reserved when it has a control name.\nPlease note that journal codes can also not be deleted when there is any journal that is using\nthe code.\n"
}
},
"description": "The journal code of the bank account (France only)",
"x-sage-menusection": "Settings"
},
"default_payment_method": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The default payment method of the bank account",
"x-sage-menusection": "Settings"
},
"gifi_code": {
"type": "integer",
"format": "int32",
"description": "The GIFI code of the bank ledger account'\n\nGIFI is short for The General Index of Financial Information and it lets the CRA validate tax information electronically instead of manually.\nInformation from financial statements is categorized under the appropriate 4-digit-long GIFI code and entered on corporate income tax returns.\nGIFI is needed when filing a T2 income tax return.\n\n_Canada only_\n"
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the Bank account is active or inactive."
}
},
"description": "The bank account that the money was transfered to",
"x-sage-menusection": "Bank, Payments & Receipts"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the bank transfer"
},
"reference": {
"type": "string",
"maxLength": 255,
"description": "The reference for the bank transfer"
},
"amount": {
"type": "number",
"format": "double",
"description": "The amount of the bank transfer"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "The description for the bank transfer"
}
},
"description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Bank`: Full Access, Restricted Access",
"x-sage-menusection": "Bank, Payments & Receipts"
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers?updated_or_created_since={string}&deleted_since={string}&from_date={string}&to_date={string}&show_legacy_id={boolean}&items_per_page=20&page=1&attributes={string}&sort={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["updated_or_created_since"] = "{string}";
queryString["deleted_since"] = "{string}";
queryString["from_date"] = "{string}";
queryString["to_date"] = "{string}";
queryString["show_legacy_id"] = "{boolean}";
queryString["items_per_page"] = "20";
queryString["page"] = "1";
queryString["attributes"] = "{string}";
queryString["sort"] = "{string}";
var uri = "https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers");
builder.setParameter("updated_or_created_since", "{string}");
builder.setParameter("deleted_since", "{string}");
builder.setParameter("from_date", "{string}");
builder.setParameter("to_date", "{string}");
builder.setParameter("show_legacy_id", "{boolean}");
builder.setParameter("items_per_page", "20");
builder.setParameter("page", "1");
builder.setParameter("attributes", "{string}");
builder.setParameter("sort", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"updated_or_created_since": "{string}",
"deleted_since": "{string}",
"from_date": "{string}",
"to_date": "{string}",
"show_legacy_id": "{boolean}",
"items_per_page": "20",
"page": "1",
"attributes": "{string}",
"sort": "{string}",
};
$.ajax({
url: "https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers";
NSArray* array = @[
// Request parameters
@"entities=true",
@"updated_or_created_since={string}",
@"deleted_since={string}",
@"from_date={string}",
@"to_date={string}",
@"show_legacy_id={boolean}",
@"items_per_page=20",
@"page=1",
@"attributes={string}",
@"sort={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'show_legacy_id' => '{boolean}',
'items_per_page' => '20',
'page' => '1',
'attributes' => '{string}',
'sort' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'show_legacy_id': '{boolean}',
'items_per_page': '20',
'page': '1',
'attributes': '{string}',
'sort': '{string}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/de/sageone/accounts/v3/bank_transfers?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'show_legacy_id': '{boolean}',
'items_per_page': '20',
'page': '1',
'attributes': '{string}',
'sort': '{string}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/de/sageone/accounts/v3/bank_transfers?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.columbus.sage.com/de/sageone/accounts/v3/bank_transfers')
query = URI.encode_www_form({
# Request parameters
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'show_legacy_id' => '{boolean}',
'items_per_page' => '20',
'page' => '1',
'attributes' => '{string}',
'sort' => '{string}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body