Sage One - Accounts - v3 DE
Documentation of the Sage Business Cloud Accounting API.
Returns all Purchase Quick Entries
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 Purchases: Full Access, Read Only, Restricted Access
Request URL
Request parameters
(optional)
string
Use this to filter by contact id
(optional)
string
Use this to filter by the quick entry reference or contact name.
(optional)
string
Use this to filter by status id
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to filter by Purchase Batch Entries dates
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to filter by Purchase Batch Entries dates
(optional)
string
Format - date-time (as date-time in RFC3339). Use this to limit the response to Purchase Batch Entries 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 Purchase Batch Entries 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)
boolean
Use this to show the artefact's payments and allocations
(optional)
boolean
Use this to filter Purchase Batch Entries by whether they have attachments or not
(optional)
boolean
Display the legacy_id for the Purchase Batch Entries.
(optional)
integer
Format - int32. Returns the given number of Purchase Batch Entries per request.
(optional)
integer
Format - int32. Go to specific page of Purchase Batch Entries
(optional)
string
Specify the attributes that you want to expose for the Purchase Batch Entries (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 Purchase Quick Entries
[
{
"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",
"quick_entry_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"contact_name": "string",
"contact_reference": "string",
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"date": "string",
"reference": "string",
"ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"details": "string",
"net_amount": 0.0,
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"tax_amount": 0.0,
"tax_breakdown": [
{
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"percentage": 0.0,
"amount": 0.0
}
],
"total_amount": 0.0,
"outstanding_amount": 0.0,
"currency": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"exchange_rate": 0.0,
"inverse_exchange_rate": 0.0,
"base_currency_net_amount": 0.0,
"base_currency_tax_amount": 0.0,
"base_currency_tax_breakdown": [
{
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"percentage": 0.0,
"amount": 0.0
}
],
"base_currency_total_amount": 0.0,
"base_currency_outstanding_amount": 0.0,
"status": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"payments_allocations": [
{
"links": [
{
"href": "string",
"rel": "string",
"type": "string"
}
],
"date": "string",
"type": "string",
"reference": "string",
"amount": 0.0,
"discount": 0.0,
"stripe_transaction_id": "string",
"contact_allocation": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"links": [
{
"href": "string",
"rel": "string",
"type": "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",
"date": "string",
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"allocated_artefacts": [
{
"legacy_id": 0,
"id": "string",
"artefact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"links": [
{
"href": "string",
"rel": "string",
"type": "string"
}
]
},
"amount": 0.0
}
]
},
"artefact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"links": [
{
"href": "string",
"rel": "string",
"type": "string"
}
]
},
"contact_payment": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"links": [
{
"href": "string",
"rel": "string",
"type": "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",
"payment_method": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"date": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"currency": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"exchange_rate": 0.0,
"base_currency_net_amount": 0.0,
"base_currency_tax_amount": 0.0,
"base_currency_total_amount": 0.0,
"base_currency_currency_charge": 0.0,
"reference": "string",
"allocated_artefacts": [
{
"legacy_id": 0,
"id": "string",
"artefact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"links": [
{
"href": "string",
"rel": "string",
"type": "string"
}
]
},
"amount": 0.0,
"discount": 0.0
}
],
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"payment_on_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"contact_name": "string",
"contact_reference": "string",
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"date": "string",
"reference": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"outstanding_amount": 0.0,
"currency": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"exchange_rate": 0.0,
"base_currency_net_amount": 0.0,
"base_currency_tax_amount": 0.0,
"base_currency_total_amount": 0.0,
"base_currency_outstanding_amount": 0.0,
"status": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
}
},
"editable": true
},
"displayed_as": "string",
"negative_payment": true
}
],
"tax_address_region": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"migrated": true,
"trade_of_asset": true,
"gst_amount": 0.0,
"pst_amount": 0.0,
"tax_recoverable": true
}
]{
"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"
},
"quick_entry_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 type of quick entry e.g. invoice or credit note",
"x-sage-menusection": "Settings"
},
"contact_name": {
"type": "string",
"maxLength": 255,
"description": "The name of the contact when the quick entry was created"
},
"contact_reference": {
"type": "string",
"maxLength": 255,
"description": "The reference of the contact when the quick entry was created"
},
"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 contact the quick entry relates to",
"x-sage-menusection": "Settings"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the quick entry"
},
"reference": {
"type": "string",
"maxLength": 25,
"description": "The reference for the quick entry"
},
"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 associated ledger account",
"x-sage-menusection": "Settings"
},
"details": {
"type": "string",
"maxLength": 255,
"description": "A description of the quick entry"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the quick entry"
},
"tax_rate": {
"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 tax rate for the quick entry",
"x-sage-menusection": "Settings"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the quick entry"
},
"tax_breakdown": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_rate": {
"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 tax rate",
"x-sage-menusection": "Settings"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The tax rate percentage"
},
"amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the given tax rate"
}
}
},
"description": "The tax breakdown for the quick entry"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the quick entry"
},
"outstanding_amount": {
"type": "number",
"format": "double",
"description": "The outstanding amount of the quick entry"
},
"currency": {
"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 currency for the quick entry",
"x-sage-menusection": "Settings"
},
"exchange_rate": {
"type": "number",
"format": "double",
"description": "The exchange rate for the quick entry"
},
"inverse_exchange_rate": {
"type": "number",
"format": "double",
"description": "The inverse exchange rate for the quick entry"
},
"base_currency_net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the quick entry in base currency"
},
"base_currency_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the quick entry in base currency"
},
"base_currency_tax_breakdown": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_rate": {
"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 tax rate",
"x-sage-menusection": "Settings"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The tax rate percentage"
},
"amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the given tax rate"
}
}
},
"description": "The tax breakdown for the quick entry in base currency"
},
"base_currency_total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the quick entry in base currency"
},
"base_currency_outstanding_amount": {
"type": "number",
"format": "double",
"description": "The outstanding amount of the quick entry in base currency"
},
"status": {
"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 status of the quick entry",
"x-sage-menusection": "Settings"
},
"payments_allocations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
},
"date": {
"type": "string",
"format": "date",
"description": "The date for the payment/allocation"
},
"type": {
"type": "string",
"description": "The type of the payment/allocation"
},
"reference": {
"type": "string",
"description": "The reference for the payment/allocation"
},
"amount": {
"type": "number",
"format": "double",
"description": "The allocated amount of the payment/allocation"
},
"discount": {
"type": "number",
"format": "double",
"description": "The discount amount of the payment/allocation"
},
"stripe_transaction_id": {
"type": "string"
},
"contact_allocation": {
"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"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
},
"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 allocation",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"date": {
"type": "string",
"format": "date",
"description": "The date the allocation was made"
},
"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 contact that the allocation relates to",
"x-sage-menusection": "Settings"
},
"allocated_artefacts": {
"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"
},
"artefact": {
"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"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
}
},
"description": "The artefact the payment has been allocated against"
},
"amount": {
"type": "number",
"format": "double",
"description": "The allocated amount"
}
}
},
"description": "The payment lines of the payment"
}
},
"description": "The related contact allocation",
"x-sage-menusection": "Contacts, Addresses & Countries"
},
"artefact": {
"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"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
}
},
"description": "The artefact the allocation relates to"
},
"contact_payment": {
"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"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
},
"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 payment",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"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 payment method of the payment",
"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 contact of the payment",
"x-sage-menusection": "Settings"
},
"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 bank account of the payment",
"x-sage-menusection": "Settings"
},
"date": {
"type": "string",
"format": "date",
"description": "The date the payment was made"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment"
},
"currency": {
"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 currency of the payment",
"x-sage-menusection": "Settings"
},
"exchange_rate": {
"type": "number",
"format": "double",
"description": "The exchange rate of the payment"
},
"base_currency_net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment in base currency"
},
"base_currency_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment in base currency"
},
"base_currency_total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment in base currency"
},
"base_currency_currency_charge": {
"type": "number",
"format": "double",
"description": "The currency conversion charges in base currency"
},
"reference": {
"type": "string",
"maxLength": 25,
"description": "A reference for the payment\nNote: An upper length limit of 25 or 40 characters is imposed conditionally and may not apply in every request. A hard upper limit of 255 characters is imposed by the storage layer, though."
},
"allocated_artefacts": {
"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"
},
"artefact": {
"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"
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link path"
},
"rel": {
"type": "string",
"description": "The relationship of the link to the resource"
},
"type": {
"type": "string",
"description": "The content-type of the link"
}
}
},
"description": "Links for the resource"
}
},
"description": "The artefact the payment has been allocated against"
},
"amount": {
"type": "number",
"format": "double",
"description": "The allocated amount"
},
"discount": {
"type": "number",
"format": "double",
"description": "The allocated discount"
}
}
},
"description": "The allocated artefacts"
},
"tax_rate": {
"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 tax rate for the payment (only used with some cash based tax schemes)",
"x-sage-menusection": "Settings"
},
"payment_on_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"
},
"contact_name": {
"type": "string",
"description": "The name of the contact when the payment on account was created"
},
"contact_reference": {
"type": "string",
"description": "The reference of the contact when the payment on account was created"
},
"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 contact the payment on account relates to",
"x-sage-menusection": "Settings"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the payment on account"
},
"reference": {
"type": "string",
"description": "The reference for the payment on account"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment on account"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment on account"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment on account"
},
"outstanding_amount": {
"type": "number",
"format": "double",
"description": "The outstanding amount of the payment on account"
},
"currency": {
"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 currency for the payment on account",
"x-sage-menusection": "Settings"
},
"exchange_rate": {
"type": "number",
"format": "double",
"description": "The exchange rate for the payment on account"
},
"base_currency_net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment on account in base currency"
},
"base_currency_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment on account in base currency"
},
"base_currency_total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment on account in base currency"
},
"base_currency_outstanding_amount": {
"type": "number",
"format": "double",
"description": "The outstanding amount of the payment on account in base currency"
},
"status": {
"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 status of the payment on account",
"x-sage-menusection": "Settings"
}
},
"description": "The payment on account generated by this payment (if any)"
},
"editable": {
"type": "boolean",
"description": "Indicates whether payment can be edited"
}
},
"description": "The related contact payment",
"x-sage-menusection": "Contacts, Addresses & Countries"
},
"displayed_as": {
"type": "string",
"description": "Display text for the item"
},
"negative_payment": {
"type": "boolean",
"description": "This is a negative payment"
}
}
},
"description": "The associated payments and allocations"
},
"tax_address_region": {
"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 region for tax purposes (Canada only)",
"x-sage-menusection": "Settings"
},
"migrated": {
"type": "boolean",
"description": "Indicates if the quick entry was migrated from another system."
},
"trade_of_asset": {
"type": "boolean",
"description": "Whether the quick entry is marked as trade of asset."
},
"gst_amount": {
"type": "number",
"format": "double",
"description": "The gst or hst tax amount for the purchase quick entry"
},
"pst_amount": {
"type": "number",
"format": "double",
"description": "The pst or qst tax amount for the purchase quick entry"
},
"tax_recoverable": {
"type": "boolean",
"description": "Indicates if the purchase quick entry is tax recoverable or not"
}
},
"description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Purchases`: Full Access, Restricted Access",
"x-sage-menusection": "Invoices, Quotes & Credit Notes"
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/de/sageone/accounts/v3/purchase_quick_entries?contact_id={string}&search={string}&status_id={string}&from_date={string}&to_date={string}&updated_or_created_since={string}&deleted_since={string}&show_payments_allocations={boolean}&has_attachments={boolean}&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["contact_id"] = "{string}";
queryString["search"] = "{string}";
queryString["status_id"] = "{string}";
queryString["from_date"] = "{string}";
queryString["to_date"] = "{string}";
queryString["updated_or_created_since"] = "{string}";
queryString["deleted_since"] = "{string}";
queryString["show_payments_allocations"] = "{boolean}";
queryString["has_attachments"] = "{boolean}";
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/purchase_quick_entries?" + 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/purchase_quick_entries");
builder.setParameter("contact_id", "{string}");
builder.setParameter("search", "{string}");
builder.setParameter("status_id", "{string}");
builder.setParameter("from_date", "{string}");
builder.setParameter("to_date", "{string}");
builder.setParameter("updated_or_created_since", "{string}");
builder.setParameter("deleted_since", "{string}");
builder.setParameter("show_payments_allocations", "{boolean}");
builder.setParameter("has_attachments", "{boolean}");
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
"contact_id": "{string}",
"search": "{string}",
"status_id": "{string}",
"from_date": "{string}",
"to_date": "{string}",
"updated_or_created_since": "{string}",
"deleted_since": "{string}",
"show_payments_allocations": "{boolean}",
"has_attachments": "{boolean}",
"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/purchase_quick_entries?" + $.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/purchase_quick_entries";
NSArray* array = @[
// Request parameters
@"entities=true",
@"contact_id={string}",
@"search={string}",
@"status_id={string}",
@"from_date={string}",
@"to_date={string}",
@"updated_or_created_since={string}",
@"deleted_since={string}",
@"show_payments_allocations={boolean}",
@"has_attachments={boolean}",
@"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/purchase_quick_entries');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'contact_id' => '{string}',
'search' => '{string}',
'status_id' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'show_payments_allocations' => '{boolean}',
'has_attachments' => '{boolean}',
'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
'contact_id': '{string}',
'search': '{string}',
'status_id': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'show_payments_allocations': '{boolean}',
'has_attachments': '{boolean}',
'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/purchase_quick_entries?%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
'contact_id': '{string}',
'search': '{string}',
'status_id': '{string}',
'from_date': '{string}',
'to_date': '{string}',
'updated_or_created_since': '{string}',
'deleted_since': '{string}',
'show_payments_allocations': '{boolean}',
'has_attachments': '{boolean}',
'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/purchase_quick_entries?%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/purchase_quick_entries')
query = URI.encode_www_form({
# Request parameters
'contact_id' => '{string}',
'search' => '{string}',
'status_id' => '{string}',
'from_date' => '{string}',
'to_date' => '{string}',
'updated_or_created_since' => '{string}',
'deleted_since' => '{string}',
'show_payments_allocations' => '{boolean}',
'has_attachments' => '{boolean}',
'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